Slicer  5.3
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 | Static Protected Member Functions
vtkMRMLColorLegendDisplayNode Class Reference

Class describing how to display a color legend. More...

#include <Modules/Loadable/Colors/MRML/vtkMRMLColorLegendDisplayNode.h>

Inheritance diagram for vtkMRMLColorLegendDisplayNode:
Inheritance graph
Collaboration diagram for vtkMRMLColorLegendDisplayNode:
Collaboration graph

Public Types

enum  OrientationType : int { Horizontal = 0, Vertical, Orientation_Last }
 color legend orientation preset on a view node More...
typedef vtkMRMLDisplayNode Superclass
- Public Types inherited from vtkMRMLDisplayNode
enum  { MenuEvent = 16100 }
enum  InterpolationType { FlatInterpolation = 0, GouraudInterpolation, PhongInterpolation, PBRInterpolation }
enum  RepresentationType { PointsRepresentation = 0, WireframeRepresentation, SurfaceRepresentation }
enum  ScalarRangeFlagType {
  UseManualScalarRange = 0, UseDataScalarRange, UseColorNodeScalarRange, UseDataTypeScalarRange,
enum  ShowModeType { ShowDefault = 0, ShowIgnore, ShowMode_Last }
 Enumerated values for ShowMode. More...
typedef vtkMRMLNode Superclass
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
typedef vtkObject Superclass

Public Member Functions

vtkMRMLNodeCreateNodeInstance () override
 Create instance of the default node. Like New only virtual. More...
virtual const char * GetClassName ()
virtual std::string GetDefaultNumericLabelFormat ()
virtual std::string GetDefaultTextLabelFormat ()
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Model) More...
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent) override
void ProcessMRMLEvents (vtkObject *caller, unsigned long eventID, void *callData) override
 Handles events registered in the observer manager. More...
void ReadXMLAttributes (const char **atts) override
 Read node attributes from XML file. More...
 vtkMRMLCopyContentMacro (vtkMRMLColorLegendDisplayNode)
void WriteXML (ostream &of, int indent) override
 Write this node's information to a MRML file in XML format. More...
virtual OrientationType GetOrientation ()
virtual void SetOrientation (OrientationType)
virtual double * GetPosition ()
virtual void GetPosition (double &, double &)
virtual void GetPosition (double [2])
virtual void SetPosition (double, double)
void SetPosition (double [2])
virtual double * GetSize ()
virtual void GetSize (double &, double &)
virtual void GetSize (double [2])
virtual void SetSize (double, double)
void SetSize (double [2])
virtual std::string GetTitleText ()
 Get/Set color legend title. More...
virtual void SetTitleText (std::string)
virtual std::string GetLabelFormat ()
virtual void SetLabelFormat (std::string)
virtual int GetMaxNumberOfColors ()
 Get/set maximum number of colors in color legend. More...
virtual void SetMaxNumberOfColors (int)
virtual int GetNumberOfLabels ()
 Get/set number of displayed labels in color legend. More...
virtual void SetNumberOfLabels (int)
virtual bool GetUseColorNamesForLabels ()
 Get/set use color names for labels flag. More...
virtual void SetUseColorNamesForLabels (bool)
virtual vtkTextProperty * GetTitleTextProperty ()
virtual vtkTextProperty * GetLabelTextProperty ()
vtkMRMLDisplayNodeGetPrimaryDisplayNode ()
void SetAndObservePrimaryDisplayNode (vtkMRMLDisplayNode *node)
- Public Member Functions inherited from vtkMRMLDisplayNode
void AddViewNodeID (const char *viewNodeID)
void AutoScalarRangeOff ()
void AutoScalarRangeOn ()
virtual void ClippingOff ()
virtual void ClippingOn ()
virtual void EdgeVisibilityOff ()
virtual void EdgeVisibilityOn ()
virtual void FolderDisplayOverrideAllowedOff ()
virtual void FolderDisplayOverrideAllowedOn ()
virtual int GetActiveAttributeLocation ()
const char * GetActiveAttributeLocationAsString ()
virtual vtkDataArray * GetActiveScalarArray ()
virtual char * GetActiveScalarName ()
virtual double GetAmbient ()
int GetAutoScalarRange ()
virtual int GetClipping ()
virtual void GetColor (double [3])
virtual void GetColor (double &, double &, double &)
virtual double * GetColor ()
virtual vtkMRMLColorNodeGetColorNode ()
virtual char * GetColorNodeID ()
virtual double GetDiffuse ()
virtual vtkMRMLDisplayableNodeGetDisplayableNode ()
virtual double * GetEdgeColor ()
virtual void GetEdgeColor (double &, double &, double &)
virtual void GetEdgeColor (double [3])
virtual int GetEdgeVisibility ()
virtual bool GetFolderDisplayOverrideAllowed ()
virtual int GetInterpolateTexture ()
virtual int GetInterpolation ()
virtual int GetLighting ()
virtual double GetLineWidth ()
const char * GetNthViewNodeID (unsigned int index)
int GetNumberOfViewNodeIDs () const
virtual double GetOpacity ()
virtual double GetPointSize ()
virtual double GetPower ()
virtual int GetRepresentation ()
virtual vtkDataSet * GetScalarDataSet ()
virtual double * GetScalarRange ()
virtual void GetScalarRange (double &, double &)
virtual void GetScalarRange (double [2])
virtual int GetScalarRangeFlag ()
const char * GetScalarRangeFlagAsString ()
virtual int GetScalarVisibility ()
virtual double GetSelectedAmbient ()
virtual double * GetSelectedColor ()
virtual void GetSelectedColor (double &, double &, double &)
virtual void GetSelectedColor (double [3])
virtual double GetSelectedSpecular ()
virtual int GetShading ()
virtual double GetSliceIntersectionOpacity ()
virtual int GetSliceIntersectionThickness ()
int GetSliceIntersectionVisibility ()
virtual double GetSpecular ()
virtual int GetTensorVisibility ()
virtual vtkAlgorithmOutput * GetTextureImageDataConnection ()
virtual int GetVectorVisibility ()
std::vector< std::string > GetViewNodeIDs () const
virtual int GetVisibility ()
virtual bool GetVisibility (const char *viewNodeID)
virtual int GetVisibility2D ()
virtual int GetVisibility3D ()
virtual void InterpolateTextureOff ()
virtual void InterpolateTextureOn ()
bool IsDisplayableInView (const char *viewNodeID) const
bool IsViewNodeIDPresent (const char *viewNodeID) const
virtual void LightingOff ()
virtual void LightingOn ()
void PrintSelf (ostream &os, vtkIndent indent) override
void RemoveAllViewNodeIDs ()
void RemoveViewNodeID (char *viewNodeID)
virtual void ScalarVisibilityOff ()
virtual void ScalarVisibilityOn ()
virtual void SetActiveAttributeLocation (int)
void SetActiveAttributeLocationFromString (const char *str)
virtual void SetActiveScalar (const char *scalarName, int location)
virtual void SetActiveScalarName (const char *)
virtual void SetAmbient (double)
virtual void SetAndObserveColorNodeID (const char *ColorNodeID)
void SetAndObserveColorNodeID (const std::string &ColorNodeID)
void SetAutoScalarRange (int b)
virtual void SetClipping (int)
virtual void SetColor (double, double, double)
virtual void SetColor (double [3])
virtual void SetDiffuse (double)
void SetDisplayableOnlyInView (const char *viewNodeID)
virtual void SetEdgeColor (double, double, double)
virtual void SetEdgeColor (double [3])
virtual void SetEdgeVisibility (int)
virtual void SetFolderDisplayOverrideAllowed (bool)
virtual void SetInterpolateTexture (int)
virtual void SetInterpolation (int)
virtual void SetLighting (int)
virtual void SetLineWidth (double)
virtual void SetOpacity (double)
virtual void SetPointSize (double)
virtual void SetPower (double)
virtual void SetRepresentation (int)
virtual void SetScalarRange (double, double)
void SetScalarRange (double [2])
virtual void SetScalarRangeFlag (int flag)
void SetScalarRangeFlagFromString (const char *str)
virtual void SetScalarVisibility (int)
void SetSceneReferences () override
 Mark the color and views nodes as references. More...
virtual void SetSelectedAmbient (double)
virtual void SetSelectedColor (double, double, double)
virtual void SetSelectedColor (double [3])
virtual void SetSelectedSpecular (double)
virtual void SetShading (int)
virtual void SetSliceIntersectionOpacity (double)
virtual void SetSliceIntersectionThickness (int)
void SetSliceIntersectionVisibility (int on)
virtual void SetSpecular (double)
virtual void SetTensorVisibility (int)
virtual void SetTextureImageDataConnection (vtkAlgorithmOutput *ImageDataConnection)
virtual void SetVectorVisibility (int)
void SetViewNodeIDs (const std::vector< std::string > &viewNodeIDs)
virtual void SetVisibility (int)
virtual void SetVisibility2D (int)
virtual void SetVisibility3D (int)
void SliceIntersectionVisibilityOff ()
void SliceIntersectionVisibilityOn ()
virtual void TensorVisibilityOff ()
virtual void TensorVisibilityOn ()
virtual void UpdateAssignedAttribute ()
void UpdateReferenceID (const char *oldID, const char *newID) override
 Update the stored reference to another node in the scene. More...
void UpdateReferences () override
virtual void UpdateScalarRange ()
void UpdateScene (vtkMRMLScene *scene) override
 Finds the storage node and read the data. More...
virtual void VectorVisibilityOff ()
virtual void VectorVisibilityOn ()
virtual void Visibility2DOff ()
virtual void Visibility2DOn ()
virtual void Visibility3DOff ()
virtual void Visibility3DOn ()
virtual void VisibilityOff ()
virtual void VisibilityOn ()
 vtkMRMLCopyContentMacro (vtkMRMLDisplayNode)
virtual void SetMetallic (double)
virtual double GetMetallic ()
virtual void SetRoughness (double)
virtual double GetRoughness ()
virtual void SetFrontfaceCulling (int)
virtual int GetFrontfaceCulling ()
virtual void FrontfaceCullingOn ()
virtual void FrontfaceCullingOff ()
virtual void SetBackfaceCulling (int)
virtual int GetBackfaceCulling ()
virtual void BackfaceCullingOn ()
virtual void BackfaceCullingOff ()
virtual void SetShowMode (int)
virtual int GetShowMode ()
bool IsShowModeDefault ()
- 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 Copy (vtkMRMLNode *node)
 Copy node contents from another node of the same type. Does not copy node ID and Scene. Performs deep copy - an independent copy is created from all data, including bulk data. More...
virtual void CopyContent (vtkMRMLNode *node, bool deepCopy=true)
 Copy node contents from another node of the same type. Does not copy node ID, Scene, Name, SingletonTag, HideFromEditors, AddToScene, UndoEnabled, and node references. If deepCopy is set to false then a shallow copy of bulk data (such as image or mesh data) could be made; copying may be faster but the node may share some data with the source node instead of creating an independent copy. More...
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
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 vtkIntArray * GetContentModifiedEvents ()
int GetCustomModifiedEventPending (int eventId)
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 const char * GetTypeDisplayName ()
virtual bool GetUndoEnabled ()
virtual bool HasCopyContent () const
 Returns true if the class supports deep and shallow copying node content. More...
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 Reset (vtkMRMLNode *defaultNode)
 Reset node attributes to the initial state as defined in the constructor or the passed default node. 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 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 ()
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 vtkMRMLColorLegendDisplayNodeNew ()
static vtkMRMLColorLegendDisplayNodeSafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkMRMLDisplayNode
static const char * GetAttributeLocationAsString (int id)
 Converts attribute location (point or cell data) to string. More...
static int GetAttributeLocationFromString (const char *name)
 Gets attribute location (point or cell data) from string. More...
static const char * GetScalarRangeFlagTypeAsString (int flag)
static int GetScalarRangeFlagTypeFromString (const char *name)
 Gets scalar range flag type from string. More...
static std::string GetTextPropertyAsString (vtkTextProperty *property)
static int IsTypeOf (const char *type)
static vtkMRMLDisplayNodeSafeDownCast (vtkObject *o)
static void UpdateTextPropertyFromString (std::string inputString, vtkTextProperty *property)
static const char * GetShowModeAsString (int flag)
static int GetShowModeFromString (const char *name)
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
static vtkMRMLNodeSafeDownCast (vtkObject *o)

Protected Member Functions

void operator= (const vtkMRMLColorLegendDisplayNode &)
void SetOrientation (int id)
 vtkMRMLColorLegendDisplayNode ()
 vtkMRMLColorLegendDisplayNode (const vtkMRMLColorLegendDisplayNode &)
 ~vtkMRMLColorLegendDisplayNode () override
void SetTitleTextPropertyFromString (std::string textPropertyString)
void SetLabelTextPropertyFromString (std::string textPropertyString)
std::string GetTitleTextPropertyAsString ()
std::string GetLabelTextPropertyAsString ()
- Protected Member Functions inherited from vtkMRMLDisplayNode
void operator= (const vtkMRMLDisplayNode &)
virtual void SetColorNodeInternal (vtkMRMLColorNode *newColorNode)
 vtkMRMLDisplayNode ()
 vtkMRMLDisplayNode (const vtkMRMLDisplayNode &)
 ~vtkMRMLDisplayNode () 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::set< std::string > &references)
void RemoveInvalidReferences (const std::set< std::string > &validNodeIDs)
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...

Static Protected Member Functions

static const char * GetOrientationAsString (int id)
static int GetOrientationFromString (const char *name)
- Static Protected Member Functions inherited from vtkMRMLDisplayNode
static void GetColorFromString (const std::string &colorString, double color[4])
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)

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
- Protected Attributes inherited from vtkMRMLDisplayNode
int ActiveAttributeLocation
char * ActiveScalarName
double Ambient
int BackfaceCulling
int Clipping
double Color [3]
char * ColorNodeID
double Diffuse
double EdgeColor [3]
int EdgeVisibility
bool FolderDisplayOverrideAllowed
int FrontfaceCulling
int InterpolateTexture
int Interpolation
vtkWeakPointer< vtkMRMLDisplayableNodeLastFoundDisplayableNode
 Cached value of last found displayable node (it is expensive to determine it) More...
int Lighting
double LineWidth
double Metallic
double Opacity
double PointSize
double Power
int Representation
double Roughness
double ScalarRange [2]
int ScalarRangeFlag
int ScalarVisibility
double SelectedAmbient
double SelectedColor [3]
double SelectedSpecular
int Shading
int ShowMode
double SliceIntersectionOpacity
int SliceIntersectionThickness
double Specular
int TensorVisibility
vtkAlgorithmOutput * TextureImageDataConnection
int VectorVisibility
std::vector< std::string > ViewNodeIDs
int Visibility
int Visibility2D
int Visibility3D
- Protected Attributes inherited from vtkMRMLNode
int AddToScene {1}
AttributesType Attributes
vtkIntArray * ContentModifiedEvents
char * Description {nullptr}
int HideFromEditors {0}
char * ID {nullptr}
int InMRMLCallbackFlag {0}
Flag to avoid event loops More...
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
char * Name {nullptr}
NodeReferenceEventsType NodeReferenceEvents
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
NodeReferencesType NodeReferences
int SaveWithScene {true}
vtkWeakPointer< vtkMRMLSceneScene
int Selectable {1}
int Selected {0}
bool UndoEnabled {false}

Detailed Description

Class describing how to display a color legend.

This display node must be added as a display node to a displayable node and a display node of that same data node must be set using SetAndObservePrimaryDisplayNode.

The color legend will be displayed for the colormap and scalar range defined in the primary display node. Scalar range and color node that are set in the vtkMRMLColorLegendDisplayNode are ignored.

Definition at line 34 of file vtkMRMLColorLegendDisplayNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkMRMLColorLegendDisplayNode.h.

Member Enumeration Documentation

◆ OrientationType

color legend orientation preset on a view node


Definition at line 38 of file vtkMRMLColorLegendDisplayNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLColorLegendDisplayNode() [1/2]

vtkMRMLColorLegendDisplayNode::vtkMRMLColorLegendDisplayNode ( )

◆ ~vtkMRMLColorLegendDisplayNode()

vtkMRMLColorLegendDisplayNode::~vtkMRMLColorLegendDisplayNode ( )

◆ vtkMRMLColorLegendDisplayNode() [2/2]

vtkMRMLColorLegendDisplayNode::vtkMRMLColorLegendDisplayNode ( const vtkMRMLColorLegendDisplayNode )

Member Function Documentation

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLColorLegendDisplayNode::CreateNodeInstance ( )

Create instance of the default node. Like New only virtual.

Subclasses should implement this method

Implements vtkMRMLNode.

◆ GetClassName()

virtual const char* vtkMRMLColorLegendDisplayNode::GetClassName ( )

Reimplemented from vtkMRMLDisplayNode.

◆ GetDefaultNumericLabelFormat()

virtual std::string vtkMRMLColorLegendDisplayNode::GetDefaultNumericLabelFormat ( )

Default label format for numerical values. Recommended when UseColorNamesForLabels is false.

See also

◆ GetDefaultTextLabelFormat()

virtual std::string vtkMRMLColorLegendDisplayNode::GetDefaultTextLabelFormat ( )

Default label format for text label values. Recommended when UseColorNamesForLabels is true.

See also

◆ GetLabelFormat()

virtual std::string vtkMRMLColorLegendDisplayNode::GetLabelFormat ( )

Get/set color legend labels format string according to printf function specification (


  • display with 1 fractional digits: %.1f
  • display integer: %.0f
  • display with 4 significant digits: %.4g
  • string label annotation: s

◆ GetLabelTextProperty()

virtual vtkTextProperty* vtkMRMLColorLegendDisplayNode::GetLabelTextProperty ( )

Text property object that controls the display properties of labels. The text object property controls background color/opacity, frame size/color, font, etc. This function always returns a valid vtkTextProperty pointer.

◆ GetLabelTextPropertyAsString()

std::string vtkMRMLColorLegendDisplayNode::GetLabelTextPropertyAsString ( )

◆ GetMaxNumberOfColors()

virtual int vtkMRMLColorLegendDisplayNode::GetMaxNumberOfColors ( )

Get/set maximum number of colors in color legend.

◆ GetNodeTagName()

const char* vtkMRMLColorLegendDisplayNode::GetNodeTagName ( )

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Definition at line 47 of file vtkMRMLColorLegendDisplayNode.h.

◆ GetNumberOfLabels()

virtual int vtkMRMLColorLegendDisplayNode::GetNumberOfLabels ( )

Get/set number of displayed labels in color legend.

◆ GetOrientation()

virtual OrientationType vtkMRMLColorLegendDisplayNode::GetOrientation ( )

Get/Set color legend orientation Possible values: vtkMRMLColorLegendDisplayNode::Horizontal, vtkMRMLColorLegendDisplayNode::Vectical

◆ GetOrientationAsString()

static const char* vtkMRMLColorLegendDisplayNode::GetOrientationAsString ( int  id)

◆ GetOrientationFromString()

static int vtkMRMLColorLegendDisplayNode::GetOrientationFromString ( const char *  name)

◆ GetPosition() [1/3]

virtual void vtkMRMLColorLegendDisplayNode::GetPosition ( double  [2])

◆ GetPosition() [2/3]

virtual double* vtkMRMLColorLegendDisplayNode::GetPosition ( )

Get/Set color legend position of lower left point. Values are fraction of window size.

◆ GetPosition() [3/3]

virtual void vtkMRMLColorLegendDisplayNode::GetPosition ( double &  ,
double &   

◆ GetPrimaryDisplayNode()

vtkMRMLDisplayNode* vtkMRMLColorLegendDisplayNode::GetPrimaryDisplayNode ( )

Get/set primary display node, i.e., the display node that specifies the color table and scalar range that this color legend display node should display. This node already has an indirect reference to the displayable node, but a displayable node may have multiple display nodes, that is why this reference to a specific display node is necessary.

◆ GetSize() [1/3]

virtual double* vtkMRMLColorLegendDisplayNode::GetSize ( )

Color legend size as fraction of window size. Instead of storing width and height, the two values correspond to size of short side and long side, as this allows quick orientation switching without the need to adjust the size. For vertical orientation: width, height. For horizontal orientation: height, width.

◆ GetSize() [2/3]

virtual void vtkMRMLColorLegendDisplayNode::GetSize ( double &  ,
double &   

◆ GetSize() [3/3]

virtual void vtkMRMLColorLegendDisplayNode::GetSize ( double  [2])

◆ GetTitleText()

virtual std::string vtkMRMLColorLegendDisplayNode::GetTitleText ( )

Get/Set color legend title.

◆ GetTitleTextProperty()

virtual vtkTextProperty* vtkMRMLColorLegendDisplayNode::GetTitleTextProperty ( )

Text property object that controls the display properties of title. The text object property controls background color/opacity, frame size/color, font, etc. This function always returns a valid vtkTextProperty pointer.

◆ GetTitleTextPropertyAsString()

std::string vtkMRMLColorLegendDisplayNode::GetTitleTextPropertyAsString ( )

◆ GetUseColorNamesForLabels()

virtual bool vtkMRMLColorLegendDisplayNode::GetUseColorNamesForLabels ( )

Get/set use color names for labels flag.

◆ IsA()

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

Reimplemented from vtkMRMLDisplayNode.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLColorLegendDisplayNode* vtkMRMLColorLegendDisplayNode::New ( )

◆ operator=()

void vtkMRMLColorLegendDisplayNode::operator= ( const vtkMRMLColorLegendDisplayNode )

◆ PrintSelf()

void vtkMRMLColorLegendDisplayNode::PrintSelf ( ostream &  os,
vtkIndent  indent 

◆ ProcessMRMLEvents()

void vtkMRMLColorLegendDisplayNode::ProcessMRMLEvents ( vtkObject *  caller,
unsigned long  eventID,
void *  callData 

Handles events registered in the observer manager.

Reimplemented from vtkMRMLDisplayNode.

◆ ReadXMLAttributes()

void vtkMRMLColorLegendDisplayNode::ReadXMLAttributes ( const char **  atts)

Read node attributes from XML file.

Reimplemented from vtkMRMLDisplayNode.

◆ SafeDownCast()

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

◆ SetAndObservePrimaryDisplayNode()

void vtkMRMLColorLegendDisplayNode::SetAndObservePrimaryDisplayNode ( vtkMRMLDisplayNode node)

◆ SetLabelFormat()

virtual void vtkMRMLColorLegendDisplayNode::SetLabelFormat ( std::string  )

◆ SetLabelTextPropertyFromString()

void vtkMRMLColorLegendDisplayNode::SetLabelTextPropertyFromString ( std::string  textPropertyString)

◆ SetMaxNumberOfColors()

virtual void vtkMRMLColorLegendDisplayNode::SetMaxNumberOfColors ( int  )

◆ SetNumberOfLabels()

virtual void vtkMRMLColorLegendDisplayNode::SetNumberOfLabels ( int  )

◆ SetOrientation() [1/2]

virtual void vtkMRMLColorLegendDisplayNode::SetOrientation ( OrientationType  )

◆ SetOrientation() [2/2]

void vtkMRMLColorLegendDisplayNode::SetOrientation ( int  id)

◆ SetPosition() [1/2]

virtual void vtkMRMLColorLegendDisplayNode::SetPosition ( double  ,

◆ SetPosition() [2/2]

void vtkMRMLColorLegendDisplayNode::SetPosition ( double  [2])

◆ SetSize() [1/2]

void vtkMRMLColorLegendDisplayNode::SetSize ( double  [2])

◆ SetSize() [2/2]

virtual void vtkMRMLColorLegendDisplayNode::SetSize ( double  ,

◆ SetTitleText()

virtual void vtkMRMLColorLegendDisplayNode::SetTitleText ( std::string  )

◆ SetTitleTextPropertyFromString()

void vtkMRMLColorLegendDisplayNode::SetTitleTextPropertyFromString ( std::string  textPropertyString)

Get/set the text style from/as a string. String format follows html-style conventions.

◆ SetUseColorNamesForLabels()

virtual void vtkMRMLColorLegendDisplayNode::SetUseColorNamesForLabels ( bool  )

◆ vtkMRMLCopyContentMacro()

vtkMRMLColorLegendDisplayNode::vtkMRMLCopyContentMacro ( vtkMRMLColorLegendDisplayNode  )

Copy node content (excludes basic data, such as name and node references).

See also

◆ WriteXML()

void vtkMRMLColorLegendDisplayNode::WriteXML ( ostream &  of,
int  indent 

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

Reimplemented from vtkMRMLDisplayNode.

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