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

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

Inheritance diagram for vtkMRMLColorNode:

[legend]

Collaboration diagram for vtkMRMLColorNode:

[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
virtual void	Copy (vtkMRMLNode *node) VTK_OVERRIDE
	Copy the node's attributes to this object. More...

virtual vtkMRMLNode *	CreateNodeInstance () VTK_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 ()

virtual bool	GetModifiedSinceRead () VTK_OVERRIDE

virtual int	GetNamesInitialised ()
	Get/Set for the flag on names array having been initalised. More...

virtual const char *	GetNodeTagName () VTK_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) VTK_OVERRIDE

void	ProcessMRMLEvents (vtkObject caller, unsigned long event, void callData) VTK_OVERRIDE
	alternative method to propagate events generated in Storage nodes More...

virtual void	ReadXMLAttributes (const char **atts) VTK_OVERRIDE
	Set node attributes. More...

virtual void	Reset (vtkMRMLNode *defaultNode) VTK_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 ()

virtual void	UpdateScene (vtkMRMLScene *scene) VTK_OVERRIDE
	Finds the storage node and read the data. More...

virtual void	WriteXML (ostream &of, int indent) VTK_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=NULL)

virtual vtkMRMLStorageNode *	CreateDefaultStorageNode ()

virtual std::string	GetDefaultStorageNodeClassName (const char *filename=NULL)

vtkMRMLStorageNode *	GetNthStorageNode (int n)
	Get associated display MRML node. More...

const char *	GetNthStorageNodeID (int n)

int	GetNumberOfStorageNodes ()

const char *	GetSlicerDataType ()

vtkMRMLStorageNode *	GetStorageNode ()

const char *	GetStorageNodeID ()

virtual vtkTagTable *	GetUserTagTable ()
	Methods for user-specified metadata. More...

void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

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 ()

Public Member Functions inherited from vtkMRMLNode
vtkMRMLNode *	AddAndObserveNodeReferenceID (const char referenceRole, const char referencedNodeID, vtkIntArray *events=0)
	Add and observe a reference node from this node for a specific referenceRole. More...

vtkMRMLNode *	AddNodeReferenceID (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=0, vtkIntArray *events=0)
	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 ()

vtkMRMLNode *	GetNodeReference (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...

vtkMRMLNode *	GetNthNodeReference (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 vtkMRMLScene *	GetScene ()
	Only the scene can set itself to the node. More...

virtual int	GetSelectable ()
	Describes if the node is selectable. More...

virtual int	GetSelected ()
	Get/Set for Selected. More...

virtual char *	GetSingletonTag ()

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=NULL)
	This method allows the node to compress events. More...

virtual int	InvokePendingModifiedEvent ()
	Invokes any modified events that are `pending`. More...

bool	IsSingleton ()

virtual void	Modified () VTK_OVERRIDE
	Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...

virtual void	OnNodeAddedToScene ()

void	PrintSelf (ostream &os, vtkIndent indent) VTK_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)

vtkMRMLNode *	SetAndObserveNodeReferenceID (const char referenceRole, const char referencedNodeID, vtkIntArray *events=0)
	Set and observe a reference node from this node for a specific referenceRole. More...

vtkMRMLNode *	SetAndObserveNthNodeReferenceID (const char referenceRole, int n, const char referencedNodeID, vtkIntArray *events=0)
	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...

vtkMRMLNode *	SetNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...

vtkMRMLNode *	SetNthNodeReferenceID (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)

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 int	StartModify ()
	Start modifying the node. Disable Modify events. More...

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...

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkMRMLColorNode *	New ()

static vtkMRMLColorNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLStorableNode
static int	IsTypeOf (const char *type)

static vtkMRMLStorableNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLNode
static int	IsTypeOf (const char *type)

static vtkMRMLNode *	SafeDownCast (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 &)

virtual	~vtkMRMLColorNode ()

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 ()

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 NULL). 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...

vtkMRMLNode *	UpdateNodeReferenceEventObserver (vtkMRMLNode oldReferencedNode, vtkMRMLNode newReferencedNode, vtkIntArray newEvents, vtkMRMLNodeReference referenceToIgnore)

virtual void	UpdateNodeReferences (const char *referenceRole=NULL)

virtual void	UpdateNthNodeReference (const char *referenceRole, int n)

	vtkMRMLNode ()

	vtkMRMLNode (const vtkMRMLNode &)

virtual	~vtkMRMLNode ()
	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

vtkTagTable *	UserTagTable

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...

vtkObserverManager *	MRMLObserverManager

char *	Name

NodeReferenceEventsType	NodeReferenceEvents

std::map< std::string, std::string >	NodeReferenceMRMLAttributeNames

NodeReferencesType	NodeReferences

int	SaveWithScene

vtkWeakPointer< vtkMRMLScene >	Scene

int	Selectable

int	Selected

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, NodeReferenceListType >	NodeReferencesType

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

typedef vtkMRMLStorableNode vtkMRMLColorNode::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()

virtual vtkMRMLColorNode::~vtkMRMLColorNode ( )

protectedvirtual

◆ vtkMRMLColorNode() [2/2]

vtkMRMLColorNode::vtkMRMLColorNode ( const vtkMRMLColorNode & )

protected

Member Function Documentation

◆ Copy()

virtual void vtkMRMLColorNode::Copy ( vtkMRMLNode * node )

virtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLProceduralColorNode, vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

◆ CreateNodeInstance()

virtual vtkMRMLNode* vtkMRMLColorNode::CreateNodeInstance ( )

virtual

MRMLNode methods.

Implements vtkMRMLStorableNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLProceduralColorNode, vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

◆ GetClassName()

virtual const char* vtkMRMLColorNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLProceduralColorNode, vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

◆ 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

Reimplemented in vtkMRMLColorTableNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

Definition at line 102 of file vtkMRMLColorNode.h.

◆ 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()

virtual bool vtkMRMLColorNode::GetModifiedSinceRead ( )

virtual

See also: vtkMRMLStorableNode::GetModifiedSinceRead()

Reimplemented from vtkMRMLStorableNode.

◆ GetNamesInitialised()

virtual int vtkMRMLColorNode::GetNamesInitialised ( )

virtual

Get/Set for the flag on names array having been initalised.

◆ GetNodeTagName()

virtual const char* vtkMRMLColorNode::GetNodeTagName ( )

inlinevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLStorableNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLProceduralColorNode, vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

Definition at line 74 of file vtkMRMLColorNode.h.

◆ 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

return a text string describing the colour look up table type

Reimplemented in vtkMRMLColorTableNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLdGEMRICProceduralColorNode, vtkMRMLPETProceduralColorNode, and vtkMRMLProceduralColorNode.

◆ 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

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLProceduralColorNode, vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

◆ 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
	)

◆ ProcessMRMLEvents()

void vtkMRMLColorNode::ProcessMRMLEvents	(	vtkObject *	,
		unsigned long	long,
		void *
	)

virtual

alternative method to propagate events generated in Storage nodes

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLColorTableNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLProceduralColorNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

◆ ReadXMLAttributes()

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

virtual

Set node attributes.

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLProceduralColorNode, vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

◆ Reset()

virtual void vtkMRMLColorNode::Reset ( vtkMRMLNode * defaultNode )

virtual

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()

virtual void vtkMRMLColorNode::UpdateScene ( vtkMRMLScene * scene )

virtual

Finds the storage node and read the data.

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLFreeSurferProceduralColorNode, vtkMRMLProceduralColorNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

◆ WriteXML()

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

virtual

Write this node's information to a MRML file in XML format.

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLDiffusionTensorDisplayPropertiesNode, vtkMRMLFreeSurferProceduralColorNode, vtkMRMLProceduralColorNode, vtkMRMLColorTableNode, vtkMRMLdGEMRICProceduralColorNode, and vtkMRMLPETProceduralColorNode.

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:

Libs/MRML/Core/vtkMRMLColorNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkMRMLColorNode() [1/2]

◆ ~vtkMRMLColorNode()

◆ vtkMRMLColorNode() [2/2]

Member Function Documentation

◆ Copy()

◆ CreateNodeInstance()

◆ GetClassName()

◆ GetColor()

◆ GetColorIndexByName()

◆ GetColorName()

◆ GetColorNameAsFileName()

◆ GetColorNameWithoutSpaces()

◆ GetFileName()

◆ GetFirstType()

◆ GetLastType()

◆ GetLookupTable()

◆ GetModifiedSinceRead()

◆ GetNamesInitialised()

◆ GetNodeTagName()

◆ GetNoName()

◆ GetNumberOfColors()

◆ GetScalarsToColors()

◆ GetType()

◆ GetTypeAsString()

◆ HasNameFromColor()

◆ IsA()

◆ IsTypeOf()

◆ NamesInitialisedOff()

◆ NamesInitialisedOn()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ ProcessMRMLEvents()

◆ ReadXMLAttributes()

◆ Reset()

◆ SafeDownCast()

◆ SetColorName()

◆ SetColorNameWithSpaces()

◆ SetFileName()

◆ SetNameFromColor()

◆ SetNamesFromColors()

◆ SetNamesInitialised()

◆ SetNoName()

◆ SetType()

◆ SetTypeToFile()

◆ SetTypeToUser()

◆ UpdateScene()

◆ WriteXML()

Member Data Documentation

◆ FileName

◆ Names

◆ NamesInitialised

◆ NoName

◆ Type