Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkMRMLColorNode Class Reference

Abstract MRML node to represent color information. More...

#include <Libs/MRML/Core/vtkMRMLColorNode.h>

Inheritance diagram for vtkMRMLColorNode:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLColorNode:
Collaboration graph
[legend]

Public Types

enum  { TypeModifiedEvent = 20002 }
 TypeModifiedEvent is generated when the type of the colour look up table changes. More...
 
enum  { User = 13, File = 14 }
 
typedef vtkMRMLStorableNode Superclass
 
- Public Types inherited from vtkMRMLStorableNode
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

void Copy (vtkMRMLNode *node) override
 
Copy the node's attributes to this object More...
 
vtkMRMLNodeCreateNodeInstance () override
 MRMLNode methods. More...
 
virtual const char * GetClassName ()
 
virtual bool GetColor (int ind, double color[4])
 
int GetColorIndexByName (const char *name)
 
const char * GetColorName (int ind)
 
std::string GetColorNameAsFileName (int colorIndex, const char *subst="_")
 
std::string GetColorNameWithoutSpaces (int ind, const char *subst)
 
virtual char * GetFileName ()
 
virtual int GetFirstType ()
 
virtual int GetLastType ()
 
virtual vtkLookupTable * GetLookupTable ()
 
bool GetModifiedSinceRead () override
 
virtual int GetNamesInitialised ()
 
Get/Set for the flag on names array having been initialised More...
 
const char * GetNodeTagName () override
 
Get node XML tag name (like Volume, Model) More...
 
virtual char * GetNoName ()
 
virtual int GetNumberOfColors ()
 
Get the number of colours in the table More...
 
virtual vtkScalarsToColors * GetScalarsToColors ()
 
virtual int GetType ()
 
Get for Type More...
 
virtual const char * GetTypeAsString ()
 return a text string describing the colour look up table type More...
 
virtual int IsA (const char *type)
 
virtual void NamesInitialisedOff ()
 
virtual void NamesInitialisedOn ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
 Propagate events generated in mrml. More...
 
void ReadXMLAttributes (const char **atts) override
 
Set node attributes More...
 
void Reset (vtkMRMLNode *defaultNode) override
 
int SetColorName (int ind, const char *name)
 
int SetColorNameWithSpaces (int ind, const char *name, const char *subst)
 
virtual void SetFileName (const char *)
 
Name of the file name from which to read color information More...
 
void SetNamesFromColors ()
 
Set values in the names vector from the colours in the node More...
 
virtual void SetNamesInitialised (int)
 
virtual void SetNoName (const char *)
 
virtual void SetType (int type)
 
Set Type to type, then build colours and set names More...
 
void SetTypeToFile ()
 
void SetTypeToUser ()
 
void UpdateScene (vtkMRMLScene *scene) override
 
void WriteXML (ostream &of, int indent) override
 
Write this node's information to a MRML file in XML format. More...
 
- Public Member Functions inherited from vtkMRMLStorableNode
void AddAndObserveStorageNodeID (const char *storageNodeID)
 
virtual bool AddDefaultStorageNode (const char *filename=nullptr)
 
void Copy (vtkMRMLNode *node) override
 
Copy the node's attributes to this object More...
 
virtual vtkMRMLStorageNodeCreateDefaultStorageNode ()
 
virtual std::string GetDefaultStorageNodeClassName (const char *filename=nullptr)
 
vtkMRMLStorageNodeGetNthStorageNode (int n)
 
Get associated display MRML node More...
 
const char * GetNthStorageNodeID (int n)
 
int GetNumberOfStorageNodes ()
 
const char * GetSlicerDataType ()
 
vtkMRMLStorageNodeGetStorageNode ()
 
const char * GetStorageNodeID ()
 
virtual vtkTagTableGetUserTagTable ()
 Methods for user-specified metadata. More...
 
bool HasStorageNodeID (const char *storageNodeID)
 
Return true if storageNodeID is in the storage node ID list. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *, unsigned long, void *) override
 
alternative method to propagate events generated in Storage nodes More...
 
void ReadXMLAttributes (const char **atts) override
 
Read node attributes from XML file More...
 
void SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)
 
void SetAndObserveStorageNodeID (const char *storageNodeID)
 
String ID of the storage MRML node More...
 
void SetSlicerDataType (const char *type)
 
virtual void StorableModified ()
 
void UpdateScene (vtkMRMLScene *scene) override
 
Finds the storage node and read the data More...
 
void WriteXML (ostream &of, int indent) override
 
Write this node's information to a MRML file in XML format. More...
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeAddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Convenience method that adds a referencedNodeID at the end of the list. More...
 
void AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr)
 Add a referenceRole. More...
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
 
void CopyWithoutModifiedEvent (vtkMRMLNode *node)
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSceneWithSingleModifiedEvent (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSingleModifiedEvent (vtkMRMLNode *node)
 
void DisableModifiedEventOff ()
 
void DisableModifiedEventOn ()
 
virtual int EndModify (int previousDisableModifiedEventState)
 End modifying the node. More...
 
virtual int GetAddToScene ()
 node added to MRML scene. More...
 
const char * GetAttribute (const char *name)
 Get value of a name value pair attribute. More...
 
std::vector< std::string > GetAttributeNames ()
 Get all attribute names. More...
 
void GetAttributeNames (vtkStringArray *attributeNames)
 Get all attribute names. Python-wrappable version. More...
 
virtual char * GetDescription ()
 
virtual int GetDisableModifiedEvent ()
 Turn on/off generating InvokeEvent for set macros. More...
 
virtual int GetHideFromEditors ()
 Describes if the node is hidden. More...
 
virtual char * GetID ()
 ID use by other nodes to reference this node in XML. More...
 
virtual int GetInMRMLCallbackFlag ()
 Flags to avoid event loops. More...
 
virtual int GetModifiedEventPending ()
 
virtual char * GetName ()
 
vtkMRMLNodeGetNodeReference (const char *referenceRole)
 
const char * GetNodeReferenceID (const char *referenceRole)
 Utility function that returns the first node id for a specific referenceRole. More...
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs)
 Return a list of the referenced node IDs. More...
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes)
 Return a list of the referenced nodes. More...
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole. More...
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role. More...
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceRoles ()
 
int GetNumberOfNodeReferences (const char *referenceRole)
 Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...
 
virtual int GetSaveWithScene ()
 Save node with MRML scene. More...
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
virtual bool GetUndoEnabled ()
 
bool HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Return true if referencedNodeID is in the node ID list for a specific referenceRole. More...
 
virtual void HideFromEditorsOff ()
 
virtual void HideFromEditorsOn ()
 
virtual void InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
 This method allows the node to compress events. More...
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending. More...
 
bool IsSingleton ()
 
void Modified () override
 Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...
 
virtual void OnNodeAddedToScene ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void ProcessChildNode (vtkMRMLNode *)
 Set dependencies between this node and a child node when parsing XML file. More...
 
void RemoveAttribute (const char *name)
 Remove attribute with the specified name. More...
 
void RemoveNodeReferenceIDs (const char *referenceRole)
 Remove all node IDs and associated nodes for a specific referenceRole. More...
 
void RemoveNthNodeReferenceID (const char *referenceRole, int n)
 Convenience method that removes the Nth node ID from the list. More...
 
virtual void SaveWithSceneOff ()
 
virtual void SaveWithSceneOn ()
 
virtual void SelectableOff ()
 
virtual void SelectableOn ()
 
virtual void SelectedOff ()
 
virtual void SelectedOn ()
 
virtual void SetAddToScene (int)
 
void SetAddToSceneNoModify (int value)
 
vtkMRMLNodeSetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe the Nth node ID for a specific reference role. More...
 
void SetAttribute (const char *name, const char *value)
 Set a name value pair attribute. More...
 
virtual void SetDescription (const char *)
 Text description of this node, to be set by the user. More...
 
void SetDisableModifiedEvent (int onOff)
 
virtual void SetHideFromEditors (int)
 
void SetInMRMLCallbackFlag (int flag)
 
virtual void SetName (const char *)
 Name of this node, to be set by the user. More...
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
 Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More...
 
virtual void SetSaveWithScene (int)
 
virtual void SetScene (vtkMRMLScene *scene)
 This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene. More...
 
virtual void SetSceneReferences ()
 Update the references of the node to the scene. More...
 
virtual void SetSelectable (int)
 
virtual void SetSelected (int)
 
void SetSingletonOff ()
 
void SetSingletonOn ()
 
virtual void SetSingletonTag (const char *)
 Tag that make this node a singleton in the scene. More...
 
virtual void SetUndoEnabled (bool)
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events. More...
 
virtual void UndoEnabledOff ()
 
virtual void UndoEnabledOn ()
 
virtual void UpdateReferenceID (const char *oldID, const char *newID)
 Update the stored reference to another node in the scene. More...
 
virtual void UpdateReferences ()
 The method should remove all pointers and observations to all nodes that are not in the scene anymore. More...
 
const char * URLDecodeString (const char *inString)
 Decode a URL string. More...
 
const char * URLEncodeString (const char *inString)
 Encode a URL string. More...
 
virtual void WriteNodeBodyXML (ostream &of, int indent)
 Write this node's body to a MRML file in XML format. More...
 
std::string XMLAttributeDecodeString (const std::string &inString)
 Decode an XML attribute string. More...
 
std::string XMLAttributeEncodeString (const std::string &inString)
 Encode an XML attribute string (replaces special characters by code sequences) More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLColorNodeNew ()
 
static vtkMRMLColorNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLStorableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLStorableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

virtual bool HasNameFromColor (int index)
 
void operator= (const vtkMRMLColorNode &)
 
virtual bool SetNameFromColor (int index)
 
Set values in the names vector from the colours in the node More...
 
 vtkMRMLColorNode ()
 
 vtkMRMLColorNode (const vtkMRMLColorNode &)
 
 ~vtkMRMLColorNode () override
 
- Protected Member Functions inherited from vtkMRMLStorableNode
virtual const char * GetStorageNodeReferenceMRMLAttributeName ()
 
virtual const char * GetStorageNodeReferenceRole ()
 
virtual vtkTimeStamp GetStoredTime ()
 
void operator= (const vtkMRMLStorableNode &)
 
 vtkMRMLStorableNode ()
 
 vtkMRMLStorableNode (const vtkMRMLStorableNode &)
 
 ~vtkMRMLStorableNode () override
 
- Protected Member Functions inherited from vtkMRMLNode
virtual const char * GetMRMLAttributeNameFromReferenceRole (const char *refRole)
 Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise. More...
 
virtual const char * GetReferenceRoleFromMRMLAttributeName (const char *attName)
 Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise. More...
 
virtual char * GetTempURLString ()
 
void GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents)
 
virtual void InvalidateNodeReferences ()
 
virtual bool IsReferenceRoleGeneric (const char *refRole)
 Return true if the reference role is generic (ends with '/') or false otherwise. More...
 
virtual void OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
 
virtual void OnNodeReferenceModified (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is modified. More...
 
virtual void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is removed (set to nullptr). More...
 
void operator= (const vtkMRMLNode &)
 
void ParseReferencesAttribute (const char *attValue, std::map< std::string, std::string > &references)
 
virtual void SetTempURLString (const char *)
 Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More...
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore)
 
virtual void UpdateNodeReferences (const char *referenceRole=nullptr)
 
virtual void UpdateNthNodeReference (const char *referenceRole, int n)
 
 vtkMRMLNode ()
 
 vtkMRMLNode (const vtkMRMLNode &)
 
 ~vtkMRMLNode () override
 critical to have a virtual destructor! More...
 

Protected Attributes

char * FileName
 
A file name to read text attributes from More...
 
std::vector< std::string > Names
 
A vector of names for the color table elements More...
 
int NamesInitialised
 
Have the colour names been set? Used to do lazy copy of the Names array. More...
 
char * NoName
 
the string used for an unnamed colour More...
 
int Type
 
- Protected Attributes inherited from vtkMRMLStorableNode
std::string SlicerDataType
 
vtkTimeStamp StorableModifiedTime
 
vtkTagTableUserTagTable
 
- Protected Attributes inherited from vtkMRMLNode
int AddToScene
 
AttributesType Attributes
 
char * Description
 
int HideFromEditors
 
char * ID
 
int InMRMLCallbackFlag
 
Flag to avoid event loops More...
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
 
vtkObserverManagerMRMLObserverManager
 
char * Name
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable
 
int Selected
 
bool UndoEnabled
 

Additional Inherited Members

- Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string > AttributesType
 
typedef std::map< std::string, vtkSmartPointer< vtkIntArray > > NodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
- Static Protected Attributes inherited from vtkMRMLStorableNode
static const char * StorageNodeReferenceMRMLAttributeName
 
static const char * StorageNodeReferenceRole
 

Detailed Description

Abstract MRML node to represent color information.

Color nodes describe colour look up tables. The tables may be pre-generated by Slicer (the label map colours, some default ramps, a random one) or created by a user. More than one model or label volume or editor can access the prebuilt nodes. This is used as a superclass for table based, procedural based, and implicit function based color nodes. All the color names are initialised to NoName ("(none)") when the table is created, using the max index of the colours expected to fill the table to set the size of the names array. If the node is being read in from a file, not all of the colours might be present from 0-max, so the colour name should remain (none) at those indices. But if the colour node is being built up from colours without names, there is a method to init the names from the colour RGBA values so that something would be there rather than the default NoName which is used to determine that it's a unnamed and probably uninitialised colour.

Subclasses must reimplement GetColor() and GetNumberOfColors().

Definition at line 47 of file vtkMRMLColorNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 51 of file vtkMRMLColorNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

TypeModifiedEvent is generated when the type of the colour look up table changes.

Enumerator
TypeModifiedEvent 

Definition at line 108 of file vtkMRMLColorNode.h.

◆ anonymous enum

anonymous enum

The list of valid color node types, added to in subclasses For backward compatibility, User and File keep the numbers that were in the ColorTable node

User - user defined in the GUI File - read in from file

Enumerator
User 
File 

Definition at line 197 of file vtkMRMLColorNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLColorNode() [1/2]

vtkMRMLColorNode::vtkMRMLColorNode ( )
protected

◆ ~vtkMRMLColorNode()

vtkMRMLColorNode::~vtkMRMLColorNode ( )
overrideprotected

◆ vtkMRMLColorNode() [2/2]

vtkMRMLColorNode::vtkMRMLColorNode ( const vtkMRMLColorNode )
protected

Member Function Documentation

◆ Copy()

void vtkMRMLColorNode::Copy ( vtkMRMLNode node)
overridevirtual

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLColorNode::CreateNodeInstance ( )
overridevirtual

◆ GetClassName()

virtual const char* vtkMRMLColorNode::GetClassName ( )
virtual

◆ GetColor()

virtual bool vtkMRMLColorNode::GetColor ( int  ind,
double  color[4] 
)
virtual

Retrieve the color associated to the index Must be reimplemented in the derived classes Return 1 if the color exists, 0 otherwise

Reimplemented in vtkMRMLColorTableNode, vtkMRMLFreeSurferProceduralColorNode, and vtkMRMLProceduralColorNode.

◆ GetColorIndexByName()

int vtkMRMLColorNode::GetColorIndexByName ( const char *  name)

Return the index associated with this color name, which can then be used to get the colour. Returns -1 on failure.

See also
GetColorName()

◆ GetColorName()

const char* vtkMRMLColorNode::GetColorName ( int  ind)

Get name of a color from its index (index is 0-based)

See also
GetColorIndexByName()

◆ GetColorNameAsFileName()

std::string vtkMRMLColorNode::GetColorNameAsFileName ( int  colorIndex,
const char *  subst = "_" 
)

Get the 0'th based colorIndex'th name of this color, replacing all file name sensitive color name characters with safer character(s). Only alphanumeric characters (A-Z,a-z,0-9) and '-','_','.','(',')','$', '!','~','#',','','^','{','}' are supported; '/', '&', '?', '<' ... are replaced with '_' (or any other substitution string) While ' '(space) and accents are technically valid file name characters, they are replaced as an extra precaution. The color name is truncated to not be longer than 255 characters. subst can be made of invalid characters and be longer than 1 char

See also
GetColorNameWithoutSpaces

◆ GetColorNameWithoutSpaces()

std::string vtkMRMLColorNode::GetColorNameWithoutSpaces ( int  ind,
const char *  subst 
)
Deprecated:
GetColorNameWithoutSpaces Get the 0th based nth name of this colour, replacing the spaces with subst
See also
GetColorNameAsFileName

◆ GetFileName()

virtual char* vtkMRMLColorNode::GetFileName ( )
virtual

◆ GetFirstType()

virtual int vtkMRMLColorNode::GetFirstType ( )
inlinevirtual

Return the lowest and highest integers, for use in looping. Override in subclasses when more enums are added.

Reimplemented in vtkMRMLColorTableNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

Definition at line 101 of file vtkMRMLColorNode.h.

◆ GetLastType()

virtual int vtkMRMLColorNode::GetLastType ( )
inlinevirtual

◆ GetLookupTable()

virtual vtkLookupTable* vtkMRMLColorNode::GetLookupTable ( )
virtual

Most color nodes will implement a look up table, so provide a top level get method

Reimplemented in vtkMRMLProceduralColorNode, vtkMRMLFreeSurferProceduralColorNode, and vtkMRMLColorTableNode.

◆ GetModifiedSinceRead()

bool vtkMRMLColorNode::GetModifiedSinceRead ( )
overridevirtual

◆ GetNamesInitialised()

virtual int vtkMRMLColorNode::GetNamesInitialised ( )
virtual


Get/Set for the flag on names array having been initialised

◆ GetNodeTagName()

const char* vtkMRMLColorNode::GetNodeTagName ( )
inlineoverridevirtual

◆ GetNoName()

virtual char* vtkMRMLColorNode::GetNoName ( )
virtual

get/set the string used for an unnamed colour "(none)" by default.

See also
SetColorName

◆ GetNumberOfColors()

virtual int vtkMRMLColorNode::GetNumberOfColors ( )
virtual


Get the number of colours in the table

Reimplemented in vtkMRMLColorTableNode, vtkMRMLFreeSurferProceduralColorNode, and vtkMRMLProceduralColorNode.

◆ GetScalarsToColors()

virtual vtkScalarsToColors* vtkMRMLColorNode::GetScalarsToColors ( )
virtual

Utility function that either returns a vtkLookupTable or a vtkColorTransferFunction whichever makes more sense. Returns vtkMRMLColorNode::GetLookupTable() by default. You should the method if you want it to return something else in subclasses

Reimplemented in vtkMRMLProceduralColorNode, and vtkMRMLFreeSurferProceduralColorNode.

◆ GetType()

virtual int vtkMRMLColorNode::GetType ( )
virtual


Get for Type

◆ GetTypeAsString()

virtual const char* vtkMRMLColorNode::GetTypeAsString ( )
virtual

◆ HasNameFromColor()

virtual bool vtkMRMLColorNode::HasNameFromColor ( int  index)
protectedvirtual

Return true if the color index has a "real" name, otherwise return false if the name is NoName (i.e. "(none)") or automatically generated (i.e. "R=...G=...B=...").

See also
GetNoName()

◆ IsA()

virtual int vtkMRMLColorNode::IsA ( const char *  type)
virtual

◆ IsTypeOf()

static int vtkMRMLColorNode::IsTypeOf ( const char *  type)
static

◆ NamesInitialisedOff()

virtual void vtkMRMLColorNode::NamesInitialisedOff ( )
virtual

◆ NamesInitialisedOn()

virtual void vtkMRMLColorNode::NamesInitialisedOn ( )
virtual

◆ New()

static vtkMRMLColorNode* vtkMRMLColorNode::New ( )
static

◆ operator=()

void vtkMRMLColorNode::operator= ( const vtkMRMLColorNode )
protected

◆ PrintSelf()

void vtkMRMLColorNode::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ ProcessMRMLEvents()

void vtkMRMLColorNode::ProcessMRMLEvents ( vtkObject *  caller,
unsigned long  event,
void *  callData 
)
overridevirtual

◆ ReadXMLAttributes()

void vtkMRMLColorNode::ReadXMLAttributes ( const char **  atts)
overridevirtual

◆ Reset()

void vtkMRMLColorNode::Reset ( vtkMRMLNode defaultNode)
overridevirtual

Reset node attributes to the initilal state as defined in the constructor. NOTE: it preserves values several dynamic attributes that may be set by an application: type, name

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLColorTableNode.

◆ SafeDownCast()

static vtkMRMLColorNode* vtkMRMLColorNode::SafeDownCast ( vtkObject *  o)
static

◆ SetColorName()

int vtkMRMLColorNode::SetColorName ( int  ind,
const char *  name 
)

Set the 0th based nth name of this colour. Returns 1 on success, 0 on failure.

◆ SetColorNameWithSpaces()

int vtkMRMLColorNode::SetColorNameWithSpaces ( int  ind,
const char *  name,
const char *  subst 
)

Set the 0th based nth name of this colour, replacing the subst character with spaces. Returns 1 on success, 0 on failure

◆ SetFileName()

virtual void vtkMRMLColorNode::SetFileName ( const char *  )
virtual


Name of the file name from which to read color information

◆ SetNameFromColor()

virtual bool vtkMRMLColorNode::SetNameFromColor ( int  index)
protectedvirtual


Set values in the names vector from the colours in the node

Reimplemented in vtkMRMLFreeSurferProceduralColorNode, and vtkMRMLProceduralColorNode.

◆ SetNamesFromColors()

void vtkMRMLColorNode::SetNamesFromColors ( )


Set values in the names vector from the colours in the node

◆ SetNamesInitialised()

virtual void vtkMRMLColorNode::SetNamesInitialised ( int  )
virtual

◆ SetNoName()

virtual void vtkMRMLColorNode::SetNoName ( const char *  )
virtual

◆ SetType()

virtual void vtkMRMLColorNode::SetType ( int  type)
virtual


Set Type to type, then build colours and set names

Reimplemented in vtkMRMLColorTableNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

◆ SetTypeToFile()

void vtkMRMLColorNode::SetTypeToFile ( )

◆ SetTypeToUser()

void vtkMRMLColorNode::SetTypeToUser ( )

Set the type to User or File, ones that don't require building data structures, just setting flags

◆ UpdateScene()

void vtkMRMLColorNode::UpdateScene ( vtkMRMLScene )
overridevirtual

Updates other nodes in the scene depending on this node or updates this node if it depends on other nodes when the scene is read in This method is called automatically by XML parser after all nodes are created

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLFreeSurferProceduralColorNode, vtkMRMLProceduralColorNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

◆ WriteXML()

void vtkMRMLColorNode::WriteXML ( ostream &  of,
int  indent 
)
overridevirtual

Member Data Documentation

◆ FileName

char* vtkMRMLColorNode::FileName
protected


A file name to read text attributes from

Definition at line 229 of file vtkMRMLColorNode.h.

◆ Names

std::vector<std::string> vtkMRMLColorNode::Names
protected


A vector of names for the color table elements

Definition at line 225 of file vtkMRMLColorNode.h.

◆ NamesInitialised

int vtkMRMLColorNode::NamesInitialised
protected


Have the colour names been set? Used to do lazy copy of the Names array.

Definition at line 237 of file vtkMRMLColorNode.h.

◆ NoName

char* vtkMRMLColorNode::NoName
protected


the string used for an unnamed colour

Definition at line 233 of file vtkMRMLColorNode.h.

◆ Type

int vtkMRMLColorNode::Type
protected

Which type of color information does this node hold? Valid values are in the enumerated list

Definition at line 221 of file vtkMRMLColorNode.h.


The documentation for this class was generated from the following file: