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

Abstract class that contains graphical display properties for displayable nodes. More...

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

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

Public Types

enum  { MenuEvent = 16100 }
 
enum  InterpolationType { FlatInterpolation = 0, GouraudInterpolation, PhongInterpolation }
 
enum  RepresentationType { PointsRepresentation = 0, WireframeRepresentation, SurfaceRepresentation }
 
enum  ScalarRangeFlagType {
  UseManualScalarRange = 0, UseDataScalarRange, UseColorNodeScalarRange, UseDataTypeScalarRange,
  UseDirectMapping, NUM_SCALAR_RANGE_FLAGS
}
 
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

void AddViewNodeID (const char *viewNodeID)
 
void AutoScalarRangeOff ()
 
void AutoScalarRangeOn ()
 
virtual void BackfaceCullingOff ()
 
virtual void BackfaceCullingOn ()
 
virtual void ClippingOff ()
 
virtual void ClippingOn ()
 
void Copy (vtkMRMLNode *node) override
 Copy the node's attributes to this object. More...
 
virtual void EdgeVisibilityOff ()
 
virtual void EdgeVisibilityOn ()
 
virtual void FolderDisplayOverrideAllowedOff ()
 
virtual void FolderDisplayOverrideAllowedOn ()
 
virtual void FrontfaceCullingOff ()
 
virtual void FrontfaceCullingOn ()
 
virtual int GetActiveAttributeLocation ()
 
const char * GetActiveAttributeLocationAsString ()
 
virtual char * GetActiveScalarName ()
 
virtual double GetAmbient ()
 
int GetAutoScalarRange ()
 
virtual int GetBackfaceCulling ()
 
virtual const char * GetClassName ()
 
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 GetFrontfaceCulling ()
 
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 double * GetScalarRange ()
 
virtual void GetScalarRange (double [2])
 
virtual void GetScalarRange (double &, double &)
 
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 ()
 
virtual int IsA (const char *type)
 
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 ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
 
void ReadXMLAttributes (const char **atts) override
 
void RemoveAllViewNodeIDs ()
 
void RemoveViewNodeID (char *viewNodeID)
 
virtual void ScalarVisibilityOff ()
 
virtual void ScalarVisibilityOn ()
 
virtual void SetActiveAttributeLocation (int)
 
void SetActiveAttributeLocationFromString (const char *str)
 
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 SetBackfaceCulling (int)
 
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 SetFrontfaceCulling (int)
 
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)
 
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 ()
 
void UpdateReferenceID (const char *oldID, const char *newID) override
 Update the stored reference to another node in the scene. More...
 
void UpdateReferences () override
 
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 ()
 
void WriteXML (ostream &of, int indent) override
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeAddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Convenience method that adds a referencedNodeID at the end of the list. More...
 
void AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr)
 Add a referenceRole. More...
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
 
void CopyWithoutModifiedEvent (vtkMRMLNode *node)
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSceneWithSingleModifiedEvent (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSingleModifiedEvent (vtkMRMLNode *node)
 
virtual vtkMRMLNodeCreateNodeInstance ()=0
 Create instance of the default node. Like New only virtual. 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 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...
 
virtual const char * GetNodeTagName ()=0
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole. More...
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role. More...
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceRoles ()
 
int GetNumberOfNodeReferences (const char *referenceRole)
 Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...
 
virtual int GetSaveWithScene ()
 Save node with MRML scene. More...
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
virtual bool GetUndoEnabled ()
 
bool HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Return true if referencedNodeID is in the node ID list for a specific referenceRole. More...
 
virtual void HideFromEditorsOff ()
 
virtual void HideFromEditorsOn ()
 
virtual void InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
 This method allows the node to compress events. More...
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending. More...
 
bool IsSingleton ()
 
void Modified () override
 Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...
 
virtual void OnNodeAddedToScene ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void ProcessChildNode (vtkMRMLNode *)
 Set dependencies between this node and a child node when parsing XML file. More...
 
void RemoveAttribute (const char *name)
 Remove attribute with the specified name. More...
 
void RemoveNodeReferenceIDs (const char *referenceRole)
 Remove all node IDs and associated nodes for a specific referenceRole. More...
 
void RemoveNthNodeReferenceID (const char *referenceRole, int n)
 Convenience method that removes the Nth node ID from the list. More...
 
virtual void 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 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 int IsTypeOf (const char *type)
 
static vtkMRMLDisplayNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

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::map< std::string, std::string > &references)
 
virtual void SetTempURLString (const char *)
 Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More...
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore)
 
virtual void UpdateNodeReferences (const char *referenceRole=nullptr)
 
virtual void UpdateNthNodeReference (const char *referenceRole, int n)
 
 vtkMRMLNode ()
 
 vtkMRMLNode (const vtkMRMLNode &)
 
 ~vtkMRMLNode () override
 critical to have a virtual destructor! More...
 

Protected Attributes

int ActiveAttributeLocation
 
char * ActiveScalarName
 
double Ambient
 
int BackfaceCulling
 
int Clipping
 
double Color [3]
 
vtkMRMLColorNodeColorNode
 
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 Opacity
 
double PointSize
 
double Power
 
int Representation
 
double ScalarRange [2]
 
int ScalarRangeFlag
 
int ScalarVisibility
 
double SelectedAmbient
 
double SelectedColor [3]
 
double SelectedSpecular
 
int Shading
 
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
 
AttributesType Attributes
 
char * Description
 
int HideFromEditors
 
char * ID
 
int InMRMLCallbackFlag
 
Flag to avoid event loops More...
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
 
vtkObserverManagerMRMLObserverManager
 
char * Name
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable
 
int Selected
 
bool UndoEnabled
 

Additional Inherited Members

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

Detailed Description

Abstract class that contains graphical display properties for displayable nodes.

vtkMRMLDisplayNode fires a ModifiedEvent event when the texture image data or the color node is modified.

See also
vtkMRMLDisplayableNode, TextureImageDataConnection, ColorNode

Definition at line 37 of file vtkMRMLDisplayNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 40 of file vtkMRMLDisplayNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
MenuEvent 

display of context menu is requested (mapped to right-click by default), event data is vtkMRMLInteractionEventData

Definition at line 81 of file vtkMRMLDisplayNode.h.

◆ InterpolationType

Interpolation models

See also
GetInterpolation(), SetInterpolation()
Enumerator
FlatInterpolation 
GouraudInterpolation 
PhongInterpolation 

Definition at line 53 of file vtkMRMLDisplayNode.h.

◆ RepresentationType

Representation models

See also
GetRepresentation(), SetRepresentation()
Enumerator
PointsRepresentation 
WireframeRepresentation 
SurfaceRepresentation 

Definition at line 45 of file vtkMRMLDisplayNode.h.

◆ ScalarRangeFlagType

Scalar range options for displaying data associated with this display node, this setting determines if the display node, color node, or ? determine the mapping range between the data and the colors used to display it. Not all are currently supported. UseDataScalarRange - use the current min/max of the active data (former auto) UseColorNodeScalarRange - use the range from the associated color node UseDataTypeScalarRange - use the min/max of the numerical type of the UseDirectMapping - map scalar values directly to RGB values data, for example minimum integer to maximum integer UseManualScalarRange - use user defined values

See also
ScalarRangeFlag, GetScalarRangeFlag(), SetScalarRangeFlag(), SetScalarRange(), GetScalarRange(), GetScalarRangeFlagTypeAsString()
Enumerator
UseManualScalarRange 
UseDataScalarRange 
UseColorNodeScalarRange 
UseDataTypeScalarRange 
UseDirectMapping 
NUM_SCALAR_RANGE_FLAGS 

Definition at line 71 of file vtkMRMLDisplayNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLDisplayNode() [1/2]

vtkMRMLDisplayNode::vtkMRMLDisplayNode ( )
protected

◆ ~vtkMRMLDisplayNode()

vtkMRMLDisplayNode::~vtkMRMLDisplayNode ( )
overrideprotected

◆ vtkMRMLDisplayNode() [2/2]

vtkMRMLDisplayNode::vtkMRMLDisplayNode ( const vtkMRMLDisplayNode )
protected

Member Function Documentation

◆ AddViewNodeID()

void vtkMRMLDisplayNode::AddViewNodeID ( const char *  viewNodeID)

Add View Node ID for the view to display this node in.

See also
ViewNodeIDs, RemoveViewNodeID(), RemoveAllViewNodeIDs()

◆ AutoScalarRangeOff()

void vtkMRMLDisplayNode::AutoScalarRangeOff ( )

◆ AutoScalarRangeOn()

void vtkMRMLDisplayNode::AutoScalarRangeOn ( )

Set the auto scalar range flag of the display node.

Deprecated:
See also
SetScalarRangeFlag(), SetAutoScalarRange(), GetAutoScalarRange()

◆ BackfaceCullingOff()

virtual void vtkMRMLDisplayNode::BackfaceCullingOff ( )
virtual

◆ BackfaceCullingOn()

virtual void vtkMRMLDisplayNode::BackfaceCullingOn ( )
virtual

Set the backface culling of the display node.

See also
BackfaceCulling, SetBackfaceCulling(), GetBackfaceCulling()

◆ ClippingOff()

virtual void vtkMRMLDisplayNode::ClippingOff ( )
virtual

◆ ClippingOn()

virtual void vtkMRMLDisplayNode::ClippingOn ( )
virtual

Set the clipping of the display node.

See also
Clipping, SetClipping(), GetClipping()

◆ Copy()

void vtkMRMLDisplayNode::Copy ( vtkMRMLNode node)
overridevirtual

◆ EdgeVisibilityOff()

virtual void vtkMRMLDisplayNode::EdgeVisibilityOff ( )
virtual

◆ EdgeVisibilityOn()

virtual void vtkMRMLDisplayNode::EdgeVisibilityOn ( )
virtual

◆ FolderDisplayOverrideAllowedOff()

virtual void vtkMRMLDisplayNode::FolderDisplayOverrideAllowedOff ( )
virtual

◆ FolderDisplayOverrideAllowedOn()

virtual void vtkMRMLDisplayNode::FolderDisplayOverrideAllowedOn ( )
virtual

Set flag determining whether folders are allowed to override display properties.

See also
FolderDisplayOverrideAllowed, SetFolderDisplayOverrideAllowed(), GetFolderDisplayOverrideAllowed()

◆ FrontfaceCullingOff()

virtual void vtkMRMLDisplayNode::FrontfaceCullingOff ( )
virtual

◆ FrontfaceCullingOn()

virtual void vtkMRMLDisplayNode::FrontfaceCullingOn ( )
virtual

Set the backface culling of the display node.

See also
FrontfaceCulling, SetFrontfaceCulling(), GetFrontfaceCulling()

◆ GetActiveAttributeLocation()

virtual int vtkMRMLDisplayNode::GetActiveAttributeLocation ( )
virtual

Get the active attribute location of the display node.

See also
ActiveAttributeLocation, SetActiveAttributeLocation(), GetActiveAttributeLocationAsString()

◆ GetActiveAttributeLocationAsString()

const char* vtkMRMLDisplayNode::GetActiveAttributeLocationAsString ( )

Get the active attribute location of the display node as string

See also
ActiveAttributeLocation, GetActiveAttributeLocation()

◆ GetActiveScalarName()

virtual char* vtkMRMLDisplayNode::GetActiveScalarName ( )
virtual

Return the name of the currently active scalar field for this model.

See also
ActiveScalarName, SetActiveScalarName()

◆ GetAmbient()

virtual double vtkMRMLDisplayNode::GetAmbient ( )
virtual

Get the ambient coef of the display node.

See also
Ambient, SetAmbient()

◆ GetAttributeLocationAsString()

static const char* vtkMRMLDisplayNode::GetAttributeLocationAsString ( int  id)
static

Converts attribute location (point or cell data) to string.

◆ GetAttributeLocationFromString()

static int vtkMRMLDisplayNode::GetAttributeLocationFromString ( const char *  name)
static

Gets attribute location (point or cell data) from string.

◆ GetAutoScalarRange()

int vtkMRMLDisplayNode::GetAutoScalarRange ( )

Get the auto scalar range flag of the display node.

Deprecated:
See also
GetScalarRangeFlag(), SetAutoScalarRange(), AutoScalarRangeOn(), AutoScalarRangeOff()

◆ GetBackfaceCulling()

virtual int vtkMRMLDisplayNode::GetBackfaceCulling ( )
virtual

Get the backface culling of the display node.

See also
BackfaceCulling, SetBackfaceCulling(), BackfaceCullingOn(), BackfaceCullingOff()

◆ GetClassName()

virtual const char* vtkMRMLDisplayNode::GetClassName ( )
virtual

◆ GetClipping()

virtual int vtkMRMLDisplayNode::GetClipping ( )
virtual

Get the clipping of the display node.

See also
Clipping, SetClipping(), ClippingOn(), ClippingOff()

◆ GetColor() [1/3]

virtual double* vtkMRMLDisplayNode::GetColor ( )
virtual

Get the color of the display node.

See also
Color, SetColor()

◆ GetColor() [2/3]

virtual void vtkMRMLDisplayNode::GetColor ( double  [3])
virtual

◆ GetColor() [3/3]

virtual void vtkMRMLDisplayNode::GetColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetColorNode()

virtual vtkMRMLColorNode* vtkMRMLDisplayNode::GetColorNode ( )
virtual

Get associated color MRML node. Search the node into the scene if the node hasn't been cached yet. This can be a slow call.

See also
ColorNodeID, SetAndObserveColorNodeID, GetColorNodeID()

◆ GetColorNodeID()

virtual char* vtkMRMLDisplayNode::GetColorNodeID ( )
virtual

Get color node ID of the display node.

See also
ColorNodeID, SetAndObserveColorNodeID()

◆ GetDiffuse()

virtual double vtkMRMLDisplayNode::GetDiffuse ( )
virtual

Get the diffuse coef of the display node.

See also
Diffuse, SetDiffuse()

◆ GetDisplayableNode()

virtual vtkMRMLDisplayableNode* vtkMRMLDisplayNode::GetDisplayableNode ( )
virtual

Returns the first displayable node that is associated to this display node

See also
vtkMRMLDisplayableNode

◆ GetEdgeColor() [1/3]

virtual void vtkMRMLDisplayNode::GetEdgeColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetEdgeColor() [2/3]

virtual double* vtkMRMLDisplayNode::GetEdgeColor ( )
virtual

Get the edge color of the display node.

See also
EdgeColor, SetEdgeColor()

◆ GetEdgeColor() [3/3]

virtual void vtkMRMLDisplayNode::GetEdgeColor ( double  [3])
virtual

◆ GetEdgeVisibility()

virtual int vtkMRMLDisplayNode::GetEdgeVisibility ( )
virtual

Get the visibility of the edges.

See also
EdgeVisibility, SetEdgeVisibility()

◆ GetFolderDisplayOverrideAllowed()

virtual bool vtkMRMLDisplayNode::GetFolderDisplayOverrideAllowed ( )
virtual

Get flag determining whether folders are allowed to override display properties.

See also
FolderDisplayOverrideAllowed, SetFolderDisplayOverrideAllowed()

◆ GetFrontfaceCulling()

virtual int vtkMRMLDisplayNode::GetFrontfaceCulling ( )
virtual

Get the backface culling of the display node.

See also
FrontfaceCulling, SetFrontfaceCulling(), FrontfaceCullingOn(), FrontfaceCullingOff()

◆ GetInterpolateTexture()

virtual int vtkMRMLDisplayNode::GetInterpolateTexture ( )
virtual

Get the texture interpolation of the display node.

See also
InterpolateTexture, SetInterpolateTexture(), InterpolateTextureOn(), InterpolateTextureOff()

◆ GetInterpolation()

virtual int vtkMRMLDisplayNode::GetInterpolation ( )
virtual

Get the interpolation of the surface.

See also
Interpolation, SetInterpolation()

◆ GetLighting()

virtual int vtkMRMLDisplayNode::GetLighting ( )
virtual

Get the lighting of the display node.

See also
Lighting, SetLighting(), LightingOn(), LightingOff()

◆ GetLineWidth()

virtual double vtkMRMLDisplayNode::GetLineWidth ( )
virtual

Get the widget of lines.

See also
LineWidth, SetLineWidth()

◆ GetNthViewNodeID()

const char* vtkMRMLDisplayNode::GetNthViewNodeID ( unsigned int  index)

Get View Node ID's for the view to display this node in. If nullptr, display in all views

See also
ViewNodeIDs, GetViewNodeIDs(), AddViewNodeID()

◆ GetNumberOfViewNodeIDs()

int vtkMRMLDisplayNode::GetNumberOfViewNodeIDs ( ) const
inline

Get number of View Node ID's for the view to display this node in. If 0, display in all views

See also
ViewNodeIDs, GetViewNodeIDs(), AddViewNodeID()

Definition at line 800 of file vtkMRMLDisplayNode.h.

◆ GetOpacity()

virtual double vtkMRMLDisplayNode::GetOpacity ( )
virtual

Get the opacity coef of the display node.

See also
Opacity, SetOpacity()

◆ GetPointSize()

virtual double vtkMRMLDisplayNode::GetPointSize ( )
virtual

Get the diameter of points.

See also
PointSize, SetPointSize()

◆ GetPower()

virtual double vtkMRMLDisplayNode::GetPower ( )
virtual

Get the specular power coef of the display node.

See also
Power, SetPower()

◆ GetRepresentation()

virtual int vtkMRMLDisplayNode::GetRepresentation ( )
virtual

Get the representation of the surface.

See also
Representation, SetRepresentation()

◆ GetScalarRange() [1/3]

virtual double* vtkMRMLDisplayNode::GetScalarRange ( )
virtual

Get the scalar range of the display node.

See also
ScalarRange, SetScalarRange()

◆ GetScalarRange() [2/3]

virtual void vtkMRMLDisplayNode::GetScalarRange ( double &  ,
double &   
)
virtual

◆ GetScalarRange() [3/3]

virtual void vtkMRMLDisplayNode::GetScalarRange ( double  [2])
virtual

◆ GetScalarRangeFlag()

virtual int vtkMRMLDisplayNode::GetScalarRangeFlag ( )
virtual

Get the interpolation of the surface.

See also
ScalarRangeFlag, SetScalarRangeFlag(), GetScalarRangeFlagAsString()

◆ GetScalarRangeFlagAsString()

const char* vtkMRMLDisplayNode::GetScalarRangeFlagAsString ( )

Get scalar range flag as string

See also
ScalarRangeFlag, GetScalarRangeFlag()

◆ GetScalarRangeFlagTypeAsString()

static const char* vtkMRMLDisplayNode::GetScalarRangeFlagTypeAsString ( int  flag)
static

Convert between scalar range flag type id and string

See also
ScalarRangeFlag

◆ GetScalarRangeFlagTypeFromString()

static int vtkMRMLDisplayNode::GetScalarRangeFlagTypeFromString ( const char *  name)
static

Gets scalar range flag type from string.

◆ GetScalarVisibility()

virtual int vtkMRMLDisplayNode::GetScalarVisibility ( )
virtual

Get the scalar visibility of the display node.

See also
ScalarVisibility, SetScalarVisibility(), ScalarVisibilityOn(), ScalarVisibilityOff()

◆ GetSelectedAmbient()

virtual double vtkMRMLDisplayNode::GetSelectedAmbient ( )
virtual

Get the selected ambient coef of the display node.

See also
SelectedAmbient, SetSelectedAmbient()

◆ GetSelectedColor() [1/3]

virtual double* vtkMRMLDisplayNode::GetSelectedColor ( )
virtual

Get the selected color of the display node.

See also
SelectedColor, SetSelectedColor()

◆ GetSelectedColor() [2/3]

virtual void vtkMRMLDisplayNode::GetSelectedColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetSelectedColor() [3/3]

virtual void vtkMRMLDisplayNode::GetSelectedColor ( double  [3])
virtual

◆ GetSelectedSpecular()

virtual double vtkMRMLDisplayNode::GetSelectedSpecular ( )
virtual

Get the selected specular coef of the display node.

See also
SelectedSpecular, SetSelectedSpecular()

◆ GetShading()

virtual int vtkMRMLDisplayNode::GetShading ( )
virtual

Get the shading of the display node.

See also
Shading, SetShading()

◆ GetSliceIntersectionOpacity()

virtual double vtkMRMLDisplayNode::GetSliceIntersectionOpacity ( )
virtual

Get the slice intersection opacity coef of the display node.

See also
SliceIntersectionOpacity, SetSliceIntersectionOpacity()

◆ GetSliceIntersectionThickness()

virtual int vtkMRMLDisplayNode::GetSliceIntersectionThickness ( )
virtual

Get the slice intersection thickness of the display node. In voxels.

See also
SliceIntersectionThickness, SetSliceIntersectionThickness()

◆ GetSliceIntersectionVisibility()

int vtkMRMLDisplayNode::GetSliceIntersectionVisibility ( )

Get the slice intersection visibility of the display node. Function to manage

See also
Visibility2D for backwards compatibility
Visibility2D, SetSliceIntersectionVisibility(), SliceIntersectionVisibilityOn(), SliceIntersectionVisibilityOff()
Deprecated:
GetSliceIntersectionVisibility

◆ GetSpecular()

virtual double vtkMRMLDisplayNode::GetSpecular ( )
virtual

Get the specular coef of the display node.

See also
Specular, SetSpecular()

◆ GetTensorVisibility()

virtual int vtkMRMLDisplayNode::GetTensorVisibility ( )
virtual

Get the tensor visibility of the display node.

See also
TensorVisibility, SetTensorVisibility(), TensorVisibilityOn(), TensorVisibilityOff()

◆ GetTextureImageDataConnection()

virtual vtkAlgorithmOutput* vtkMRMLDisplayNode::GetTextureImageDataConnection ( )
virtual

Get the texture image data port.

See also
TextureImageDataConnection, SetTextureImageDataConnection()

◆ GetVectorVisibility()

virtual int vtkMRMLDisplayNode::GetVectorVisibility ( )
virtual

Get the vector visibility of the display node.

See also
VectorVisibility, SetVectorVisibility(), VectorVisibilityOn(), VectorVisibilityOff()

◆ GetViewNodeIDs()

std::vector< std::string > vtkMRMLDisplayNode::GetViewNodeIDs ( ) const
inline

Get all View Node ID's for the view to display this node in. If empty, display in all views

See also
ViewNodeIDs, GetNthViewNodeID(), AddViewNodeID()

Definition at line 806 of file vtkMRMLDisplayNode.h.

◆ GetVisibility() [1/2]

virtual int vtkMRMLDisplayNode::GetVisibility ( )
virtual

Get the visibility of the display node.

See also
Visibility, SetVisibility(), VisibilityOn(), VisibilityOff()

◆ GetVisibility() [2/2]

virtual bool vtkMRMLDisplayNode::GetVisibility ( const char *  viewNodeID)
virtual

Return true if the display node should be visible in the view node. To be visible in the view, the node needs to be visible (Visibility == 1) and the view ID must be in the ViewNodeIDs list or the list must be empty (visible in all views).

See also
Visibility, ViewNodeIDs

◆ GetVisibility2D()

virtual int vtkMRMLDisplayNode::GetVisibility2D ( )
virtual

Get the 2D visibility of the display node.

See also
Visibility2D, SetVisibility2D(), Visibility2DOn(), Visibility2DOff()

◆ GetVisibility3D()

virtual int vtkMRMLDisplayNode::GetVisibility3D ( )
virtual

Get the 3D visibility of the display node.

See also
Visibility3D, SetVisibility3D(), Visibility3DOn(), Visibility3DOff()

◆ InterpolateTextureOff()

virtual void vtkMRMLDisplayNode::InterpolateTextureOff ( )
virtual

◆ InterpolateTextureOn()

virtual void vtkMRMLDisplayNode::InterpolateTextureOn ( )
virtual

Set the texture interpolation of the display node.

See also
InterpolateTexture, SetInterpolateTexture(), GetInterpolateTexture()

◆ IsA()

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

◆ IsDisplayableInView()

bool vtkMRMLDisplayNode::IsDisplayableInView ( const char *  viewNodeID) const

Returns true if the viewNodeID is present in the ViewNodeId list or there is no ViewNodeId in the list (meaning all the views display the node)

See also
ViewNodeIDs, IsViewNodeIDPresent(), AddViewNodeID()

◆ IsTypeOf()

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

◆ IsViewNodeIDPresent()

bool vtkMRMLDisplayNode::IsViewNodeIDPresent ( const char *  viewNodeID) const

True if the view node id is present in the viewnodeid list false if not found

See also
ViewNodeIDs, IsDisplayableInView(), AddViewNodeID()

◆ LightingOff()

virtual void vtkMRMLDisplayNode::LightingOff ( )
virtual

◆ LightingOn()

virtual void vtkMRMLDisplayNode::LightingOn ( )
virtual

Enable/Disable the lighting of the display node.

See also
Lighting, SetLighting(), GetLighting()

◆ operator=()

void vtkMRMLDisplayNode::operator= ( const vtkMRMLDisplayNode )
protected

◆ PrintSelf()

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

◆ ProcessMRMLEvents()

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

◆ ReadXMLAttributes()

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

◆ RemoveAllViewNodeIDs()

void vtkMRMLDisplayNode::RemoveAllViewNodeIDs ( )

Remove All View Node IDs for the views to display this node in.

See also
ViewNodeIDs, AddViewNodeID(), RemoveViewNodeID()

◆ RemoveViewNodeID()

void vtkMRMLDisplayNode::RemoveViewNodeID ( char *  viewNodeID)

Remove View Node ID for the view to display this node in.

See also
ViewNodeIDs, AddViewNodeID(), RemoveAllViewNodeIDs()

◆ SafeDownCast()

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

◆ ScalarVisibilityOff()

virtual void vtkMRMLDisplayNode::ScalarVisibilityOff ( )
virtual

◆ ScalarVisibilityOn()

virtual void vtkMRMLDisplayNode::ScalarVisibilityOn ( )
virtual

Set the scalar visibility of the display node.

See also
ScalarVisibility, SetScalarVisibility(), GetScalarVisibility

◆ SetActiveAttributeLocation()

virtual void vtkMRMLDisplayNode::SetActiveAttributeLocation ( int  )
virtual

Set the active attribute location of the display node. vtkAssignAttribute::POINT_DATA by default.

See also
ActiveAttributeLocation, GetActiveAttributeLocation(), SetActiveAttributeLocationFromString()

Reimplemented in vtkMRMLModelDisplayNode.

◆ SetActiveAttributeLocationFromString()

void vtkMRMLDisplayNode::SetActiveAttributeLocationFromString ( const char *  str)

Set the active attribute location of the display node from string

See also
ActiveAttributeLocation, SetActiveAttributeLocation()

◆ SetActiveScalarName()

virtual void vtkMRMLDisplayNode::SetActiveScalarName ( const char *  )
virtual

Set the active scalar name of the display node.

See also
ActiveScalarName, GetActiveScalarName()

Reimplemented in vtkMRMLModelDisplayNode.

◆ SetAmbient()

virtual void vtkMRMLDisplayNode::SetAmbient ( double  )
virtual

Set the ambient coef of the display node.

See also
Ambient, GetAmbient()

◆ SetAndObserveColorNodeID() [1/2]

virtual void vtkMRMLDisplayNode::SetAndObserveColorNodeID ( const char *  ColorNodeID)
virtual

Set and observe color node of the display node.

See also
ColorNodeID, GetColorNodeID()

◆ SetAndObserveColorNodeID() [2/2]

void vtkMRMLDisplayNode::SetAndObserveColorNodeID ( const std::string &  ColorNodeID)

Set and observe color node of the display node. Utility method that conveniently takes a string instead of a char*

See also
ColorNodeID, GetColorNodeID()

◆ SetAutoScalarRange()

void vtkMRMLDisplayNode::SetAutoScalarRange ( int  b)

Set the auto scalar range flag of the display node.

Deprecated:
See also
SetScalarRangeFlag(), GetAutoScalarRange(), AutoScalarRangeOn(), AutoScalarRangeOff()

◆ SetBackfaceCulling()

virtual void vtkMRMLDisplayNode::SetBackfaceCulling ( int  )
virtual

Set the backface culling of the display node.

See also
BackfaceCulling, GetBackfaceCulling(), BackfaceCullingOn(), BackfaceCullingOff()

◆ SetClipping()

virtual void vtkMRMLDisplayNode::SetClipping ( int  )
virtual

Set the clipping of the display node.

See also
Clipping, GetClipping(), ClippingOn(), ClippingOff()

◆ SetColor() [1/2]

virtual void vtkMRMLDisplayNode::SetColor ( double  [3])
virtual

◆ SetColor() [2/2]

virtual void vtkMRMLDisplayNode::SetColor ( double  ,
double  ,
double   
)
virtual

Set the color of the display node.

See also
Color, GetColor()

◆ SetColorNodeInternal()

virtual void vtkMRMLDisplayNode::SetColorNodeInternal ( vtkMRMLColorNode newColorNode)
protectedvirtual

Internal function to set the color node. Called by SetColorNodeID().

See also
SetColorNodeID(), ColorNode, ColorNodeID

Reimplemented in vtkMRMLScalarVolumeDisplayNode.

◆ SetDiffuse()

virtual void vtkMRMLDisplayNode::SetDiffuse ( double  )
virtual

Set the diffuse coef of the display node.

See also
Diffuse, GetDiffuse()

◆ SetDisplayableOnlyInView()

void vtkMRMLDisplayNode::SetDisplayableOnlyInView ( const char *  viewNodeID)

Set the View Node ID as the only view to display this node in. If the view node id does not exist, the node will show in all views. Uses a disable/enable modified event block to avoid flicker.

See also
RemoveAllViewNodeIDs(), AddViewNodeID()

◆ SetEdgeColor() [1/2]

virtual void vtkMRMLDisplayNode::SetEdgeColor ( double  ,
double  ,
double   
)
virtual

Set the edge color of the display node.

See also
EdgeColor, GetEdgeColor()

◆ SetEdgeColor() [2/2]

virtual void vtkMRMLDisplayNode::SetEdgeColor ( double  [3])
virtual

◆ SetEdgeVisibility()

virtual void vtkMRMLDisplayNode::SetEdgeVisibility ( int  )
virtual

Set the visibility of the edges.

See also
EdgeVisibility, GetEdgeVisibility()

◆ SetFolderDisplayOverrideAllowed()

virtual void vtkMRMLDisplayNode::SetFolderDisplayOverrideAllowed ( bool  )
virtual

Set flag determining whether folders are allowed to override display properties.

See also
FolderDisplayOverrideAllowed, GetFolderDisplayOverrideAllowed()

◆ SetFrontfaceCulling()

virtual void vtkMRMLDisplayNode::SetFrontfaceCulling ( int  )
virtual

Set the backface culling of the display node.

See also
FrontfaceCulling, GetFrontfaceCulling(), FrontfaceCullingOn(), FrontfaceCullingOff()

◆ SetInterpolateTexture()

virtual void vtkMRMLDisplayNode::SetInterpolateTexture ( int  )
virtual

Set the texture interpolation of the display node.

See also
InterpolateTexture, GetInterpolateTexture(), InterpolateTextureOn(), InterpolateTextureOff()

◆ SetInterpolation()

virtual void vtkMRMLDisplayNode::SetInterpolation ( int  )
virtual

Set the interpolation of the surface.

See also
Interpolation, GetInterpolation()

◆ SetLighting()

virtual void vtkMRMLDisplayNode::SetLighting ( int  )
virtual

Enable/Disable lighting of the display node.

See also
Lighting, GetLighting(), LightingOn(), LightingOff()

◆ SetLineWidth()

virtual void vtkMRMLDisplayNode::SetLineWidth ( double  )
virtual

Set the width of lines.

See also
LineWidth, GetLineWidth()

◆ SetOpacity()

virtual void vtkMRMLDisplayNode::SetOpacity ( double  )
virtual

Set the opacity coef of the display node.

See also
Opacity, GetOpacity()

◆ SetPointSize()

virtual void vtkMRMLDisplayNode::SetPointSize ( double  )
virtual

Set the diameter of points.

See also
PointSize, GetPointSize()

◆ SetPower()

virtual void vtkMRMLDisplayNode::SetPower ( double  )
virtual

Set the specular power coef of the display node.

See also
Power, GetPower()

◆ SetRepresentation()

virtual void vtkMRMLDisplayNode::SetRepresentation ( int  )
virtual

Set the representation of the surface.

See also
Representation, GetRepresentation()

◆ SetScalarRange() [1/2]

void vtkMRMLDisplayNode::SetScalarRange ( double  [2])

◆ SetScalarRange() [2/2]

virtual void vtkMRMLDisplayNode::SetScalarRange ( double  ,
double   
)
virtual

Set the scalar range of the display node.

See also
ScalarRange, GetScalarRange()

◆ SetScalarRangeFlag()

virtual void vtkMRMLDisplayNode::SetScalarRangeFlag ( int  )
virtual

Set the scalar range to use with color mapping

See also
ScalarRangeFlag, GetScalarRangeFlag(), SetScalarRangeFlagFromString()

Reimplemented in vtkMRMLModelDisplayNode.

◆ SetScalarRangeFlagFromString()

void vtkMRMLDisplayNode::SetScalarRangeFlagFromString ( const char *  str)

Set scalar range flag from string

See also
ScalarRangeFlag, SetScalarRangeFlag()

◆ SetScalarVisibility()

virtual void vtkMRMLDisplayNode::SetScalarVisibility ( int  )
virtual

Set the scalar visibility of the display node.

See also
ScalarVisibility, GetScalarVisibility(), ScalarVisibilityOn(), ScalarVisibilityOff()

◆ SetSceneReferences()

void vtkMRMLDisplayNode::SetSceneReferences ( )
overridevirtual

Mark the color and views nodes as references.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLGlyphableVolumeDisplayNode.

◆ SetSelectedAmbient()

virtual void vtkMRMLDisplayNode::SetSelectedAmbient ( double  )
virtual

Set the selected ambient coef of the display node.

See also
SelectedAmbient, GetSelectedAmbient()

◆ SetSelectedColor() [1/2]

virtual void vtkMRMLDisplayNode::SetSelectedColor ( double  [3])
virtual

◆ SetSelectedColor() [2/2]

virtual void vtkMRMLDisplayNode::SetSelectedColor ( double  ,
double  ,
double   
)
virtual

Set the selected color of the display node.

See also
SelectedColor, GetSelectedColor()

◆ SetSelectedSpecular()

virtual void vtkMRMLDisplayNode::SetSelectedSpecular ( double  )
virtual

Set the selected specular coef of the display node.

See also
SelectedSpecular, GetSelectedSpecular()

◆ SetShading()

virtual void vtkMRMLDisplayNode::SetShading ( int  )
virtual

Set the shading mode (None, Gouraud, Flat) of the display node.

See also
Shading, GetShading()

◆ SetSliceIntersectionOpacity()

virtual void vtkMRMLDisplayNode::SetSliceIntersectionOpacity ( double  )
virtual

Set the slice intersection opacity coef of the display node.

See also
SliceIntersectionOpacity, GetSliceIntersectionOpacity()

◆ SetSliceIntersectionThickness()

virtual void vtkMRMLDisplayNode::SetSliceIntersectionThickness ( int  )
virtual

Set the slice intersection thickness of the display node. In voxels.

See also
SliceIntersectionThickness, GetSliceIntersectionThickness()

◆ SetSliceIntersectionVisibility()

void vtkMRMLDisplayNode::SetSliceIntersectionVisibility ( int  on)

Set the slice intersection visibility of the display node. Function to manage

See also
Visibility2D for backwards compatibility
Visibility2D, GetSliceIntersectionVisibility(), SliceIntersectionVisibilityOn(), SliceIntersectionVisibilityOff()
Deprecated:
SetSliceIntersectionVisibility

◆ SetSpecular()

virtual void vtkMRMLDisplayNode::SetSpecular ( double  )
virtual

Set the specular coef of the display node.

See also
Specular, GetSpecular()

◆ SetTensorVisibility()

virtual void vtkMRMLDisplayNode::SetTensorVisibility ( int  )
virtual

Set the tensor visibility of the display node.

See also
TensorVisibility, GetTensorVisibility(), TensorVisibilityOn(), TensorVisibilityOff()

◆ SetTextureImageDataConnection()

virtual void vtkMRMLDisplayNode::SetTextureImageDataConnection ( vtkAlgorithmOutput *  ImageDataConnection)
virtual

Set and observe the texture image data port.

See also
TextureImageDataConnection, GetTextureImageDataConnection()

◆ SetVectorVisibility()

virtual void vtkMRMLDisplayNode::SetVectorVisibility ( int  )
virtual

Set the vector visibility of the display node.

See also
VectorVisibility, GetVectorVisibility(), VectorVisibilityOn(), VectorVisibilityOff()

◆ SetViewNodeIDs()

void vtkMRMLDisplayNode::SetViewNodeIDs ( const std::vector< std::string > &  viewNodeIDs)

Set all the view node IDs at once. Only trigger Modified() if the new vector is different from the existing vector.

See also
GetViewNodeIDs(), AddViewNodeID()

◆ SetVisibility()

virtual void vtkMRMLDisplayNode::SetVisibility ( int  )
virtual

Set the visibility of the display node.

See also
Visibility, GetVisibility(), VisibilityOn(), VisibilityOff()

◆ SetVisibility2D()

virtual void vtkMRMLDisplayNode::SetVisibility2D ( int  )
virtual

Set the 2D visibility of the display node.

See also
Visibility2D, GetVisibility2D(), Visibility2DOn(), Visibility2DOff()

◆ SetVisibility3D()

virtual void vtkMRMLDisplayNode::SetVisibility3D ( int  )
virtual

Set the 3D visibility of the display node.

See also
Visibility3D, GetVisibility3D(), Visibility3DOn(), Visibility3DOff()

◆ SliceIntersectionVisibilityOff()

void vtkMRMLDisplayNode::SliceIntersectionVisibilityOff ( )

Set the slice intersection visibility of the display node. Function to manage

See also
Visibility2D for backwards compatibility
Visibility2D, SetSliceIntersectionVisibility(), GetSliceIntersectionVisibility(),
Deprecated:
SliceIntersectionVisibilityOff

◆ SliceIntersectionVisibilityOn()

void vtkMRMLDisplayNode::SliceIntersectionVisibilityOn ( )

Set the slice intersection visibility of the display node. Function to manage

See also
Visibility2D for backwards compatibility
Visibility2D, SetSliceIntersectionVisibility(), GetSliceIntersectionVisibility(),
Deprecated:
SliceIntersectionVisibilityOn

◆ TensorVisibilityOff()

virtual void vtkMRMLDisplayNode::TensorVisibilityOff ( )
virtual

◆ TensorVisibilityOn()

virtual void vtkMRMLDisplayNode::TensorVisibilityOn ( )
virtual

Set the tensor visibility of the display node.

See also
TensorVisibility, SetTensorVisibility(), GetTensorVisibility

◆ UpdateReferenceID()

void vtkMRMLDisplayNode::UpdateReferenceID ( const char *  oldID,
const char *  newID 
)
overridevirtual

Update the stored reference to another node in the scene.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLGlyphableVolumeSliceDisplayNode, and vtkMRMLGlyphableVolumeDisplayNode.

◆ UpdateReferences()

void vtkMRMLDisplayNode::UpdateReferences ( )
overridevirtual

Updates this node if it depends on other nodes when the node is deleted in the scene.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLGlyphableVolumeDisplayNode, vtkMRMLGlyphableVolumeSliceDisplayNode, and vtkMRMLVolumeDisplayNode.

◆ UpdateScene()

void vtkMRMLDisplayNode::UpdateScene ( vtkMRMLScene scene)
overridevirtual

◆ VectorVisibilityOff()

virtual void vtkMRMLDisplayNode::VectorVisibilityOff ( )
virtual

◆ VectorVisibilityOn()

virtual void vtkMRMLDisplayNode::VectorVisibilityOn ( )
virtual

Set the vector visibility of the display node.

See also
VectorVisibility, SetVectorVisibility(), GetVectorVisibility

◆ Visibility2DOff()

virtual void vtkMRMLDisplayNode::Visibility2DOff ( )
virtual

◆ Visibility2DOn()

virtual void vtkMRMLDisplayNode::Visibility2DOn ( )
virtual

Set the 2D visibility of the display node.

See also
Visibility2D, SetVisibility2D(), GetVisibility2D(),

◆ Visibility3DOff()

virtual void vtkMRMLDisplayNode::Visibility3DOff ( )
virtual

◆ Visibility3DOn()

virtual void vtkMRMLDisplayNode::Visibility3DOn ( )
virtual

Set the 3D visibility of the display node.

See also
Visibility3D, SetVisibility3D(), GetVisibility3D(),

◆ VisibilityOff()

virtual void vtkMRMLDisplayNode::VisibilityOff ( )
virtual

◆ VisibilityOn()

virtual void vtkMRMLDisplayNode::VisibilityOn ( )
virtual

Set the visibility of the display node.

See also
Visibility, SetVisibility(), GetVisibility(),

◆ WriteXML()

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

Member Data Documentation

◆ ActiveAttributeLocation

int vtkMRMLDisplayNode::ActiveAttributeLocation
protected

This property controls on which attribute the ActiveScalarName applies. Typically vtkAssignAttribute::POINT_DATA or vtkAssignAttribute::CELL_DATA. Default to vtkAssignAttribute::POINT_DATA

See also
SetActiveAttributeLocation(), GetActiveAttributeLocation(), ActiveScalarName

Definition at line 595 of file vtkMRMLDisplayNode.h.

◆ ActiveScalarName

char* vtkMRMLDisplayNode::ActiveScalarName
protected

Active vtkDataSetAttributes::Scalars field name for the ActiveAttributeLocation array. This is typically used to specify what field array is the color array that needs to be used by the VTK mappers. No active scalar name by default other than the default polydata.

See also
SetActiveScalarName(), GetActiveScalarName(), ActiveAttributeLocation

Definition at line 589 of file vtkMRMLDisplayNode.h.

◆ Ambient

double vtkMRMLDisplayNode::Ambient
protected

Ambient of the surface expressed as a number from 0 to 1. 0. by default.

See also
SetAmbient(), GetAmbient(), Color, SelectedAmbient, Diffuse, Specular, Power

Definition at line 611 of file vtkMRMLDisplayNode.h.

◆ BackfaceCulling

int vtkMRMLDisplayNode::BackfaceCulling
protected

Indicates whether to cull (not render) the backface of the surface. 1 by default.

See also
SetBackfaceCulling(), GetBackfaceCulling(), BackfaceCullingOn(), BackfaceCullingOff(), FrontfaceCulling, Visibility, Clipping

Definition at line 717 of file vtkMRMLDisplayNode.h.

◆ Clipping

int vtkMRMLDisplayNode::Clipping
protected

Specifies whether to clip the surface with the slice planes. 0 by default.

See also
SetClipping(), GetClipping(), ClippingOn(), ClippingOff() Visibility, EdgeVisibility, SliceIntersectionVisibility

Definition at line 698 of file vtkMRMLDisplayNode.h.

◆ Color

double vtkMRMLDisplayNode::Color[3]
protected

Model's color in the format [r,g,b]. Gray (0.5, 0.5, 0.5) by default.

See also
SetColor(), GetColor(), SelectedColor, EdgeColor, Ambient, Diffuse, Specular, Power, ColorNodeID

Definition at line 757 of file vtkMRMLDisplayNode.h.

◆ ColorNode

vtkMRMLColorNode* vtkMRMLDisplayNode::ColorNode
protected

Cached instance of the color node ID found in the scene. The node is observed and when modified, vtkMRMLDisplayNode fires a ModifiedEvent too.

See also
GetColorNode(), ProcessMRMLEvents() ColorNodeID

Definition at line 580 of file vtkMRMLDisplayNode.h.

◆ ColorNodeID

char* vtkMRMLDisplayNode::ColorNodeID
protected

String ID of the color MRML node. The color node LUT or Color transfer function is set to the VTK mappers. Note that anytime the color node is modified, the observing display node fires a Modified event. No color node by default.

See also
SetColorNodeID(), GetColorNodeID(), ColorNode

Definition at line 575 of file vtkMRMLDisplayNode.h.

◆ Diffuse

double vtkMRMLDisplayNode::Diffuse
protected

Diffuse of the surface expressed as a number from 0 to 1.

  1. by default.
    See also
    SetDiffuse(), GetDiffuse(), Color, Ambient, Specular, Power

Definition at line 616 of file vtkMRMLDisplayNode.h.

◆ EdgeColor

double vtkMRMLDisplayNode::EdgeColor[3]
protected

The property controls the color of primitive edges (if edge visibility is enabled). Black (0,0,0) by default.

See also
SetEdgeColor(), GetEdgeColor(), EdgeVisibility, Color, SelectedColor

Definition at line 763 of file vtkMRMLDisplayNode.h.

◆ EdgeVisibility

int vtkMRMLDisplayNode::EdgeVisibility
protected

This property controls the visibility of edges. On some renderers it is possible to render the edges of geometric primitives separately from the interior. 0 by default.

See also
SetEdgeVisibility(), GetEdgeVisibility(), EdgeColor, Visibility, SliceIntersectionVisibility

Definition at line 693 of file vtkMRMLDisplayNode.h.

◆ FolderDisplayOverrideAllowed

bool vtkMRMLDisplayNode::FolderDisplayOverrideAllowed
protected

Flag to determine whether folders are allowed to override display properties. On by default.

See also
GetFolderDisplayOverrideAllowed(), SetFolderDisplayOverrideAllowed()

Definition at line 791 of file vtkMRMLDisplayNode.h.

◆ FrontfaceCulling

int vtkMRMLDisplayNode::FrontfaceCulling
protected

Indicates whether to cull (not render) the frontface of the surface. 0 by default.

See also
SetFrontfaceCulling(), GetFrontfaceCulling(), FrontfaceCullingOn(), FrontfaceCullingOff(), BackfaceCulling, Visibility, Clipping

Definition at line 711 of file vtkMRMLDisplayNode.h.

◆ InterpolateTexture

int vtkMRMLDisplayNode::InterpolateTexture
protected

Indicates whether to use interpolate texture. Don't interpolate (0) by default.

See also
SetInterpolateTexture(), GetInterpolateTexture(), InterpolateTextureOn(), InterpolateTextureOff(), TextureImageDataConnection

Definition at line 744 of file vtkMRMLDisplayNode.h.

◆ Interpolation

int vtkMRMLDisplayNode::Interpolation
protected

Set the shading interpolation method for an object. Note that to use an interpolation other than FlatInterpolation, normals must be associated to the polydata (Gouraud and Phong are usually the same). GouraudInterpolation by default.

See also
SetInterpolation(), GetInterpolation(), Lighting

Definition at line 666 of file vtkMRMLDisplayNode.h.

◆ LastFoundDisplayableNode

vtkWeakPointer<vtkMRMLDisplayableNode> vtkMRMLDisplayNode::LastFoundDisplayableNode
protected

Cached value of last found displayable node (it is expensive to determine it)

Definition at line 794 of file vtkMRMLDisplayNode.h.

◆ Lighting

int vtkMRMLDisplayNode::Lighting
protected

This property controls the lighting. 1 by default.

See also
SetLighting(), GetLighting(), Interpolation, Shading

Definition at line 657 of file vtkMRMLDisplayNode.h.

◆ LineWidth

double vtkMRMLDisplayNode::LineWidth
protected

Width of a line. The width is expressed in screen units. The default is 1.0.

See also
SetLineWidth(), GetLineWidth(), PointSize

Definition at line 646 of file vtkMRMLDisplayNode.h.

◆ Opacity

double vtkMRMLDisplayNode::Opacity
protected

Opacity of the surface expressed as a number from 0 to 1. Opaque (1.) by default.

See also
SetOpacity(), GetOpacity(), Color, Visibility, Clipping

Definition at line 601 of file vtkMRMLDisplayNode.h.

◆ PointSize

double vtkMRMLDisplayNode::PointSize
protected

Diameter of a point. The size is expressed in screen units. The default is 1.0.

See also
SetPointSize(), GetPointSize(), LineWidth

Definition at line 641 of file vtkMRMLDisplayNode.h.

◆ Power

double vtkMRMLDisplayNode::Power
protected

Power of the surface specularity expressed as a number from 0 to 100.

  1. by default.
    See also
    SetPower(), GetPower(), Color, Ambient, Diffuse, Specular

Definition at line 626 of file vtkMRMLDisplayNode.h.

◆ Representation

int vtkMRMLDisplayNode::Representation
protected

Control the surface geometry representation for the object. SurfaceRepresentation by default.

See also
SetRepresentation(), GetRepresentation(), Interpolation

Definition at line 651 of file vtkMRMLDisplayNode.h.

◆ ScalarRange

double vtkMRMLDisplayNode::ScalarRange[2]
protected

Range of scalar values to render rather than the single color designated by colorName. [0, 100] by default.

See also
SetScalarRange(), GetScalarRange(), ScalarRangeFlag

Definition at line 751 of file vtkMRMLDisplayNode.h.

◆ ScalarRangeFlag

int vtkMRMLDisplayNode::ScalarRangeFlag
protected

A flag to determine which scalar range will be used when mapping scalars to colors. UseColorNodeScalarRange by default.

See also
ScalarRangeFlagType,GetScalarRangeFlag(), SetScalarRangeFlag(), ScalarRange, SetScalarRange(), GetScalarRange()

Definition at line 786 of file vtkMRMLDisplayNode.h.

◆ ScalarVisibility

int vtkMRMLDisplayNode::ScalarVisibility
protected

Indicates whether to render the scalar value associated with each polygon vertex. Hidden (0) by default.

See also
SetScalarVisibility(), GetScalarVisibility(), ScalarVisibilityOn(), ScalarVisibilityOff(), Visibility, VectorVisibility, TensorVisibility

Definition at line 724 of file vtkMRMLDisplayNode.h.

◆ SelectedAmbient

double vtkMRMLDisplayNode::SelectedAmbient
protected

Node's selected ambient. 0.4 by default.

See also
SetSelectedAmbient(), GetSelectedAmbient(), SelectedColor, Ambient, SelectedSpecular

Definition at line 631 of file vtkMRMLDisplayNode.h.

◆ SelectedColor

double vtkMRMLDisplayNode::SelectedColor[3]
protected

Node's selected ambient color (r,g,b). Red (1., 0., 0.) by default.

See also
SetSelectedColor(), GetSelectedColor(), Color, EdgeColor, SelectedAmbient, SelectedSpecular

Definition at line 768 of file vtkMRMLDisplayNode.h.

◆ SelectedSpecular

double vtkMRMLDisplayNode::SelectedSpecular
protected

Node's selected specular. 0.5 by default.

See also
SetSelectedSpecular(), GetSelectedSpecular(), SelectedColor, SelectedAmbient, Specular

Definition at line 636 of file vtkMRMLDisplayNode.h.

◆ Shading

int vtkMRMLDisplayNode::Shading
protected

This property controls whether the shading is enabled/disabled. 1 by default.

See also
SetShading(), GetShading(), Lighting

Definition at line 672 of file vtkMRMLDisplayNode.h.

◆ SliceIntersectionOpacity

double vtkMRMLDisplayNode::SliceIntersectionOpacity
protected

Opacity of the slice intersections expressed as a number from 0 to 1. Opaque (1.) by default.

See also
SetSliceIntersectionOpacity(), GetSliceIntersectionOpacity(), Color, Visibility, Clipping

Definition at line 606 of file vtkMRMLDisplayNode.h.

◆ SliceIntersectionThickness

int vtkMRMLDisplayNode::SliceIntersectionThickness
protected

Specifies how thick to show the intersections with slice planes if slice intersection visibility is on 1 voxel by default.

See also
SetSliceIntersectionVisibility(), GetSliceIntersectionVisibility(), SliceIntersectionVisibilityOn(), SliceIntersectionVisibilityOff(), Visibility, SliceIntersectionVisibility,

Definition at line 705 of file vtkMRMLDisplayNode.h.

◆ Specular

double vtkMRMLDisplayNode::Specular
protected

Specular of the surface expressed as a number from 0 to 1. 0. by default.

See also
SetSpecular(), GetSpecular(), Color, Ambient, Diffuse, Power

Definition at line 621 of file vtkMRMLDisplayNode.h.

◆ TensorVisibility

int vtkMRMLDisplayNode::TensorVisibility
protected

Indicates whether to render the tensor value associated with each polygon vertex. Hidden (0) by default.

See also
SetTensorVisibility(), GetTensorVisibility(), TensorVisibilityOn(), TensorVisibilityOff(), Visibility, ScalarVisibility, VectorVisibility

Definition at line 738 of file vtkMRMLDisplayNode.h.

◆ TextureImageDataConnection

vtkAlgorithmOutput* vtkMRMLDisplayNode::TextureImageDataConnection
protected

Associated ImageDataConnection to apply as texture. The image data port is observed and when modified, vtkMRMLDisplayNode fires a ModifiedEvent too. No texture (nullptr) by default.

See also
SetTextureImageDataConnection(), GetTextureImageDataConnection() InterpolateTexture

Definition at line 566 of file vtkMRMLDisplayNode.h.

◆ VectorVisibility

int vtkMRMLDisplayNode::VectorVisibility
protected

Indicates whether to render the vector value associated with each polygon vertex. Hidden (0) by default.

See also
SetVectorVisibility(), GetVectorVisibility(), VectorVisibilityOn(), VectorVisibilityOff(), Visibility, ScalarVisibility, TensorVisibility

Definition at line 731 of file vtkMRMLDisplayNode.h.

◆ ViewNodeIDs

std::vector< std::string > vtkMRMLDisplayNode::ViewNodeIDs
protected

List of view node ID's for which the display node should be visible into. If the list is empty, it means the display node should be visible in all the view nodes. The displayable managers are responsible for reading this property. Visible in all views (empty) by default.

See also
AddViewNodeID(), RemoveViewNodeID(), RemoveAllViewNodeIDs(), GetNumberOfViewNodeIDs(), GetViewNodeIDs(), IsViewNodeIDPresent(), IsDisplayableInView(), vtkMRMLAbstractDisplayableManager

Definition at line 779 of file vtkMRMLDisplayNode.h.

◆ Visibility

int vtkMRMLDisplayNode::Visibility
protected

Indicates if the surface is visible. True by default.

See also
SetVisibility(), GetVisibility(), VisibilityOn(), VisibilityOff() Color, Opacity, Clipping, EdgeVisibility, SliceIntersectionVisibility

Definition at line 678 of file vtkMRMLDisplayNode.h.

◆ Visibility2D

int vtkMRMLDisplayNode::Visibility2D
protected

Indicates whether the object is visible in the slice views. True by default. In order to show 2D, both this and

See also
Visibility needs to be enabled.
SetVisibility2D(), GetVisibility2D(), Visibility2DOn(), Visibility2DOff()

Definition at line 682 of file vtkMRMLDisplayNode.h.

◆ Visibility3D

int vtkMRMLDisplayNode::Visibility3D
protected

Indicates whether the object is visible in the 3D views. True by default. In order to show 3D, both this and

See also
Visibility needs to be enabled.
SetVisibility3D(), GetVisibility3D(), Visibility3DOn(), Visibility3DOff()

Definition at line 686 of file vtkMRMLDisplayNode.h.


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