Slicer 5.9
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
Loading...
Searching...
No Matches
vtkMRMLColorLogic Class Reference

MRML logic class for color manipulation. More...

#include <Libs/MRML/Logic/vtkMRMLColorLogic.h>

Inheritance diagram for vtkMRMLColorLogic:
Collaboration diagram for vtkMRMLColorLogic:

Public Types

typedef vtkMRMLAbstractLogic Superclass
 
- Public Types inherited from vtkMRMLAbstractLogic
typedef vtkObject Superclass
 
typedef void(vtkMRMLAbstractLogic::* TaskFunctionPointer) (void *clientdata)
 

Public Member Functions

void AddColorFile (const char *fileName, std::vector< std::string > *Files)
 Add a file to the input list Files, checking first for null, duplicates.
 
virtual void AddDefaultColorNodes ()
 Add default color nodes.
 
virtual const char * GetClassName ()
 
virtual const char * GetDefaultChartColorNodeID ()
 Return a default color node id for a chart.
 
virtual const char * GetDefaultEditorColorNodeID ()
 Return a default color node id for the editor.
 
virtual const char * GetDefaultLabelMapColorNodeID ()
 Return a default color node id for a label map.
 
virtual const char * GetDefaultModelColorNodeID ()
 Return a default color node id for a model.
 
virtual const char * GetDefaultPlotColorNodeID ()
 Return a default color node id for a plot.
 
virtual const char * GetDefaultVolumeColorNodeID ()
 Return a default color node id for a volume.
 
virtual char * GetUserColorFilePaths ()
 Get/Set the user defined paths where to look for extra color files.
 
virtual int IsA (const char *type)
 
vtkMRMLColorNodeLoadColorFile (const char *fileName, const char *nodeName=nullptr, vtkMRMLMessageCollection *userMessages=nullptr, bool userType=false)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void RemoveDefaultColorNodes ()
 Remove default color nodes.
 
virtual void SetUserColorFilePaths (const char *)
 
- Public Member Functions inherited from vtkMRMLAbstractLogic
virtual vtkMRMLApplicationLogicGetMRMLApplicationLogic () const
 Get access to overall application state.
 
vtkMRMLSceneGetMRMLScene () const
 Return a reference to the current MRML scene.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void SetMRMLApplicationLogic (vtkMRMLApplicationLogic *logic)
 
void SetMRMLScene (vtkMRMLScene *newScene)
 Set and observe the MRMLScene.
 

Static Public Member Functions

static vtkMRMLColorTableNodeCopyNode (vtkMRMLColorNode *colorNode, const char *copyName)
 
static vtkMRMLProceduralColorNodeCopyProceduralNode (vtkMRMLColorNode *colorNode, const char *copyName)
 
static const char * GetColorTableNodeID (int type)
 Return the default color table node id for a given type.
 
static const char * GetdGEMRICColorNodeID (int type)
 Return the default dGEMRIC color node id for a given type.
 
static const char * GetFileColorNodeID (const char *fileName)
 Return a default color node id for a file based node, based on the file name.
 
static std::string GetFileColorNodeSingletonTag (const char *fileName)
 
static const char * GetPETColorNodeID (int type)
 Return the default PET color node id for a given type.
 
static const char * GetProceduralColorNodeID (const char *name)
 Return a default color node id for a procedural color node.
 
static int IsTypeOf (const char *type)
 
static vtkMRMLColorLogicNew ()
 The Usual vtk class functions.
 
static vtkMRMLColorLogicSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLAbstractLogic
static int IsTypeOf (const char *type)
 
static vtkMRMLAbstractLogicNew ()
 
static vtkMRMLAbstractLogicSafeDownCast (vtkObject *o)
 

Protected Member Functions

void AddDefaultFileNode (int i)
 
void AddDefaultFileNodes ()
 
void AddDefaultProceduralNodes ()
 
void AddDefaultTableNode (int i)
 
void AddDefaultTableNodes ()
 
void AddDGEMRICNode (int type)
 
void AddDGEMRICNodes ()
 
void AddLabelsNode ()
 
void AddPETNode (int type)
 
void AddPETNodes ()
 
void AddUserFileNode (int i)
 
void AddUserFileNodes ()
 
vtkMRMLColorTableNodeCreateDefaultFileNode (const std::string &colorname)
 
vtkMRMLColorTableNodeCreateDefaultTableNode (int type)
 
vtkMRMLdGEMRICProceduralColorNodeCreatedGEMRICColorNode (int type)
 
vtkMRMLColorTableNodeCreateFileNode (const char *fileName, vtkMRMLMessageCollection *userMessages=nullptr, bool userType=false)
 
vtkMRMLColorTableNodeCreateLabelsNode ()
 
vtkMRMLPETProceduralColorNodeCreatePETColorNode (int type)
 
vtkMRMLProceduralColorNodeCreateProceduralFileNode (const char *fileName, vtkMRMLMessageCollection *userMessages=nullptr, bool userType=false)
 
vtkMRMLProceduralColorNodeCreateRandomNode ()
 
vtkMRMLProceduralColorNodeCreateRedGreenBlueNode ()
 
vtkMRMLColorTableNodeCreateUserFileNode (const std::string &colorname)
 
virtual std::vector< std::string > FindDefaultColorFiles ()
 
virtual std::vector< std::string > FindUserColorFiles ()
 
virtual void OnMRMLSceneNewEvent ()
 
void operator= (const vtkMRMLColorLogic &)
 
std::string RemoveLeadAndTrailSpaces (std::string)
 
void SetMRMLSceneInternal (vtkMRMLScene *newScene) override
 Reimplemented to listen to specific scene events.
 
 vtkMRMLColorLogic ()
 
 vtkMRMLColorLogic (const vtkMRMLColorLogic &)
 
 ~vtkMRMLColorLogic () override
 
- Protected Member Functions inherited from vtkMRMLAbstractLogic
int EndModify (bool wasModifying)
 
virtual bool EnterMRMLLogicsCallback () const
 
virtual bool EnterMRMLNodesCallback () const
 
virtual bool EnterMRMLSceneCallback () const
 
bool GetDisableModifiedEvent () const
 
int GetInMRMLLogicsCallbackFlag () const
 
int GetInMRMLNodesCallbackFlag () const
 
int GetInMRMLSceneCallbackFlag () const
 
vtkCallbackCommand * GetMRMLLogicsCallbackCommand ()
 
vtkObserverManagerGetMRMLLogicsObserverManager () const
 
vtkCallbackCommand * GetMRMLNodesCallbackCommand ()
 
vtkObserverManagerGetMRMLNodesObserverManager () const
 
vtkCallbackCommand * GetMRMLSceneCallbackCommand ()
 
vtkObserverManagerGetMRMLSceneObserverManager () const
 
int GetPendingModifiedEventCount () const
 
int GetProcessingMRMLSceneEvent () const
 Return the event id currently processed or 0 if any.
 
int InvokePendingModifiedEvent ()
 
void Modified () override
 
virtual void ObserveMRMLScene ()
 
virtual void OnMRMLNodeModified (vtkMRMLNode *)
 
virtual void OnMRMLSceneEndBatchProcess ()
 
virtual void OnMRMLSceneEndClose ()
 
virtual void OnMRMLSceneEndImport ()
 
virtual void OnMRMLSceneEndRestore ()
 
virtual void OnMRMLSceneNew ()
 
virtual void OnMRMLSceneNodeAdded (vtkMRMLNode *)
 
virtual void OnMRMLSceneNodeRemoved (vtkMRMLNode *)
 
virtual void OnMRMLSceneStartBatchProcess ()
 
virtual void OnMRMLSceneStartClose ()
 
virtual void OnMRMLSceneStartImport ()
 
virtual void OnMRMLSceneStartRestore ()
 
virtual void ProcessMRMLLogicsEvents (vtkObject *caller, unsigned long event, void *callData)
 
virtual void ProcessMRMLNodesEvents (vtkObject *caller, unsigned long event, void *callData)
 
virtual void ProcessMRMLSceneEvents (vtkObject *caller, unsigned long event, void *callData)
 
virtual void RegisterNodes ()
 
void SetAndObserveMRMLSceneEventsInternal (vtkMRMLScene *newScene, vtkIntArray *events, vtkFloatArray *priorities=nullptr)
 
void SetDisableModifiedEvent (bool onOff)
 
void SetInMRMLLogicsCallbackFlag (int flag)
 
void SetInMRMLNodesCallbackFlag (int flag)
 
void SetInMRMLSceneCallbackFlag (int flag)
 
void SetProcessingMRMLSceneEvent (int event)
 
bool StartModify ()
 
virtual void UnobserveMRMLScene ()
 
virtual void UpdateFromMRMLScene ()
 
 vtkMRMLAbstractLogic ()
 
 ~vtkMRMLAbstractLogic () override
 

Static Protected Member Functions

static const char * GetColorNodeID (vtkMRMLColorNode *colorNode)
 
- Static Protected Member Functions inherited from vtkMRMLAbstractLogic
static void MRMLLogicsCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 MRMLLogicCallback is a static function to relay modified events from the logics.
 
static void MRMLNodesCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 MRMLNodesCallback is a static function to relay modified events from the nodes.
 
static void MRMLSceneCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 

Protected Attributes

std::vector< std::string > ColorFiles
 
char * UserColorFilePaths
 
std::vector< std::string > UserColorFiles
 

Static Protected Attributes

static std::string TempColorNodeID
 

Detailed Description

MRML logic class for color manipulation.

This class manages the logic associated with reading, saving, and changing propertied of the colors.

Definition at line 34 of file vtkMRMLColorLogic.h.

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMRMLColorLogic() [1/2]

vtkMRMLColorLogic::vtkMRMLColorLogic ( )
protected

◆ ~vtkMRMLColorLogic()

vtkMRMLColorLogic::~vtkMRMLColorLogic ( )
overrideprotected

◆ vtkMRMLColorLogic() [2/2]

vtkMRMLColorLogic::vtkMRMLColorLogic ( const vtkMRMLColorLogic & )
protected

Member Function Documentation

◆ AddColorFile()

void vtkMRMLColorLogic::AddColorFile ( const char * fileName,
std::vector< std::string > * Files )

Add a file to the input list Files, checking first for null, duplicates.

◆ AddDefaultColorNodes()

virtual void vtkMRMLColorLogic::AddDefaultColorNodes ( )
virtual

Add default color nodes.

The default color nodes are singleton and are not included in the the saved scene.

This function enables the vtkMRMLScene::BatchProcessState.

The type of default nodes along with their properties are listed in the table below:

| Family | Category | Type | Node name | Singleton Tag | Node ID | | ----------------------— | ---------------------— | ---------------------------— | ---------------------------— | ----------------------------------— | --------------------------------------------------------— | | ColorTable | Discrete | Labels | Labels | Labels | vtkMRMLColorTableNodeLabels | | ColorTable | Discrete | FullRainbow | FullRainbow | FullRainbow | vtkMRMLColorTableNodeFullRainbow | | ColorTable | Discrete | Grey | Grey | Grey | vtkMRMLColorTableNodeGrey | | ColorTable | Discrete | Iron | Iron | Iron | vtkMRMLColorTableNodeIron | | ColorTable | Discrete | Rainbow | Rainbow | Rainbow | vtkMRMLColorTableNodeRainbow | | ColorTable | Discrete | Ocean | Ocean | Ocean | vtkMRMLColorTableNodeOcean | | ColorTable | Discrete | Desert | Desert | Desert | vtkMRMLColorTableNodeDesert | | ColorTable | Discrete | InvertedGrey | InvertedGrey | InvertedGrey | vtkMRMLColorTableNodeInvertedGrey | | ColorTable | Discrete | ReverseRainbow | ReverseRainbow | ReverseRainbow | vtkMRMLColorTableNodeReverseRainbow | | ColorTable | Discrete | fMRI | fMRI | fMRI | vtkMRMLColorTableNodefMRI | | ColorTable | Discrete | fMRIPA | fMRIPA | fMRIPA | vtkMRMLColorTableNodefMRIPA | | ColorTable | Discrete | Random | Random | Random | vtkMRMLColorTableNodeRandom | | ColorTable | Discrete | Red | Red | Red | vtkMRMLColorTableNodeRed | | ColorTable | Discrete | Green | Green | Green | vtkMRMLColorTableNodeGreen | | ColorTable | Discrete | Blue | Blue | Blue | vtkMRMLColorTableNodeBlue | | ColorTable | Discrete | Yellow | Yellow | Yellow | vtkMRMLColorTableNodeYellow | | ColorTable | Discrete | Cyan | Cyan | Cyan | vtkMRMLColorTableNodeCyan | | ColorTable | Discrete | Magenta | Magenta | Magenta | vtkMRMLColorTableNodeMagenta | | ColorTable | Discrete | Warm1 | Warm1 | Warm1 | vtkMRMLColorTableNodeWarm1 | | ColorTable | Discrete | Warm2 | Warm2 | Warm2 | vtkMRMLColorTableNodeWarm2 | | ColorTable | Discrete | Warm3 | Warm3 | Warm3 | vtkMRMLColorTableNodeWarm3 | | ColorTable | Discrete | Cool1 | Cool1 | Cool1 | vtkMRMLColorTableNodeCool1 | | ColorTable | Discrete | Cool2 | Cool2 | Cool2 | vtkMRMLColorTableNodeCool2 | | ColorTable | Discrete | Cool3 | Cool3 | Cool3 | vtkMRMLColorTableNodeCool3 | | ColorTable | Shade | WarmShade1 | WarmShade1 | WarmShade1 | vtkMRMLColorTableNodeWarmShade1 | | ColorTable | Shade | WarmShade2 | WarmShade2 | WarmShade2 | vtkMRMLColorTableNodeWarmShade2 | | ColorTable | Shade | WarmShade3 | WarmShade3 | WarmShade3 | vtkMRMLColorTableNodeWarmShade3 | | ColorTable | Shade | CoolShade1 | CoolShade1 | CoolShade1 | vtkMRMLColorTableNodeCoolShade1 | | ColorTable | Shade | CoolShade2 | CoolShade2 | CoolShade2 | vtkMRMLColorTableNodeCoolShade2 | | ColorTable | Shade | CoolShade3 | CoolShade3 | CoolShade3 | vtkMRMLColorTableNodeCoolShade3 | | ColorTable | Tint | WarmTint1 | WarmTint1 | WarmTint1 | vtkMRMLColorTableNodeWarmTint1 | | ColorTable | Tint | WarmTint2 | WarmTint2 | WarmTint2 | vtkMRMLColorTableNodeWarmTint2 | | ColorTable | Tint | WarmTint3 | WarmTint3 | WarmTint3 | vtkMRMLColorTableNodeWarmTint3 | | ColorTable | Tint | CoolTint1 | CoolTint1 | CoolTint1 | vtkMRMLColorTableNodeCoolTint1 | | ColorTable | Tint | CoolTint2 | CoolTint2 | CoolTint2 | vtkMRMLColorTableNodeCoolTint2 | | ColorTable | Tint | CoolTint3 | CoolTint3 | CoolTint3 | vtkMRMLColorTableNodeCoolTint3 | | ProceduralColor | Discrete | RandomIntegers | RandomIntegers | RandomIntegers | vtkMRMLProceduralColorNodeRandomIntegers | | ProceduralColor | Continuous | RedGreenBlue | RedGreenBlue | RedGreenBlue | vtkMRMLProceduralColorNodeRedGreenBlue | | PETProceduralColor | PET | PET-Heat | PET-Heat | PET-Heat | vtkMRMLPETProceduralColorNodePET-Heat | | PETProceduralColor | PET | PET-Rainbow | PET-Rainbow | PET-Rainbow | vtkMRMLPETProceduralColorNodePET-Rainbow | | PETProceduralColor | PET | PET-MaximumIntensityProjection | PET-MaximumIntensityProjection | PET-MaximumIntensityProjection | vtkMRMLPETProceduralColorNodePET-MaximumIntensityProjection | | dGEMRICProceduralColor | Cartilage MRI | dGEMRIC-1.5T | dGEMRIC-1.5T | dGEMRIC-1.5T | vtkMRMLdGEMRICProceduralColorNodedGEMRIC-1.5T | | dGEMRICProceduralColor | Cartilage MRI | dGEMRIC-3T | dGEMRIC-3T | dGEMRIC-3T | vtkMRMLdGEMRICProceduralColorNodedGEMRIC-3T | | ColorTable | Default Labels from File | File | LightPaleChartColors | FileLightPaleChartColors.txt | vtkMRMLColorTableNodeFileLightPaleChartColors.txt | | ColorTable | Default Labels from File | File | ColdToHotRainbow | FileColdToHotRainbow.txt | vtkMRMLColorTableNodeFileColdToHotRainbow.txt | | ColorTable | Default Labels from File | File | Viridis | FileViridis.txt | vtkMRMLColorTableNodeFileViridis.txt | | ColorTable | Default Labels from File | File | Magma | FileMagma.txt | vtkMRMLColorTableNodeFileMagma.txt | | ColorTable | Default Labels from File | File | DivergingBlueRed | FileDivergingBlueRed.txt | vtkMRMLColorTableNodeFileDivergingBlueRed.txt | | ColorTable | Default Labels from File | File | HotToColdRainbow | FileHotToColdRainbow.txt | vtkMRMLColorTableNodeFileHotToColdRainbow.txt | | ColorTable | Default Labels from File | File | DarkBrightChartColors | FileDarkBrightChartColors.txt | vtkMRMLColorTableNodeFileDarkBrightChartColors.txt | | ColorTable | Default Labels from File | File | MediumChartColors | FileMediumChartColors.txt | vtkMRMLColorTableNodeFileMediumChartColors.txt | | ColorTable | Default Labels from File | File | Slicer3_2010_Label_Colors | FileSlicer3_2010_Label_Colors.txt | vtkMRMLColorTableNodeFileSlicer3_2010_Label_Colors.txt | | ColorTable | Default Labels from File | File | Slicer3_2010_Brain_Labels | FileSlicer3_2010_Brain_Labels.txt | vtkMRMLColorTableNodeFileSlicer3_2010_Brain_Labels.txt | | ColorTable | Default Labels from File | File | Inferno | FileInferno.txt | vtkMRMLColorTableNodeFileInferno.txt | | ColorTable | Default Labels from File | File | PelvisColor | FilePelvisColor.txt | vtkMRMLColorTableNodeFilePelvisColor.txt | | ColorTable | Default Labels from File | File | SPL-BrainAtlas-ColorFile | FileSPL-BrainAtlas-ColorFile.txt | vtkMRMLColorTableNodeFileSPL-BrainAtlas-ColorFile.txt | | ColorTable | Default Labels from File | File | AbdomenColors | FileAbdomenColors.txt | vtkMRMLColorTableNodeFileAbdomenColors.txt | | ColorTable | None | File | GenericColors | FileGenericColors.txt | vtkMRMLColorTableNodeFileGenericColors.txt | | ColorTable | Default Labels from File | File | 64Color-Nonsemantic | File64Color-Nonsemantic.txt | vtkMRMLColorTableNodeFile64Color-Nonsemantic.txt | | ColorTable | Default Labels from File | File | Plasma | FilePlasma.txt | vtkMRMLColorTableNodeFilePlasma.txt | | ColorTable | Default Labels from File | File | Cividis | FileCividis.txt | vtkMRMLColorTableNodeFileCividis.txt | | ColorTable | Default Labels from File | File | SPL-BrainAtlas-2009-ColorFile | FileSPL-BrainAtlas-2009-ColorFile.txt | vtkMRMLColorTableNodeFileSPL-BrainAtlas-2009-ColorFile.txt | | ColorTable | Default Labels from File | File | SPL-BrainAtlas-2012-ColorFile | FileSPL-BrainAtlas-2012-ColorFile.txt | vtkMRMLColorTableNodeFileSPL-BrainAtlas-2012-ColorFile.txt | | ColorTable | None | File | GenericAnatomyColors | FileGenericAnatomyColors.txt | vtkMRMLColorTableNodeFileGenericAnatomyColors.txt |

Note
The table has been generated using Libs/MRML/Core/Documentation/generate_default_color_node_property_table.py
See also
vtkMRMLNode::GetSingletonTag(), vtkMRMLScene::Commit()
RemoveDefaultColorNodes()
AddLabelsNode()
AddDefaultTableNodes()
AddDefaultProceduralNodes()
AddPETNodes()
AddDGEMRICNodes()
AddDefaultFileNodes()
AddUserFileNodes()

◆ AddDefaultFileNode()

void vtkMRMLColorLogic::AddDefaultFileNode ( int i)
protected

◆ AddDefaultFileNodes()

void vtkMRMLColorLogic::AddDefaultFileNodes ( )
protected

◆ AddDefaultProceduralNodes()

void vtkMRMLColorLogic::AddDefaultProceduralNodes ( )
protected

◆ AddDefaultTableNode()

void vtkMRMLColorLogic::AddDefaultTableNode ( int i)
protected

◆ AddDefaultTableNodes()

void vtkMRMLColorLogic::AddDefaultTableNodes ( )
protected

◆ AddDGEMRICNode()

void vtkMRMLColorLogic::AddDGEMRICNode ( int type)
protected

◆ AddDGEMRICNodes()

void vtkMRMLColorLogic::AddDGEMRICNodes ( )
protected

◆ AddLabelsNode()

void vtkMRMLColorLogic::AddLabelsNode ( )
protected

◆ AddPETNode()

void vtkMRMLColorLogic::AddPETNode ( int type)
protected

◆ AddPETNodes()

void vtkMRMLColorLogic::AddPETNodes ( )
protected

◆ AddUserFileNode()

void vtkMRMLColorLogic::AddUserFileNode ( int i)
protected

◆ AddUserFileNodes()

void vtkMRMLColorLogic::AddUserFileNodes ( )
protected

◆ CopyNode()

static vtkMRMLColorTableNode * vtkMRMLColorLogic::CopyNode ( vtkMRMLColorNode * colorNode,
const char * copyName )
static

Returns a vtkMRMLColorTableNode copy (type = vtkMRMLColorTableNode::User) of the color node. The node is not added to the scene and you are responsible for deleting it.

◆ CopyProceduralNode()

static vtkMRMLProceduralColorNode * vtkMRMLColorLogic::CopyProceduralNode ( vtkMRMLColorNode * colorNode,
const char * copyName )
static

Returns a vtkMRMLProceduralColorNode copy (type = vtkMRMLColorTableNode::User) of the color node. The node is not added to the scene and you are responsible for deleting it. If there is no color transfer function on the input node, for example if it's a color table node, it will return a procedural node with a blank color transfer function.

◆ CreateDefaultFileNode()

vtkMRMLColorTableNode * vtkMRMLColorLogic::CreateDefaultFileNode ( const std::string & colorname)
protected

◆ CreateDefaultTableNode()

vtkMRMLColorTableNode * vtkMRMLColorLogic::CreateDefaultTableNode ( int type)
protected

◆ CreatedGEMRICColorNode()

vtkMRMLdGEMRICProceduralColorNode * vtkMRMLColorLogic::CreatedGEMRICColorNode ( int type)
protected

◆ CreateFileNode()

vtkMRMLColorTableNode * vtkMRMLColorLogic::CreateFileNode ( const char * fileName,
vtkMRMLMessageCollection * userMessages = nullptr,
bool userType = false )
protected

◆ CreateLabelsNode()

vtkMRMLColorTableNode * vtkMRMLColorLogic::CreateLabelsNode ( )
protected

◆ CreatePETColorNode()

vtkMRMLPETProceduralColorNode * vtkMRMLColorLogic::CreatePETColorNode ( int type)
protected

◆ CreateProceduralFileNode()

vtkMRMLProceduralColorNode * vtkMRMLColorLogic::CreateProceduralFileNode ( const char * fileName,
vtkMRMLMessageCollection * userMessages = nullptr,
bool userType = false )
protected

◆ CreateRandomNode()

vtkMRMLProceduralColorNode * vtkMRMLColorLogic::CreateRandomNode ( )
protected

◆ CreateRedGreenBlueNode()

vtkMRMLProceduralColorNode * vtkMRMLColorLogic::CreateRedGreenBlueNode ( )
protected

◆ CreateUserFileNode()

vtkMRMLColorTableNode * vtkMRMLColorLogic::CreateUserFileNode ( const std::string & colorname)
protected

◆ FindDefaultColorFiles()

virtual std::vector< std::string > vtkMRMLColorLogic::FindDefaultColorFiles ( )
protectedvirtual

Reimplemented in vtkSlicerColorLogic.

◆ FindUserColorFiles()

virtual std::vector< std::string > vtkMRMLColorLogic::FindUserColorFiles ( )
protectedvirtual

Reimplemented in vtkSlicerColorLogic.

◆ GetClassName()

virtual const char * vtkMRMLColorLogic::GetClassName ( )
virtual

Reimplemented from vtkMRMLAbstractLogic.

Reimplemented in vtkSlicerColorLogic.

◆ GetColorNodeID()

static const char * vtkMRMLColorLogic::GetColorNodeID ( vtkMRMLColorNode * colorNode)
staticprotected

Return the ID of a node that doesn't belong to a scene. It is the concatenation of the node class name and its type.

◆ GetColorTableNodeID()

static const char * vtkMRMLColorLogic::GetColorTableNodeID ( int type)
static

Return the default color table node id for a given type.

◆ GetDefaultChartColorNodeID()

virtual const char * vtkMRMLColorLogic::GetDefaultChartColorNodeID ( )
virtual

Return a default color node id for a chart.

Reimplemented in vtkSlicerColorLogic.

◆ GetDefaultEditorColorNodeID()

virtual const char * vtkMRMLColorLogic::GetDefaultEditorColorNodeID ( )
virtual

Return a default color node id for the editor.

Reimplemented in vtkSlicerColorLogic.

◆ GetDefaultLabelMapColorNodeID()

virtual const char * vtkMRMLColorLogic::GetDefaultLabelMapColorNodeID ( )
virtual

Return a default color node id for a label map.

Reimplemented in vtkSlicerColorLogic.

◆ GetDefaultModelColorNodeID()

virtual const char * vtkMRMLColorLogic::GetDefaultModelColorNodeID ( )
virtual

Return a default color node id for a model.

◆ GetDefaultPlotColorNodeID()

virtual const char * vtkMRMLColorLogic::GetDefaultPlotColorNodeID ( )
virtual

Return a default color node id for a plot.

◆ GetDefaultVolumeColorNodeID()

virtual const char * vtkMRMLColorLogic::GetDefaultVolumeColorNodeID ( )
virtual

Return a default color node id for a volume.

◆ GetdGEMRICColorNodeID()

static const char * vtkMRMLColorLogic::GetdGEMRICColorNodeID ( int type)
static

Return the default dGEMRIC color node id for a given type.

◆ GetFileColorNodeID()

static const char * vtkMRMLColorLogic::GetFileColorNodeID ( const char * fileName)
static

Return a default color node id for a file based node, based on the file name.

Warning
You are responsible to delete the returned string.

◆ GetFileColorNodeSingletonTag()

static std::string vtkMRMLColorLogic::GetFileColorNodeSingletonTag ( const char * fileName)
static

◆ GetPETColorNodeID()

static const char * vtkMRMLColorLogic::GetPETColorNodeID ( int type)
static

Return the default PET color node id for a given type.

◆ GetProceduralColorNodeID()

static const char * vtkMRMLColorLogic::GetProceduralColorNodeID ( const char * name)
static

Return a default color node id for a procedural color node.

Warning
You are responsible to delete the returned string.

◆ GetUserColorFilePaths()

virtual char * vtkMRMLColorLogic::GetUserColorFilePaths ( )
virtual

Get/Set the user defined paths where to look for extra color files.

◆ IsA()

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

Reimplemented from vtkMRMLAbstractLogic.

Reimplemented in vtkSlicerColorLogic.

◆ IsTypeOf()

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

◆ LoadColorFile()

vtkMRMLColorNode * vtkMRMLColorLogic::LoadColorFile ( const char * fileName,
const char * nodeName = nullptr,
vtkMRMLMessageCollection * userMessages = nullptr,
bool userType = false )

Load in a color file, creating a storage node. Returns a pointer to the created node on success, 0 on failure (no file, invalid color file). The name of the created color node is nodeName if specified or the fileName otherwise. Try first to load it as a color table node, then if that fails, as a procedural color node. It calls CreateFileNode or CreateProceduralFileNode which are also used for the built in color nodes, so it has to unset some flags: set the category to File, turn save with scene on on the node and it's storage node, turn off hide from editors, remove the singleton tag. If userType is set to false (default) then the node type is set to "File" (constant, non-editable), otherwise it is set to "User" (user-editable).

See also
CreateFileNode, CreateProceduralFileNode

◆ New()

static vtkMRMLColorLogic * vtkMRMLColorLogic::New ( )
static

The Usual vtk class functions.

◆ OnMRMLSceneNewEvent()

virtual void vtkMRMLColorLogic::OnMRMLSceneNewEvent ( )
protectedvirtual

Called when the scene fires vtkMRMLScene::NewSceneEvent. We add the default LUTs.

◆ operator=()

void vtkMRMLColorLogic::operator= ( const vtkMRMLColorLogic & )
protected

◆ PrintSelf()

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

◆ RemoveDefaultColorNodes()

virtual void vtkMRMLColorLogic::RemoveDefaultColorNodes ( )
virtual

Remove default color nodes.

See also
AddDefaultColorNodes()

◆ RemoveLeadAndTrailSpaces()

std::string vtkMRMLColorLogic::RemoveLeadAndTrailSpaces ( std::string )
protected

◆ SafeDownCast()

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

◆ SetMRMLSceneInternal()

void vtkMRMLColorLogic::SetMRMLSceneInternal ( vtkMRMLScene * newScene)
overrideprotectedvirtual

Reimplemented to listen to specific scene events.

Reimplemented from vtkMRMLAbstractLogic.

◆ SetUserColorFilePaths()

virtual void vtkMRMLColorLogic::SetUserColorFilePaths ( const char * )
virtual

Member Data Documentation

◆ ColorFiles

std::vector<std::string> vtkMRMLColorLogic::ColorFiles
protected

a vector holding discovered default color files, found in the Resources/ColorFiles directory, white space separated with: int name r g b a with rgba in the range 0-255

Definition at line 274 of file vtkMRMLColorLogic.h.

◆ TempColorNodeID

std::string vtkMRMLColorLogic::TempColorNodeID
staticprotected

Definition at line 284 of file vtkMRMLColorLogic.h.

◆ UserColorFilePaths

char* vtkMRMLColorLogic::UserColorFilePaths
protected

a string holding delimiter separated (; on win32, : else) paths where to look for extra color files, set from the return value of vtkMRMLApplication::GetColorFilePaths

Definition at line 282 of file vtkMRMLColorLogic.h.

◆ UserColorFiles

std::vector<std::string> vtkMRMLColorLogic::UserColorFiles
protected

a vector holding discovered user defined color files, found in the UserColorFilesPath directories.

Definition at line 278 of file vtkMRMLColorLogic.h.


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