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

MRML node to store display properties of slice nodes. More...

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

Inheritance diagram for vtkMRMLSliceDisplayNode:
Inheritance graph
Collaboration diagram for vtkMRMLSliceDisplayNode:
Collaboration graph


struct  ComponentInfo

Public Types

enum  ComponentType {
  ComponentNone = 0, ComponentTranslateIntersectingSlicesHandle, ComponentRotateIntersectingSlicesHandle, ComponentTranslateSingleIntersectingSliceHandle,
  ComponentSliceIntersection, Component_Last
enum  HandlesVisibilityMode { NeverVisible = 0, NearbyVisible, AlwaysVisible, HandlesVisibilityMode_Last }
enum  IntersectingSlicesInteractiveMode { ModeRotation, ModeTranslation }
enum  IntersectionMode { SkipLineCrossings = 0, FullLines, IntersectionMode_Last }
enum  LineThicknessMode { FineLines = 0, MediumLines, ThickLines, LineThicknessMode_Last }
typedef vtkMRMLModelDisplayNode Superclass
- Public Types inherited from vtkMRMLModelDisplayNode
enum  SliceDisplayModeType { SliceDisplayIntersection, SliceDisplayProjection, SliceDisplayDistanceEncodedProjection, SliceDisplayMode_Last }
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...
int GetActiveComponentIndex (std::string context=vtkMRMLSliceDisplayNode::GetDefaultContextName())
std::vector< std::string > GetActiveComponentInteractionContexts ()
int GetActiveComponentType (std::string context=vtkMRMLSliceDisplayNode::GetDefaultContextName())
virtual const char * GetClassName ()
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Model) More...
bool HasActiveComponent ()
 Query if there is an active component for any interaction context. More...
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent) override
void ReadXMLAttributes (const char **atts) override
 Read node attributes from XML file. More...
void SetActiveComponent (int componentType, int componentIndex, std::string context=vtkMRMLSliceDisplayNode::GetDefaultContextName())
 Set active component type and index for interaction context (empty by default, meaning mouse) More...
 vtkMRMLCopyContentMacro (vtkMRMLSliceDisplayNode)
void WriteXML (ostream &of, int indent) override
 Write this node's information to a MRML file in XML format. More...
bool GetIntersectingSlicesVisibility ()
 Toggles visibility of intersections of other slices in the slice viewer. More...
void SetIntersectingSlicesVisibility (bool visible)
virtual void IntersectingSlicesVisibilityOn ()
virtual void IntersectingSlicesVisibilityOff ()
virtual bool GetIntersectingSlicesInteractive ()
 Toggles interaction with slice intersections. More...
virtual void SetIntersectingSlicesInteractive (bool)
virtual void IntersectingSlicesInteractiveOn ()
virtual void IntersectingSlicesInteractiveOff ()
virtual bool GetIntersectingSlicesTranslationEnabled ()
 Enable/disable interaction handles. More...
virtual void SetIntersectingSlicesTranslationEnabled (bool)
virtual void IntersectingSlicesTranslationEnabledOn ()
virtual void IntersectingSlicesTranslationEnabledOff ()
virtual bool GetIntersectingSlicesRotationEnabled ()
virtual void SetIntersectingSlicesRotationEnabled (bool)
virtual void IntersectingSlicesRotationEnabledOn ()
virtual void IntersectingSlicesRotationEnabledOff ()
void SetIntersectingSlicesInteractiveModeEnabled (IntersectingSlicesInteractiveMode mode, bool enabled)
bool GetIntersectingSlicesInteractiveModeEnabled (IntersectingSlicesInteractiveMode mode)
virtual int GetIntersectingSlicesInteractiveHandlesVisibilityMode ()
virtual void SetIntersectingSlicesInteractiveHandlesVisibilityMode (int)
virtual int GetIntersectingSlicesIntersectionMode ()
virtual void SetIntersectingSlicesIntersectionMode (int)
virtual int GetIntersectingSlicesLineThicknessMode ()
virtual void SetIntersectingSlicesLineThicknessMode (int)
- Public Member Functions inherited from vtkMRMLModelDisplayNode
virtual vtkDataArray * GetActiveScalarArray () override
 Return the current active scalar array (based on active scalar name and location) More...
virtual double * GetBackfaceColorHSVOffset ()
virtual void GetBackfaceColorHSVOffset (double &, double &, double &)
virtual void GetBackfaceColorHSVOffset (double [3])
virtual vtkMRMLColorNodeGetDistanceEncodedProjectionColorNode ()
virtual const char * GetDistanceEncodedProjectionColorNodeID ()
virtual vtkPointSet * GetInputMesh ()
virtual vtkAlgorithmOutput * GetInputMeshConnection ()
virtual vtkPolyData * GetInputPolyData ()
virtual vtkAlgorithmOutput * GetInputPolyDataConnection ()
virtual vtkUnstructuredGrid * GetInputUnstructuredGrid ()
virtual vtkPointSet * GetOutputMesh ()
virtual vtkAlgorithmOutput * GetOutputMeshConnection ()
virtual vtkPolyData * GetOutputPolyData ()
virtual vtkAlgorithmOutput * GetOutputPolyDataConnection ()
virtual vtkUnstructuredGrid * GetOutputUnstructuredGrid ()
virtual vtkDataSet * GetScalarDataSet () override
virtual int GetSliceDisplayMode ()
virtual bool GetThresholdEnabled ()
double GetThresholdMax ()
double GetThresholdMin ()
void GetThresholdRange (double range[2])
double * GetThresholdRange ()
void PrintSelf (ostream &os, vtkIndent indent) override
void SetActiveAttributeLocation (int location) override
void SetActiveScalarName (const char *scalarName) override
virtual void SetAndObserveDistanceEncodedProjectionColorNodeID (const char *colorNodeID)
virtual void SetBackfaceColorHSVOffset (double [3])
virtual void SetBackfaceColorHSVOffset (double, double, double)
virtual void SetInputMeshConnection (vtkAlgorithmOutput *meshConnection)
virtual void SetInputPolyDataConnection (vtkAlgorithmOutput *polyDataConnection)
virtual void SetSliceDisplayMode (int)
void SetSliceDisplayModeToDistanceEncodedProjection ()
void SetSliceDisplayModeToIntersection ()
void SetSliceDisplayModeToProjection ()
void SetThresholdEnabled (bool enabled)
void SetThresholdRange (double min, double max)
void SetThresholdRange (double range[2])
virtual void ThresholdEnabledOff ()
virtual void ThresholdEnabledOn ()
 vtkMRMLCopyContentMacro (vtkMRMLModelDisplayNode)
- 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 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 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 ()
void SetActiveAttributeLocationFromString (const char *str)
virtual void SetActiveScalar (const char *scalarName, int location)
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 ()
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 const std::string GetDefaultContextName ()
 Get name of the default interaction context (typically the mouse) More...
static int IsTypeOf (const char *type)
static vtkMRMLSliceDisplayNodeNew ()
static vtkMRMLSliceDisplayNodeSafeDownCast (vtkObject *o)
static const char * GetIntersectingSlicesInteractiveHandlesVisibilityModeAsString (int id)
 Convert between intersecting slices interactive handles visibility mode ID and string. More...
static int GetIntersectingSlicesInteractiveHandlesVisibilityModeFromString (const char *)
static const char * GetIntersectingSlicesIntersectionModeAsString (int id)
 Convert between intersecting slices intersection mode ID and string. More...
static int GetIntersectingSlicesIntersectionModeFromString (const char *)
static const char * GetIntersectingSlicesLineThicknessModeAsString (int id)
static int GetIntersectingSlicesLineThicknessModeFromString (const char *)
- Static Public Member Functions inherited from vtkMRMLModelDisplayNode
static const char * GetSliceDisplayModeAsString (int id)
 Convert between slice display mode ID and name. More...
static int GetSliceDisplayModeFromString (const char *name)
static int IsTypeOf (const char *type)
static vtkMRMLModelDisplayNodeNew ()
static vtkMRMLModelDisplayNodeSafeDownCast (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 vtkMRMLSliceDisplayNode &)
 vtkMRMLSliceDisplayNode ()
 vtkMRMLSliceDisplayNode (const vtkMRMLSliceDisplayNode &)
 ~vtkMRMLSliceDisplayNode () override
- Protected Member Functions inherited from vtkMRMLModelDisplayNode
void operator= (const vtkMRMLModelDisplayNode &)
void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
virtual void SetInputToMeshPipeline (vtkAlgorithmOutput *meshConnection)
 To be reimplemented in subclasses if the input of the pipeline changes. More...
virtual void UpdateAssignedAttribute () override
 vtkMRMLModelDisplayNode ()
 vtkMRMLModelDisplayNode (const vtkMRMLModelDisplayNode &)
 ~vtkMRMLModelDisplayNode () override
- 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...

Protected Attributes

std::map< std::string, ComponentInfoActiveComponents
bool IntersectingSlicesInteractive { false }
int IntersectingSlicesInteractiveHandlesVisibilityMode { NeverVisible }
int IntersectingSlicesIntersectionMode { FullLines }
int IntersectingSlicesLineThicknessMode { FineLines }
bool IntersectingSlicesRotationEnabled { true }
bool IntersectingSlicesTranslationEnabled { true }
- Protected Attributes inherited from vtkMRMLModelDisplayNode
vtkAssignAttribute * AssignAttribute
double BackfaceColorHSVOffset [3]
vtkGeometryFilter * ConvertToPolyDataFilter
vtkPassThrough * PassThrough
int SliceDisplayMode
bool ThresholdEnabled
vtkThreshold * ThresholdFilter
double ThresholdRangeTemp [2]
 Temporary variable to allow GetThresholdRange() method to return threshold range as a pointer. More...
- 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}

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

Detailed Description

MRML node to store display properties of slice nodes.

This node controls appearance of slice intersections in slice views and slices in 3D views.

Definition at line 28 of file vtkMRMLSliceDisplayNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 32 of file vtkMRMLSliceDisplayNode.h.

Member Enumeration Documentation

◆ ComponentType


no component of the slice or slice intersection widget is active


mouse is near the intersection point of slice intersections


mouse is near the end of the slice intersection (rotation section)


mouse is near the middle of the slice intersection (translation section)


slice intersection is active (not any handle), e.g., because user is interacting with the widget


Definition at line 154 of file vtkMRMLSliceDisplayNode.h.

◆ HandlesVisibilityMode


Handles are never displayed.


Handles are displayed when mouse pointer gets close.


Handles are always visible.


Definition at line 87 of file vtkMRMLSliceDisplayNode.h.

◆ IntersectingSlicesInteractiveMode


Definition at line 74 of file vtkMRMLSliceDisplayNode.h.

◆ IntersectionMode


Lines do not intersect and there is a gap around the intersection point.


Lines intersect.


Definition at line 109 of file vtkMRMLSliceDisplayNode.h.

◆ LineThicknessMode


Thin lines.


Medium lines.


Thick lines.


Definition at line 129 of file vtkMRMLSliceDisplayNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLSliceDisplayNode() [1/2]

vtkMRMLSliceDisplayNode::vtkMRMLSliceDisplayNode ( )

◆ ~vtkMRMLSliceDisplayNode()

vtkMRMLSliceDisplayNode::~vtkMRMLSliceDisplayNode ( )

◆ vtkMRMLSliceDisplayNode() [2/2]

vtkMRMLSliceDisplayNode::vtkMRMLSliceDisplayNode ( const vtkMRMLSliceDisplayNode )

Member Function Documentation

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLSliceDisplayNode::CreateNodeInstance ( )

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

Subclasses should implement this method

Reimplemented from vtkMRMLModelDisplayNode.

◆ GetActiveComponentIndex()

int vtkMRMLSliceDisplayNode::GetActiveComponentIndex ( std::string  context = vtkMRMLSliceDisplayNode::GetDefaultContextName())

Index of active component (that the mouse or other interaction context is hovered over). This property is computed on-the-fly and saved to file.

contextName of the interaction context. By default it is empty string, meaning mouse

◆ GetActiveComponentInteractionContexts()

std::vector<std::string> vtkMRMLSliceDisplayNode::GetActiveComponentInteractionContexts ( )

Get list of interaction context names that have active components

List of interaction context names that have active components

◆ GetActiveComponentType()

int vtkMRMLSliceDisplayNode::GetActiveComponentType ( std::string  context = vtkMRMLSliceDisplayNode::GetDefaultContextName())

Active component (that the mouse or other interaction context is hovered over). This property is computed on-the-fly and saved to file.

contextName of the interaction context. By default it is empty string, meaning mouse. Additional devices, such as virtual reality controllers can specify additional context names. This mechanism allows interacting with multiple markups at the same time (user can grab different markup points with each controller at the same time).
See also

◆ GetClassName()

virtual const char* vtkMRMLSliceDisplayNode::GetClassName ( )

Reimplemented from vtkMRMLModelDisplayNode.

◆ GetDefaultContextName()

static const std::string vtkMRMLSliceDisplayNode::GetDefaultContextName ( )

Get name of the default interaction context (typically the mouse)

Definition at line 152 of file vtkMRMLSliceDisplayNode.h.

◆ GetIntersectingSlicesInteractive()

virtual bool vtkMRMLSliceDisplayNode::GetIntersectingSlicesInteractive ( )

Toggles interaction with slice intersections.

◆ GetIntersectingSlicesInteractiveHandlesVisibilityMode()

virtual int vtkMRMLSliceDisplayNode::GetIntersectingSlicesInteractiveHandlesVisibilityMode ( )

Get/Set interaction handles visibility mode.

See also

◆ GetIntersectingSlicesInteractiveHandlesVisibilityModeAsString()

static const char* vtkMRMLSliceDisplayNode::GetIntersectingSlicesInteractiveHandlesVisibilityModeAsString ( int  id)

Convert between intersecting slices interactive handles visibility mode ID and string.

◆ GetIntersectingSlicesInteractiveHandlesVisibilityModeFromString()

static int vtkMRMLSliceDisplayNode::GetIntersectingSlicesInteractiveHandlesVisibilityModeFromString ( const char *  )

◆ GetIntersectingSlicesInteractiveModeEnabled()

bool vtkMRMLSliceDisplayNode::GetIntersectingSlicesInteractiveModeEnabled ( IntersectingSlicesInteractiveMode  mode)

◆ GetIntersectingSlicesIntersectionMode()

virtual int vtkMRMLSliceDisplayNode::GetIntersectingSlicesIntersectionMode ( )

Get/set intersection mode.

See also

◆ GetIntersectingSlicesIntersectionModeAsString()

static const char* vtkMRMLSliceDisplayNode::GetIntersectingSlicesIntersectionModeAsString ( int  id)

Convert between intersecting slices intersection mode ID and string.

◆ GetIntersectingSlicesIntersectionModeFromString()

static int vtkMRMLSliceDisplayNode::GetIntersectingSlicesIntersectionModeFromString ( const char *  )

◆ GetIntersectingSlicesLineThicknessMode()

virtual int vtkMRMLSliceDisplayNode::GetIntersectingSlicesLineThicknessMode ( )

Get/set line thickness mode.

See also

◆ GetIntersectingSlicesLineThicknessModeAsString()

static const char* vtkMRMLSliceDisplayNode::GetIntersectingSlicesLineThicknessModeAsString ( int  id)

Convert between intersecting slices line thickness mode ID and string

See also

◆ GetIntersectingSlicesLineThicknessModeFromString()

static int vtkMRMLSliceDisplayNode::GetIntersectingSlicesLineThicknessModeFromString ( const char *  )

◆ GetIntersectingSlicesRotationEnabled()

virtual bool vtkMRMLSliceDisplayNode::GetIntersectingSlicesRotationEnabled ( )

◆ GetIntersectingSlicesTranslationEnabled()

virtual bool vtkMRMLSliceDisplayNode::GetIntersectingSlicesTranslationEnabled ( )

Enable/disable interaction handles.

◆ GetIntersectingSlicesVisibility()

bool vtkMRMLSliceDisplayNode::GetIntersectingSlicesVisibility ( )

Toggles visibility of intersections of other slices in the slice viewer.

Definition at line 52 of file vtkMRMLSliceDisplayNode.h.

◆ GetNodeTagName()

const char* vtkMRMLSliceDisplayNode::GetNodeTagName ( )

Get node XML tag name (like Volume, Model)

Reimplemented from vtkMRMLModelDisplayNode.

Definition at line 48 of file vtkMRMLSliceDisplayNode.h.

◆ HasActiveComponent()

bool vtkMRMLSliceDisplayNode::HasActiveComponent ( )

Query if there is an active component for any interaction context.

◆ IntersectingSlicesInteractiveOff()

virtual void vtkMRMLSliceDisplayNode::IntersectingSlicesInteractiveOff ( )

◆ IntersectingSlicesInteractiveOn()

virtual void vtkMRMLSliceDisplayNode::IntersectingSlicesInteractiveOn ( )

◆ IntersectingSlicesRotationEnabledOff()

virtual void vtkMRMLSliceDisplayNode::IntersectingSlicesRotationEnabledOff ( )

◆ IntersectingSlicesRotationEnabledOn()

virtual void vtkMRMLSliceDisplayNode::IntersectingSlicesRotationEnabledOn ( )

◆ IntersectingSlicesTranslationEnabledOff()

virtual void vtkMRMLSliceDisplayNode::IntersectingSlicesTranslationEnabledOff ( )

◆ IntersectingSlicesTranslationEnabledOn()

virtual void vtkMRMLSliceDisplayNode::IntersectingSlicesTranslationEnabledOn ( )

◆ IntersectingSlicesVisibilityOff()

virtual void vtkMRMLSliceDisplayNode::IntersectingSlicesVisibilityOff ( )

◆ IntersectingSlicesVisibilityOn()

virtual void vtkMRMLSliceDisplayNode::IntersectingSlicesVisibilityOn ( )

◆ IsA()

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

Reimplemented from vtkMRMLModelDisplayNode.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLSliceDisplayNode* vtkMRMLSliceDisplayNode::New ( )

◆ operator=()

void vtkMRMLSliceDisplayNode::operator= ( const vtkMRMLSliceDisplayNode )

◆ PrintSelf()

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

◆ ReadXMLAttributes()

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

Read node attributes from XML file.

Reimplemented from vtkMRMLModelDisplayNode.

◆ SafeDownCast()

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

◆ SetActiveComponent()

void vtkMRMLSliceDisplayNode::SetActiveComponent ( int  componentType,
int  componentIndex,
std::string  context = vtkMRMLSliceDisplayNode::GetDefaultContextName() 

Set active component type and index for interaction context (empty by default, meaning mouse)

◆ SetIntersectingSlicesInteractive()

virtual void vtkMRMLSliceDisplayNode::SetIntersectingSlicesInteractive ( bool  )

◆ SetIntersectingSlicesInteractiveHandlesVisibilityMode()

virtual void vtkMRMLSliceDisplayNode::SetIntersectingSlicesInteractiveHandlesVisibilityMode ( int  )

◆ SetIntersectingSlicesInteractiveModeEnabled()

void vtkMRMLSliceDisplayNode::SetIntersectingSlicesInteractiveModeEnabled ( IntersectingSlicesInteractiveMode  mode,
bool  enabled 

◆ SetIntersectingSlicesIntersectionMode()

virtual void vtkMRMLSliceDisplayNode::SetIntersectingSlicesIntersectionMode ( int  )

◆ SetIntersectingSlicesLineThicknessMode()

virtual void vtkMRMLSliceDisplayNode::SetIntersectingSlicesLineThicknessMode ( int  )

◆ SetIntersectingSlicesRotationEnabled()

virtual void vtkMRMLSliceDisplayNode::SetIntersectingSlicesRotationEnabled ( bool  )

◆ SetIntersectingSlicesTranslationEnabled()

virtual void vtkMRMLSliceDisplayNode::SetIntersectingSlicesTranslationEnabled ( bool  )

◆ SetIntersectingSlicesVisibility()

void vtkMRMLSliceDisplayNode::SetIntersectingSlicesVisibility ( bool  visible)

Definition at line 53 of file vtkMRMLSliceDisplayNode.h.

◆ vtkMRMLCopyContentMacro()

vtkMRMLSliceDisplayNode::vtkMRMLCopyContentMacro ( vtkMRMLSliceDisplayNode  )

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

See also

◆ WriteXML()

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

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

Reimplemented from vtkMRMLModelDisplayNode.

Member Data Documentation

◆ ActiveComponents

std::map<std::string, ComponentInfo> vtkMRMLSliceDisplayNode::ActiveComponents

Current active point or widget component type and index (hovered by the mouse or other interaction context) Map interaction context identifier (empty string for mouse) to component type enum

Definition at line 218 of file vtkMRMLSliceDisplayNode.h.

◆ IntersectingSlicesInteractive

bool vtkMRMLSliceDisplayNode::IntersectingSlicesInteractive { false }

Definition at line 206 of file vtkMRMLSliceDisplayNode.h.

◆ IntersectingSlicesInteractiveHandlesVisibilityMode

int vtkMRMLSliceDisplayNode::IntersectingSlicesInteractiveHandlesVisibilityMode { NeverVisible }

Definition at line 210 of file vtkMRMLSliceDisplayNode.h.

◆ IntersectingSlicesIntersectionMode

int vtkMRMLSliceDisplayNode::IntersectingSlicesIntersectionMode { FullLines }

Definition at line 212 of file vtkMRMLSliceDisplayNode.h.

◆ IntersectingSlicesLineThicknessMode

int vtkMRMLSliceDisplayNode::IntersectingSlicesLineThicknessMode { FineLines }

Definition at line 214 of file vtkMRMLSliceDisplayNode.h.

◆ IntersectingSlicesRotationEnabled

bool vtkMRMLSliceDisplayNode::IntersectingSlicesRotationEnabled { true }

Definition at line 208 of file vtkMRMLSliceDisplayNode.h.

◆ IntersectingSlicesTranslationEnabled

bool vtkMRMLSliceDisplayNode::IntersectingSlicesTranslationEnabled { true }

Definition at line 207 of file vtkMRMLSliceDisplayNode.h.

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