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 | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes
vtkMRMLAbstractViewNode Class Reference

Abstract MRML node to represent a view. The class holds the properties common to any view type (3D, slice, chart..) Views are not hidden from editors by default (HideFromEditor is 0) More...

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

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

Public Types

enum  OrientationMarkerSizeType { OrientationMarkerSizeSmall =0, OrientationMarkerSizeMedium, OrientationMarkerSizeLarge, OrientationMarkerSize_Last }
 
enum  OrientationMarkerTypeType {
  OrientationMarkerTypeNone =0, OrientationMarkerTypeCube, OrientationMarkerTypeHuman, OrientationMarkerTypeAxes,
  OrientationMarkerType_Last
}
 Enum to specify orientation marker types. More...
 
enum  RulerColorType { RulerColorWhite =0, RulerColorBlack, RulerColorYellow, RulerColor_Last }
 Enum to specify ruler colors. More...
 
enum  RulerTypeType { RulerTypeNone =0, RulerTypeThin, RulerTypeThick, RulerType_Last }
 Enum to specify ruler types. More...
 
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

void Copy (vtkMRMLNode *node) override
 Copy the node's attributes to this object. More...
 
virtual int GetActive ()
 Indicates whether or not the view is active. More...
 
const char * GetAxisLabel (int labelIndex)
 
virtual double * GetBackgroundColor ()
 
virtual void GetBackgroundColor (double &, double &, double &)
 
virtual void GetBackgroundColor (double [3])
 
virtual double * GetBackgroundColor2 ()
 
virtual void GetBackgroundColor2 (double &, double &, double &)
 
virtual void GetBackgroundColor2 (double [3])
 
virtual const char * GetClassName ()
 
vtkMRMLInteractionNodeGetInteractionNode ()
 Get interaction node. More...
 
virtual double * GetLayoutColor ()
 
virtual void GetLayoutColor (double &, double &, double &)
 
virtual void GetLayoutColor (double [3])
 
virtual char * GetLayoutLabel ()
 
const char * GetLayoutName ()
 
virtual bool GetOrientationMarkerEnabled ()
 
vtkMRMLModelNodeGetOrientationMarkerHumanModelNode ()
 
const char * GetOrientationMarkerHumanModelNodeID ()
 
virtual int GetOrientationMarkerSize ()
 
virtual int GetOrientationMarkerType ()
 
vtkMRMLNodeGetParentLayoutNode ()
 
virtual int GetRulerColor ()
 
virtual bool GetRulerEnabled ()
 
virtual int GetRulerType ()
 
virtual int GetViewGroup ()
 
virtual int GetVisibility ()
 Indicates whether or not the view is visible. More...
 
virtual int IsA (const char *type)
 
virtual int IsMappedInLayout ()
 
bool IsViewVisibleInLayout ()
 Indicates whether or not the view is visible in the current layout. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ReadXMLAttributes (const char **atts) override
 MRMLNode methods. More...
 
void Reset (vtkMRMLNode *defaultNode) override
 Reimplemented to preserve layout label when reset. More...
 
virtual void SetActive (int)
 
bool SetAndObserveParentLayoutNode (vtkMRMLNode *node)
 
bool SetAndObserveParentLayoutNodeID (const char *layoutNodeId)
 
void SetAxisLabel (int labelIndex, const char *label)
 
virtual void SetBackgroundColor (double [3])
 
virtual void SetBackgroundColor (double, double, double)
 
virtual void SetBackgroundColor2 (double, double, double)
 
virtual void SetBackgroundColor2 (double [3])
 
bool SetInteractionNode (vtkMRMLNode *node)
 
bool SetInteractionNodeID (const char *interactionNodeId)
 
virtual void SetLayoutColor (double, double, double)
 
virtual void SetLayoutColor (double [3])
 
virtual void SetLayoutLabel (const char *)
 
void SetLayoutName (const char *layoutName)
 
virtual void SetMappedInLayout (int value)
 
void SetOrientationMarkerHumanModelNodeID (const char *modelNodeId)
 
virtual void SetOrientationMarkerSize (int)
 Get/Set orientation marker is size. There are a few predefined marker sizes, defined by an enumerated value (e.g., small, medium, large). More...
 
virtual void SetOrientationMarkerType (int)
 Get/Set orientation marker type (e.g., not displayed, cube, human, coordinate system axes) More...
 
virtual void SetRulerColor (int)
 Get/Set ruler color (e.g., white or black) More...
 
virtual void SetRulerType (int)
 Get/Set ruler type (e.g., not displayed, thin, thick) More...
 
virtual void SetViewGroup (int)
 
virtual void SetVisibility (int)
 
void WriteXML (ostream &of, int indent) override
 Write this node's information to a MRML file in XML format. More...
 
- 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...
 
virtual void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
 Propagate events generated in mrml. More...
 
void RemoveAttribute (const char *name)
 Remove attribute with the specified name. More...
 
void RemoveNodeReferenceIDs (const char *referenceRole)
 Remove all node IDs and associated nodes for a specific referenceRole. More...
 
void RemoveNthNodeReferenceID (const char *referenceRole, int n)
 Convenience method that removes the Nth node ID from the list. More...
 
virtual void SaveWithSceneOff ()
 
virtual void SaveWithSceneOn ()
 
virtual void SelectableOff ()
 
virtual void SelectableOn ()
 
virtual void SelectedOff ()
 
virtual void SelectedOn ()
 
virtual void SetAddToScene (int)
 
void SetAddToSceneNoModify (int value)
 
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 SetSceneReferences ()
 Update the references of the node to the scene. More...
 
virtual void SetSelectable (int)
 
virtual void SetSelected (int)
 
void SetSingletonOff ()
 
void SetSingletonOn ()
 
virtual void SetSingletonTag (const char *)
 Tag that make this node a singleton in the scene. More...
 
virtual void SetUndoEnabled (bool)
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events. More...
 
virtual void UndoEnabledOff ()
 
virtual void UndoEnabledOn ()
 
virtual void UpdateReferenceID (const char *oldID, const char *newID)
 Update the stored reference to another node in the scene. More...
 
virtual void UpdateReferences ()
 The method should remove all pointers and observations to all nodes that are not in the scene anymore. More...
 
virtual void UpdateScene (vtkMRMLScene *)
 
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 double * GetCompareColor ()
 
static double * GetGrayColor ()
 
static double * GetGreenColor ()
 
static const char * GetOrientationMarkerSizeAsString (int id)
 Convert between orientation marker type ID and name. More...
 
static int GetOrientationMarkerSizeFromString (const char *name)
 
static const char * GetOrientationMarkerTypeAsString (int id)
 Convert between orientation marker type ID and name. More...
 
static int GetOrientationMarkerTypeFromString (const char *name)
 
static double * GetRedColor ()
 
static const char * GetRulerColorAsString (int id)
 Convert between ruler color ID and name. More...
 
static int GetRulerColorFromString (const char *name)
 
static const char * GetRulerTypeAsString (int id)
 Convert between ruler type ID and name. More...
 
static int GetRulerTypeFromString (const char *name)
 
static double * GetThreeDViewBlueColor ()
 
static double * GetYellowColor ()
 
static int IsTypeOf (const char *type)
 
static vtkMRMLAbstractViewNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Static Public Attributes

static const int AxisLabelsCount
 Total number of coordinate system axis labels. More...
 

Protected Member Functions

void operator= (const vtkMRMLAbstractViewNode &)
 
 vtkMRMLAbstractViewNode ()
 
 vtkMRMLAbstractViewNode (const vtkMRMLAbstractViewNode &)
 
 ~vtkMRMLAbstractViewNode () 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 Active
 
vtkSmartPointer< vtkStringArray > AxisLabels
 
Labels of coordinate system axes More...
 
double BackgroundColor [3]
 
Background colors More...
 
double BackgroundColor2 [3]
 
double LayoutColor [3]
 
Color for view header in layout as RGB More...
 
char * LayoutLabel
 
Label to show for the view (shortcut for the name) More...
 
bool OrientationMarkerEnabled
 
int OrientationMarkerSize
 
int OrientationMarkerType
 
int RulerColor
 
bool RulerEnabled
 
int RulerType
 
int ViewGroup
 
Views with the same ViewGroup value are in the same group. More...
 
int Visibility
 
- 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
 

Static Protected Attributes

static const char * InteractionNodeReferenceRole
 
static const char * OrientationMarkerHumanModelReferenceRole
 
static const char * ParentLayoutNodeReferenceRole
 

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 MRML node to represent a view. The class holds the properties common to any view type (3D, slice, chart..) Views are not hidden from editors by default (HideFromEditor is 0)

Definition at line 37 of file vtkMRMLAbstractViewNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkMRMLAbstractViewNode.h.

Member Enumeration Documentation

◆ OrientationMarkerSizeType

Enumerator
OrientationMarkerSizeSmall 
OrientationMarkerSizeMedium 
OrientationMarkerSizeLarge 
OrientationMarkerSize_Last 

Definition at line 221 of file vtkMRMLAbstractViewNode.h.

◆ OrientationMarkerTypeType

Enum to specify orientation marker types.

Enumerator
OrientationMarkerTypeNone 
OrientationMarkerTypeCube 
OrientationMarkerTypeHuman 
OrientationMarkerTypeAxes 
OrientationMarkerType_Last 

Definition at line 212 of file vtkMRMLAbstractViewNode.h.

◆ RulerColorType

Enum to specify ruler colors.

Enumerator
RulerColorWhite 
RulerColorBlack 
RulerColorYellow 
RulerColor_Last 

Definition at line 259 of file vtkMRMLAbstractViewNode.h.

◆ RulerTypeType

Enum to specify ruler types.

Enumerator
RulerTypeNone 
RulerTypeThin 
RulerTypeThick 
RulerType_Last 

Definition at line 242 of file vtkMRMLAbstractViewNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLAbstractViewNode() [1/2]

vtkMRMLAbstractViewNode::vtkMRMLAbstractViewNode ( )
protected

◆ ~vtkMRMLAbstractViewNode()

vtkMRMLAbstractViewNode::~vtkMRMLAbstractViewNode ( )
overrideprotected

◆ vtkMRMLAbstractViewNode() [2/2]

vtkMRMLAbstractViewNode::vtkMRMLAbstractViewNode ( const vtkMRMLAbstractViewNode )
protected

Member Function Documentation

◆ Copy()

void vtkMRMLAbstractViewNode::Copy ( vtkMRMLNode node)
overridevirtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLPlotViewNode, vtkMRMLSliceNode, vtkMRMLTableViewNode, vtkMRMLChartViewNode, and vtkMRMLViewNode.

◆ GetActive()

virtual int vtkMRMLAbstractViewNode::GetActive ( )
virtual

Indicates whether or not the view is active.

◆ GetAxisLabel()

const char* vtkMRMLAbstractViewNode::GetAxisLabel ( int  labelIndex)

Get/Set labels of coordinate system axes. Order of labels: -X, +X, -Y, +Y, -Z, +Z. Default: L, R, P, A, I, S Note that these labels are used for display only (for example, showing organ specific directions, such as "Temporal" and "Nasal" instead of "Left" and "Right"). Therefore, changing labels will not change orientation of displayed data in the view.

◆ GetBackgroundColor() [1/3]

virtual double* vtkMRMLAbstractViewNode::GetBackgroundColor ( )
virtual

1st background color of the view. Black (0,0,0) by default.

See also
SetBackgroundColor2()

◆ GetBackgroundColor() [2/3]

virtual void vtkMRMLAbstractViewNode::GetBackgroundColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetBackgroundColor() [3/3]

virtual void vtkMRMLAbstractViewNode::GetBackgroundColor ( double  [3])
virtual

◆ GetBackgroundColor2() [1/3]

virtual double* vtkMRMLAbstractViewNode::GetBackgroundColor2 ( )
virtual

2nd background color of the view Black (0,0,0) by default.

See also
SetBackgroundColor2()

◆ GetBackgroundColor2() [2/3]

virtual void vtkMRMLAbstractViewNode::GetBackgroundColor2 ( double &  ,
double &  ,
double &   
)
virtual

◆ GetBackgroundColor2() [3/3]

virtual void vtkMRMLAbstractViewNode::GetBackgroundColor2 ( double  [3])
virtual

◆ GetClassName()

virtual const char* vtkMRMLAbstractViewNode::GetClassName ( )
virtual

◆ GetCompareColor()

static double* vtkMRMLAbstractViewNode::GetCompareColor ( )
static

◆ GetGrayColor()

static double* vtkMRMLAbstractViewNode::GetGrayColor ( )
static

◆ GetGreenColor()

static double* vtkMRMLAbstractViewNode::GetGreenColor ( )
static

◆ GetInteractionNode()

vtkMRMLInteractionNode* vtkMRMLAbstractViewNode::GetInteractionNode ( )

Get interaction node.

If no node reference has been explicitly set using SetInteractionNode() or SetInteractionNodeID(), return the singleton interaction node.

The singleton interaction node is considered to be the default interaction node. Associating a specific interaction node to one or a multiple views allows to control the interaction mode associated with these views.

Since by default, the interaction node is a singleton, a new interaction node may be created doing the following:

vtkNew<vtkMRMLInteractionNode> interactionNode;
interactionNode->SetSingletonOff();
this->GetMRMLScene()->AddNode(interactionNode.GetPointer());
See also
SetInteractionNodeID() SetInteractionNode()

◆ GetLayoutColor() [1/3]

virtual double* vtkMRMLAbstractViewNode::GetLayoutColor ( )
virtual

◆ GetLayoutColor() [2/3]

virtual void vtkMRMLAbstractViewNode::GetLayoutColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetLayoutColor() [3/3]

virtual void vtkMRMLAbstractViewNode::GetLayoutColor ( double  [3])
virtual

◆ GetLayoutLabel()

virtual char* vtkMRMLAbstractViewNode::GetLayoutLabel ( )
virtual

◆ GetLayoutName()

const char * vtkMRMLAbstractViewNode::GetLayoutName ( )
inline

Definition at line 344 of file vtkMRMLAbstractViewNode.h.

◆ GetOrientationMarkerEnabled()

virtual bool vtkMRMLAbstractViewNode::GetOrientationMarkerEnabled ( )
virtual

Tells if it is meaningful to display orientation marker in this view. It is set statically in each specific view node class and cannot be changed dynamically.

◆ GetOrientationMarkerHumanModelNode()

vtkMRMLModelNode* vtkMRMLAbstractViewNode::GetOrientationMarkerHumanModelNode ( )

◆ GetOrientationMarkerHumanModelNodeID()

const char* vtkMRMLAbstractViewNode::GetOrientationMarkerHumanModelNodeID ( )

◆ GetOrientationMarkerSize()

virtual int vtkMRMLAbstractViewNode::GetOrientationMarkerSize ( )
virtual

◆ GetOrientationMarkerSizeAsString()

static const char* vtkMRMLAbstractViewNode::GetOrientationMarkerSizeAsString ( int  id)
static

Convert between orientation marker type ID and name.

◆ GetOrientationMarkerSizeFromString()

static int vtkMRMLAbstractViewNode::GetOrientationMarkerSizeFromString ( const char *  name)
static

◆ GetOrientationMarkerType()

virtual int vtkMRMLAbstractViewNode::GetOrientationMarkerType ( )
virtual

◆ GetOrientationMarkerTypeAsString()

static const char* vtkMRMLAbstractViewNode::GetOrientationMarkerTypeAsString ( int  id)
static

Convert between orientation marker type ID and name.

◆ GetOrientationMarkerTypeFromString()

static int vtkMRMLAbstractViewNode::GetOrientationMarkerTypeFromString ( const char *  name)
static

◆ GetParentLayoutNode()

vtkMRMLNode* vtkMRMLAbstractViewNode::GetParentLayoutNode ( )

Get parent layout node. Default is no reference, meaning that the view is managed by the main layout. Non-empty reference means standalone view or view managed by another layout.

◆ GetRedColor()

static double* vtkMRMLAbstractViewNode::GetRedColor ( )
static

◆ GetRulerColor()

virtual int vtkMRMLAbstractViewNode::GetRulerColor ( )
virtual

◆ GetRulerColorAsString()

static const char* vtkMRMLAbstractViewNode::GetRulerColorAsString ( int  id)
static

Convert between ruler color ID and name.

◆ GetRulerColorFromString()

static int vtkMRMLAbstractViewNode::GetRulerColorFromString ( const char *  name)
static

◆ GetRulerEnabled()

virtual bool vtkMRMLAbstractViewNode::GetRulerEnabled ( )
virtual

Tells if it is meaningful to display ruler in this view. It is set statically in each specific view node class and cannot be changed dynamically.

◆ GetRulerType()

virtual int vtkMRMLAbstractViewNode::GetRulerType ( )
virtual

◆ GetRulerTypeAsString()

static const char* vtkMRMLAbstractViewNode::GetRulerTypeAsString ( int  id)
static

Convert between ruler type ID and name.

◆ GetRulerTypeFromString()

static int vtkMRMLAbstractViewNode::GetRulerTypeFromString ( const char *  name)
static

◆ GetThreeDViewBlueColor()

static double* vtkMRMLAbstractViewNode::GetThreeDViewBlueColor ( )
static

◆ GetViewGroup()

virtual int vtkMRMLAbstractViewNode::GetViewGroup ( )
virtual

◆ GetVisibility()

virtual int vtkMRMLAbstractViewNode::GetVisibility ( )
virtual

Indicates whether or not the view is visible.

If it is not visible, then the view is not shown in any of the view layouts, but can be privately used by modules.

See also
IsViewVisibleInLayout()
IsMappedInLayout()

◆ GetYellowColor()

static double* vtkMRMLAbstractViewNode::GetYellowColor ( )
static

◆ IsA()

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

◆ IsMappedInLayout()

virtual int vtkMRMLAbstractViewNode::IsMappedInLayout ( )
virtual

Indicates whether or not the view is mapped in the current layout.

See also
GetVisibility()
IsViewVisibleInLayout()
vtkMRMLLayoutNode::SetViewArrangement()

◆ IsTypeOf()

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

◆ IsViewVisibleInLayout()

bool vtkMRMLAbstractViewNode::IsViewVisibleInLayout ( )

Indicates whether or not the view is visible in the current layout.

A view is visible in the current layout it is both mapped in layout and visible.

See also
GetVisibility()
IsMappedInLayout()
vtkMRMLLayoutNode::SetViewArrangement()

◆ operator=()

void vtkMRMLAbstractViewNode::operator= ( const vtkMRMLAbstractViewNode )
protected

◆ PrintSelf()

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

◆ ReadXMLAttributes()

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

MRMLNode methods.

Read node attributes from XML file

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLPlotViewNode, vtkMRMLSliceNode, vtkMRMLTableViewNode, vtkMRMLViewNode, and vtkMRMLChartViewNode.

◆ Reset()

void vtkMRMLAbstractViewNode::Reset ( vtkMRMLNode defaultNode)
overridevirtual

Reimplemented to preserve layout label when reset.

See also
GetLayoutLabel()

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLSliceNode.

◆ SafeDownCast()

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

◆ SetActive()

virtual void vtkMRMLAbstractViewNode::SetActive ( int  )
virtual

◆ SetAndObserveParentLayoutNode()

bool vtkMRMLAbstractViewNode::SetAndObserveParentLayoutNode ( vtkMRMLNode node)

Set parent layout node reference

See also
GetParentLayoutNode

◆ SetAndObserveParentLayoutNodeID()

bool vtkMRMLAbstractViewNode::SetAndObserveParentLayoutNodeID ( const char *  layoutNodeId)

Set parent layout node reference

See also
GetParentLayoutNode

◆ SetAxisLabel()

void vtkMRMLAbstractViewNode::SetAxisLabel ( int  labelIndex,
const char *  label 
)

◆ SetBackgroundColor() [1/2]

virtual void vtkMRMLAbstractViewNode::SetBackgroundColor ( double  [3])
virtual

◆ SetBackgroundColor() [2/2]

virtual void vtkMRMLAbstractViewNode::SetBackgroundColor ( double  ,
double  ,
double   
)
virtual

◆ SetBackgroundColor2() [1/2]

virtual void vtkMRMLAbstractViewNode::SetBackgroundColor2 ( double  ,
double  ,
double   
)
virtual

◆ SetBackgroundColor2() [2/2]

virtual void vtkMRMLAbstractViewNode::SetBackgroundColor2 ( double  [3])
virtual

◆ SetInteractionNode()

bool vtkMRMLAbstractViewNode::SetInteractionNode ( vtkMRMLNode node)

Set interaction node reference.

See also
GetInteractionNode()

◆ SetInteractionNodeID()

bool vtkMRMLAbstractViewNode::SetInteractionNodeID ( const char *  interactionNodeId)

Set interaction node reference.

See also
GetInteractionNode()

◆ SetLayoutColor() [1/2]

virtual void vtkMRMLAbstractViewNode::SetLayoutColor ( double  [3])
virtual

◆ SetLayoutColor() [2/2]

virtual void vtkMRMLAbstractViewNode::SetLayoutColor ( double  ,
double  ,
double   
)
virtual

Color for view header in layout as RGB Gray by default

◆ SetLayoutLabel()

virtual void vtkMRMLAbstractViewNode::SetLayoutLabel ( const char *  )
virtual

Label for the view. Usually a 1 character label, e.g. R, 1, 2, etc.

See also
SetLayoutName()

◆ SetLayoutName()

void vtkMRMLAbstractViewNode::SetLayoutName ( const char *  layoutName)
inline

Name of the layout. Must be unique between all the view nodes of the same type because it is used as a singleton tag. Typical names can be colors "Red", "Green", "Yellow",... or numbers "1", "2"... to uniquely define the node. No name (i.e. "") by default.

See also
SetSingletonTag(), SetViewLabel()

Definition at line 338 of file vtkMRMLAbstractViewNode.h.

◆ SetMappedInLayout()

virtual void vtkMRMLAbstractViewNode::SetMappedInLayout ( int  value)
virtual

◆ SetOrientationMarkerHumanModelNodeID()

void vtkMRMLAbstractViewNode::SetOrientationMarkerHumanModelNodeID ( const char *  modelNodeId)

Get/Set a custom human orientation marker model. If nullptr or invalid node ID is specified then the default human model will be used. If the node has point data array with the name "Color" and 3 scalar components then it will be used to specify RGB color for the model. If no color point data is specified then the solid color specified in the model node's first display node will be used as color.

◆ SetOrientationMarkerSize()

virtual void vtkMRMLAbstractViewNode::SetOrientationMarkerSize ( int  )
virtual

Get/Set orientation marker is size. There are a few predefined marker sizes, defined by an enumerated value (e.g., small, medium, large).

◆ SetOrientationMarkerType()

virtual void vtkMRMLAbstractViewNode::SetOrientationMarkerType ( int  )
virtual

Get/Set orientation marker type (e.g., not displayed, cube, human, coordinate system axes)

◆ SetRulerColor()

virtual void vtkMRMLAbstractViewNode::SetRulerColor ( int  )
virtual

Get/Set ruler color (e.g., white or black)

◆ SetRulerType()

virtual void vtkMRMLAbstractViewNode::SetRulerType ( int  )
virtual

Get/Set ruler type (e.g., not displayed, thin, thick)

◆ SetViewGroup()

virtual void vtkMRMLAbstractViewNode::SetViewGroup ( int  )
virtual

An optional identifier to link groups of views. Views that have matching ViewGroup value are in the same group. ViewGroup is used for restricting scope of:

  • Linked slice view property changes (is slices are linked, a property change will only change views in the same group)
  • Crosshair jump to slice (if crosshair is moved with shift+mousemove and slice jump is enabled, only those slices will be moved that are in the same group as the view where the mouse was)
  • Slice intersection display (slice intersections will only shown of those slices that are in the same group)

◆ SetVisibility()

virtual void vtkMRMLAbstractViewNode::SetVisibility ( int  )
virtual

◆ WriteXML()

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

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

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLPlotViewNode, vtkMRMLSliceNode, vtkMRMLTableViewNode, vtkMRMLChartViewNode, and vtkMRMLViewNode.

Member Data Documentation

◆ Active

int vtkMRMLAbstractViewNode::Active
protected

Indicates whether or not the View is active. Inactive by default.

Definition at line 302 of file vtkMRMLAbstractViewNode.h.

◆ AxisLabels

vtkSmartPointer<vtkStringArray> vtkMRMLAbstractViewNode::AxisLabels
protected


Labels of coordinate system axes

Definition at line 331 of file vtkMRMLAbstractViewNode.h.

◆ AxisLabelsCount

const int vtkMRMLAbstractViewNode::AxisLabelsCount
static

Total number of coordinate system axis labels.

Definition at line 277 of file vtkMRMLAbstractViewNode.h.

◆ BackgroundColor

double vtkMRMLAbstractViewNode::BackgroundColor[3]
protected


Background colors

Definition at line 306 of file vtkMRMLAbstractViewNode.h.

◆ BackgroundColor2

double vtkMRMLAbstractViewNode::BackgroundColor2[3]
protected

Definition at line 307 of file vtkMRMLAbstractViewNode.h.

◆ InteractionNodeReferenceRole

const char* vtkMRMLAbstractViewNode::InteractionNodeReferenceRole
staticprotected

Definition at line 334 of file vtkMRMLAbstractViewNode.h.

◆ LayoutColor

double vtkMRMLAbstractViewNode::LayoutColor[3]
protected


Color for view header in layout as RGB

Definition at line 311 of file vtkMRMLAbstractViewNode.h.

◆ LayoutLabel

char* vtkMRMLAbstractViewNode::LayoutLabel
protected


Label to show for the view (shortcut for the name)

Definition at line 292 of file vtkMRMLAbstractViewNode.h.

◆ OrientationMarkerEnabled

bool vtkMRMLAbstractViewNode::OrientationMarkerEnabled
protected

For views that supports orientation marker display (where OrientationMarkerEnabled=true) these parameters define how to display the orientation marker.

Definition at line 316 of file vtkMRMLAbstractViewNode.h.

◆ OrientationMarkerHumanModelReferenceRole

const char* vtkMRMLAbstractViewNode::OrientationMarkerHumanModelReferenceRole
staticprotected

Definition at line 320 of file vtkMRMLAbstractViewNode.h.

◆ OrientationMarkerSize

int vtkMRMLAbstractViewNode::OrientationMarkerSize
protected

Definition at line 318 of file vtkMRMLAbstractViewNode.h.

◆ OrientationMarkerType

int vtkMRMLAbstractViewNode::OrientationMarkerType
protected

Definition at line 317 of file vtkMRMLAbstractViewNode.h.

◆ ParentLayoutNodeReferenceRole

const char* vtkMRMLAbstractViewNode::ParentLayoutNodeReferenceRole
staticprotected

Definition at line 333 of file vtkMRMLAbstractViewNode.h.

◆ RulerColor

int vtkMRMLAbstractViewNode::RulerColor
protected

Definition at line 327 of file vtkMRMLAbstractViewNode.h.

◆ RulerEnabled

bool vtkMRMLAbstractViewNode::RulerEnabled
protected

For views that supports ruler display (where RulerEnabled=true) these parameters define how to display the ruler.

Definition at line 325 of file vtkMRMLAbstractViewNode.h.

◆ RulerType

int vtkMRMLAbstractViewNode::RulerType
protected

Definition at line 326 of file vtkMRMLAbstractViewNode.h.

◆ ViewGroup

int vtkMRMLAbstractViewNode::ViewGroup
protected


Views with the same ViewGroup value are in the same group.

Definition at line 288 of file vtkMRMLAbstractViewNode.h.

◆ Visibility

int vtkMRMLAbstractViewNode::Visibility
protected

Indicates whether or not the View is visible. Invisible (0) by default.

Definition at line 297 of file vtkMRMLAbstractViewNode.h.


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