vtkMRMLSelectionNode Class Reference

MRML node for storing information about the active nodes in the scene. More...

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

Inheritance diagram for vtkMRMLSelectionNode:

Collaboration diagram for vtkMRMLSelectionNode:

Public Types
enum	{   ActivePlaceNodeIDChangedEvent = 19001 , ActivePlaceNodeClassNameChangedEvent , PlaceNodeClassNameListModifiedEvent , UnitModifiedEvent ,   ActivePlaceNodePlacementValidEvent }
typedef vtkMRMLNode	Superclass
Public Types inherited from vtkMRMLNode
enum	{   HierarchyModifiedEvent = 16000 , IDChangedEvent = 16001 , ReferenceAddedEvent , ReferenceModifiedEvent ,   ReferenceRemovedEvent , ReferencedNodeModifiedEvent }
enum	ContentModifiedObserveType { ContentModifiedObserveUndefined = -1 , ContentModifiedObserveDisabled = 0 , ContentModifiedObserveEnabled = 1 }
typedef std::map< std::string, std::string >	ReferencePropertiesType
	Get the node reference properties for a specific referenceRole.
typedef vtkObject	Superclass

Public Member Functions
void	AddNewPlaceNodeClassNameToList (const char *newID, const char *resource=nullptr, const char *iconName="")
void	Copy (vtkMRMLNode *node) override
	Copy the node's attributes to this object.
vtkMRMLNode *	CreateNodeInstance () override
	Create instance of the default node. Like New only virtual.
const char *	GetActiveCameraID ()
	the ID of a MRMLCameraNode
const char *	GetActiveLabelVolumeID ()
	the ID of a MRMLVolumeNode
const char *	GetActiveLayoutID ()
	the ID of a MRMLLayoutNode
virtual char *	GetActivePlaceNodeClassName ()
const char *	GetActivePlaceNodeID ()
bool	GetActivePlaceNodePlacementValid ()
	the node has a locked number of points.
const char *	GetActivePlotChartID ()
	the ID of a MRMLPlotChartNode
const char *	GetActiveROIListID ()
	the ID of a MRMLROIList
const char *	GetActiveTableID ()
	the ID of a MRMLTableNode
const char *	GetActiveViewID ()
	the ID of a MRMLViewNode
const char *	GetActiveVolumeID ()
	the ID of a MRMLVolumeNode (typically background)
virtual const char *	GetClassName ()
const char *	GetNodeTagName () override
	Get node XML tag name (like Volume, Model)
int	GetNumberOfPlaceNodeClassNamesInList ()
	Get the number of class names in the list.
std::string	GetPlaceNodeClassNameByIndex (int n)
std::string	GetPlaceNodeIconNameByIndex (int n)
std::string	GetPlaceNodeResourceByClassName (std::string className)
std::string	GetPlaceNodeResourceByIndex (int n)
const char *	GetSecondaryVolumeID ()
	the ID of a MRMLVolumeNode (typically foreground)
vtkMRMLUnitNode *	GetUnitNode (const char *quantity)
const char *	GetUnitNodeID (const char *quantity)
void	GetUnitNodeIDs (std::vector< const char * > &quantities, std::vector< const char * > &unitIDs)
void	GetUnitNodes (std::vector< vtkMRMLUnitNode * > &units)
virtual int	IsA (const char *type)
int	PlaceNodeClassNameInList (std::string className)
	Check for an classname in the list, returning it's index, -1 if not in list.
void	PrintSelf (ostream &os, vtkIndent indent) override
void	ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
void	ReadXMLAttributes (const char **atts) override
	Set node attributes.
void	RemovePlaceNodeClassNameFromList (const char *className)
void	SetActiveCameraID (const char *id)
void	SetActiveLabelVolumeID (const char *id)
void	SetActiveLayoutID (const char *id)
virtual void	SetActivePlaceNodeClassName (const char *)
void	SetActivePlaceNodeID (const char *id)
void	SetActivePlaceNodePlacementValid (bool valid)
	Set whether point placement is valid for the active placement node.
void	SetActivePlotChartID (const char *id)
void	SetActiveROIListID (const char *id)
void	SetActiveTableID (const char *id)
void	SetActiveViewID (const char *id)
void	SetActiveVolumeID (const char *id)
void	SetReferenceActiveCameraID (const char *id)
void	SetReferenceActiveLabelVolumeID (const char *id)
void	SetReferenceActiveLayoutID (const char *id)
void	SetReferenceActivePlaceNodeClassName (const char *className)
void	SetReferenceActivePlaceNodeID (const char *id)
void	SetReferenceActivePlotChartID (const char *id)
void	SetReferenceActiveROIListID (const char *id)
void	SetReferenceActiveTableID (char *id)
void	SetReferenceActiveViewID (const char *id)
void	SetReferenceActiveVolumeID (const char *id)
void	SetReferenceSecondaryVolumeID (char *id)
void	SetSecondaryVolumeID (const char *id)
void	SetUnitNodeID (const char *quantity, const char *id)
void	WriteXML (ostream &of, int indent) override
	Write this node's information to a MRML file in XML format.
Public Member Functions inherited from vtkMRMLNode
vtkMRMLNode *	AddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Add and observe a reference node from this node for a specific referenceRole.
vtkMRMLNode *	AddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
	Convenience method that adds a referencedNodeID at the end of the list.
void	AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr, bool observeContentModifiedEvents=false)
	Add a referenceRole.
virtual void	AddToSceneOff ()
virtual void	AddToSceneOn ()
void	ClearNodeReferenceProperties (const std::string &referenceRole)
	Remove all node reference properties for a specific referenceRole.
void	ClearNthNodeReferenceProperties (const std::string &referenceRole, int n)
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.
virtual void	CopyReferences (vtkMRMLNode *node)
	Copy the references of the node into this.
void	CopyWithScene (vtkMRMLNode *node)
	Copy everything (including Scene and ID) from another node of the same type.
void	DisableModifiedEventOff ()
void	DisableModifiedEventOn ()
virtual int	EndModify (int previousDisableModifiedEventState)
	End modifying the node.
virtual int	GetAddToScene ()
	node added to MRML scene.
const char *	GetAttribute (const char *name)
	Get value of a name value pair attribute.
std::vector< std::string >	GetAttributeNames ()
	Get all attribute names.
void	GetAttributeNames (vtkStringArray *attributeNames)
	Get all attribute names. Python-wrappable version.
virtual vtkIntArray *	GetContentModifiedEvents ()
int	GetCustomModifiedEventPending (int eventId)
virtual char *	GetDescription ()
virtual int	GetDisableModifiedEvent ()
	Turn on/off generating InvokeEvent for set macros.
virtual int	GetHideFromEditors ()
	Describes if the node is hidden.
virtual char *	GetID ()
	ID use by other nodes to reference this node in XML.
virtual int	GetInMRMLCallbackFlag ()
	Flags to avoid event loops.
virtual int	GetModifiedEventPending ()
virtual char *	GetName ()
vtkMRMLNode *	GetNodeReference (const char *referenceRole)
const char *	GetNodeReferenceID (const char *referenceRole)
	Utility function that returns the first node id for a specific referenceRole.
void	GetNodeReferenceIDs (const char *referenceRole, std::vector< const char * > &referencedNodeIDs)
	Return a list of the referenced node IDs.
const ReferencePropertiesType *	GetNodeReferenceProperties (const char *referenceRole)
std::string	GetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
	Get the node reference property for a specific referenceRole.
std::string	GetNodeReferencePropertyName (const std::string &referenceRole, int propertyIndex)
	Get the name of the Nth node reference property for a specific referenceRole.
std::vector< std::string >	GetNodeReferencePropertyNames (const std::string &referenceRole)
	Get the names of all node reference properties for a specific referenceRole.
void	GetNodeReferenceRoles (std::vector< std::string > &roles)
void	GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode * > &nodes)
	Return a list of the referenced nodes.
vtkMRMLNode *	GetNthNodeReference (const char *referenceRole, int n)
	Get referenced MRML node for a specific referenceRole.
const char *	GetNthNodeReferenceID (const char *referenceRole, int n)
	Return the string of the Nth node ID for a specific reference role.
const ReferencePropertiesType *	GetNthNodeReferenceProperties (const char *referenceRole, int n)
std::string	GetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)
std::string	GetNthNodeReferencePropertyName (const std::string &referenceRole, int referenceIndex, int propertyIndex)
std::vector< std::string >	GetNthNodeReferencePropertyNames (const std::string &referenceRole, int n)
const char *	GetNthNodeReferenceRole (int n)
int	GetNumberOfNodeReferenceProperties (const std::string &referenceRole)
	Get the number of node reference properties for a specific referenceRole.
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).
int	GetNumberOfNthNodeReferenceProperties (const std::string &referenceRole, int n)
virtual int	GetSaveWithScene ()
	Save node with MRML scene.
virtual vtkMRMLScene *	GetScene ()
	Get the scene this node has been added to.
virtual int	GetSelectable ()
	Describes if the node is selectable.
virtual int	GetSelected ()
	Get/Set for Selected.
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.
bool	HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
	Return true if referencedNodeID is in the node ID list for a specific referenceRole.
virtual void	HideFromEditorsOff ()
virtual void	HideFromEditorsOn ()
virtual void	InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
	This method allows the node to compress events.
virtual int	InvokePendingModifiedEvent ()
	Invokes any modified events that are pending.
bool	IsSingleton ()
void	Modified () override
	Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent.
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.
void	RemoveAttribute (const char *name)
	Remove attribute with the specified name.
void	RemoveNodeReferenceIDs (const char *referenceRole)
	Remove all node IDs and associated nodes for a specific referenceRole.
void	RemoveNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
	Remove a node reference property for a specific referenceRole.
void	RemoveNthNodeReferenceID (const char *referenceRole, int n)
	Convenience method that removes the Nth node ID from the list.
void	RemoveNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)
virtual void	Reset (vtkMRMLNode *defaultNode)
	Reset node attributes to the initial state as defined in the constructor or the passed default node.
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)
vtkMRMLNode *	SetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Set and observe a reference node from this node for a specific referenceRole.
vtkMRMLNode *	SetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Set and observe the Nth node ID for a specific reference role.
void	SetAttribute (const char *name, const char *value)
	Set a name value pair attribute.
virtual void	SetDescription (const char *)
	Text description of this node, to be set by the user.
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.
vtkMRMLNode *	SetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
	Set a reference to a node with specified nodeID from this node for a specific referenceRole.
void	SetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName, const std::string &value)
	Set the node reference property for a specific referenceRole.
vtkMRMLNode *	SetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
	Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole.
void	SetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName, const std::string &value)
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.
virtual void	SetSceneReferences ()
	Update the references of the node to the scene.
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.
virtual void	SetUndoEnabled (bool)
virtual int	StartModify ()
	Start modifying the node. Disable Modify events.
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.
virtual void	UpdateReferences ()
	The method should remove all pointers and observations to all nodes that are not in the scene anymore.
virtual void	UpdateScene (vtkMRMLScene *)
const char *	URLDecodeString (const char *inString)
	Decode a URL string.
const char *	URLEncodeString (const char *inString)
	Encode a URL string.
virtual void	WriteNodeBodyXML (ostream &of, int indent)
	Write this node's body to a MRML file in XML format.
std::string	XMLAttributeDecodeString (const std::string &inString)
	Decode an XML attribute string.
std::string	XMLAttributeEncodeString (const std::string &inString)
	Encode an XML attribute string (replaces special characters by code sequences)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLSelectionNode *	New ()
static vtkMRMLSelectionNode *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkMRMLNode
static int	IsTypeOf (const char *type)
static vtkMRMLNode *	SafeDownCast (vtkObject *o)

Protected Member Functions
void	operator= (const vtkMRMLSelectionNode &)
	vtkMRMLSelectionNode ()
	vtkMRMLSelectionNode (const vtkMRMLSelectionNode &)
	~vtkMRMLSelectionNode () 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.
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.
virtual char *	GetTempURLString ()
void	GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents, bool newObserveContentModifiedEvents)
virtual void	InvalidateNodeReferences ()
virtual bool	IsReferenceRoleGeneric (const char *refRole)
	Return true if the reference role is generic (ends with '/') or false otherwise.
std::string	NodeReferencePropertyDecodeString (const std::string &inString)
	Decode a node reference property string.
std::string	NodeReferencePropertyEncodeString (const std::string &inString)
	Encode a node reference property string (replaces special characters by code sequences)
virtual void	OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
virtual void	OnNodeReferenceModified (vtkMRMLNodeReference *reference)
	Called when a referenced node pointer is modified.
virtual void	OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
	Called when a referenced node pointer is removed (set to nullptr).
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.
vtkMRMLNode *	UpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, bool newObserveContentModifiedEvents, 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!

Protected Attributes
char *	ActivePlaceNodeClassName
bool	ActivePlaceNodePlacementValid
std::vector< std::string >	PlaceNodeClassNameList
std::vector< std::string >	PlaceNodeIconNameList
std::vector< std::string >	PlaceNodeResourceList
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.
vtkCallbackCommand *	MRMLCallbackCommand
	Holders for MRML callbacks.
vtkObserverManager *	MRMLObserverManager
char *	Name {nullptr}
NodeReferenceEventsType	NodeReferenceEvents
std::map< std::string, std::string >	NodeReferenceMRMLAttributeNames
NodeReferencesType	NodeReferences
int	SaveWithScene {true}
vtkWeakPointer< vtkMRMLScene >	Scene
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, NodeReferenceEventList >	NodeReferenceEventsType
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > >	NodeReferenceListType
typedef std::map< std::string, NodeReferenceListType >	NodeReferencesType
Static Protected Member Functions inherited from vtkMRMLNode
static void	MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)

Detailed Description

MRML node for storing information about the active nodes in the scene.

This node stores the information about the currently selected volume, label volume, fiducial list, place node class name, place node id, ROI list, camera, table, view, layout, units Note: the SetReferenceActive* routines are added because the vtkSetReferenceStringMacro is not wrapped (vtkSetStringMacro on which it is based is a special case in vtk's parser).

Definition at line 34 of file vtkMRMLSelectionNode.h.

Member Typedef Documentation

Superclass

typedef vtkMRMLNode vtkMRMLSelectionNode::Superclass

Definition at line 38 of file vtkMRMLSelectionNode.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

A list of events that this node can throw ActivePlaceNodeIDChangedEvent: is no longer observed by the Mouse mode tool bar, it only watches for the ActivePlaceNodeClassNameChangedEvent ActivePlaceNodeClassNameChangedEvent: is observed by the Mouse mode tool bar class to update that widget to the current place node PlaceNodeClassNameListModifiedEvent: this is fired when new place node class names are added, watched for by the Mouse mode tool bar so that it can offer the user all the valid types of nodes to place. UnitModifiedEvent: Fired every time a quantity unit node is changed or an active quantity unit node is modified. The calldata contains the node quantity

See also

AddNewPlaceNodeClassNameToList

Enumerator
ActivePlaceNodeIDChangedEvent
ActivePlaceNodeClassNameChangedEvent
PlaceNodeClassNameListModifiedEvent
UnitModifiedEvent
ActivePlaceNodePlacementValidEvent

Definition at line 150 of file vtkMRMLSelectionNode.h.

Constructor & Destructor Documentation

vtkMRMLSelectionNode() [1/2]

vtkMRMLSelectionNode::vtkMRMLSelectionNode ( )

protected

~vtkMRMLSelectionNode()

vtkMRMLSelectionNode::~vtkMRMLSelectionNode ( )

overrideprotected

vtkMRMLSelectionNode() [2/2]

vtkMRMLSelectionNode::vtkMRMLSelectionNode ( const vtkMRMLSelectionNode & )

protected

Member Function Documentation

AddNewPlaceNodeClassNameToList()

void vtkMRMLSelectionNode::AddNewPlaceNodeClassNameToList	(	const char *	newID,
		const char *	resource = nullptr,
		const char *	iconName = "" )

Add a new valid placeNode class name to the list, with optional qt resource reference string for updating GUI elements

Copy()

void vtkMRMLSelectionNode::Copy ( vtkMRMLNode * node )

overridevirtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLNode.

CreateNodeInstance()

vtkMRMLNode * vtkMRMLSelectionNode::CreateNodeInstance ( )

overridevirtual

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

Note

Subclasses should implement this method

Implements vtkMRMLNode.

GetActiveCameraID()

const char * vtkMRMLSelectionNode::GetActiveCameraID

(

)

the ID of a MRMLCameraNode

GetActiveLabelVolumeID()

const char * vtkMRMLSelectionNode::GetActiveLabelVolumeID

(

)

the ID of a MRMLVolumeNode

GetActiveLayoutID()

const char * vtkMRMLSelectionNode::GetActiveLayoutID

(

)

the ID of a MRMLLayoutNode

GetActivePlaceNodeClassName()

virtual char * vtkMRMLSelectionNode::GetActivePlaceNodeClassName ( )

virtual

Get the classname of the active placeNode type. The active placeNode is used to control what placeNode is being dropped by the user.

See also

SetActivePlaceNodeClassName, SetReferenceActivePlaceNodeClassName

GetActivePlaceNodeID()

const char * vtkMRMLSelectionNode::GetActivePlaceNodeID

(

)

Get the ID of the currently active placeNode.

See also

SetActivePlaceNodeID, SetReferenceActivePlaceNodeID

GetActivePlaceNodePlacementValid()

bool vtkMRMLSelectionNode::GetActivePlaceNodePlacementValid

(

)

the node has a locked number of points.

Returns true if additional points can be placed in the current placement node, false if

GetActivePlotChartID()

const char * vtkMRMLSelectionNode::GetActivePlotChartID

(

)

the ID of a MRMLPlotChartNode

GetActiveROIListID()

const char * vtkMRMLSelectionNode::GetActiveROIListID

(

)

the ID of a MRMLROIList

GetActiveTableID()

const char * vtkMRMLSelectionNode::GetActiveTableID

(

)

the ID of a MRMLTableNode

GetActiveViewID()

const char * vtkMRMLSelectionNode::GetActiveViewID

(

)

the ID of a MRMLViewNode

GetActiveVolumeID()

const char * vtkMRMLSelectionNode::GetActiveVolumeID

(

)

the ID of a MRMLVolumeNode (typically background)

GetClassName()

virtual const char * vtkMRMLSelectionNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLNode.

GetNodeTagName()

const char * vtkMRMLSelectionNode::GetNodeTagName ( )

inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Definition at line 53 of file vtkMRMLSelectionNode.h.

GetNumberOfPlaceNodeClassNamesInList()

int vtkMRMLSelectionNode::GetNumberOfPlaceNodeClassNamesInList ( )

inline

Get the number of class names in the list.

Definition at line 217 of file vtkMRMLSelectionNode.h.

GetPlaceNodeClassNameByIndex()

std::string vtkMRMLSelectionNode::GetPlaceNodeClassNameByIndex

(

int

n

)

Return nth placeNode class name string from the list, empty string if out of bounds

GetPlaceNodeIconNameByIndex()

std::string vtkMRMLSelectionNode::GetPlaceNodeIconNameByIndex

(

int

n

)

Return nth placeNode icon name string from the list, empty string if out of bounds

GetPlaceNodeResourceByClassName()

std::string vtkMRMLSelectionNode::GetPlaceNodeResourceByClassName

(

std::string

className

)

Return the placeNode resource associated with this classname, empty string if not found

See also

vtkMRMLSelectionNode::PlaceNodeClassNameInList

vtkMRMLSelectionNode::GetPlaceNodeResourceByIndex

GetPlaceNodeResourceByIndex()

std::string vtkMRMLSelectionNode::GetPlaceNodeResourceByIndex

(

int

n

)

Return nth placeNode resource string from the list, empty string if out of bounds

GetSecondaryVolumeID()

const char * vtkMRMLSelectionNode::GetSecondaryVolumeID

(

)

the ID of a MRMLVolumeNode (typically foreground)

GetUnitNode()

vtkMRMLUnitNode * vtkMRMLSelectionNode::GetUnitNode

(

const char *

quantity

)

Return the unit node associated to the quantity.

See also

GetUnitNodeID()

GetUnitNodeID()

const char * vtkMRMLSelectionNode::GetUnitNodeID

(

const char *

quantity

)

Set/Get the current unit node associated with the given quantity. This is how the GUI or the logic can access the current node for a quantity. Changing the current node for a given quantity should only be done through the unit node settings panel. There can be no node (i.e. nullptr) associated to a quantity. To make sure to have the correct unit node, one should observe the selection node for UnitModifiedEvent.

See also

GetUnitNode(), GetNodeReferenceID(), SetAndObserveNodeReferenceID()

UnitModifiedEvent

GetUnitNodeIDs()

void vtkMRMLSelectionNode::GetUnitNodeIDs	(	std::vector< const char * > &	quantities,
		std::vector< const char * > &	unitIDs )

Get all the unit node IDs currently observed by the selection node.

See also

GetUnitNodes()

GetUnitNodes()

void vtkMRMLSelectionNode::GetUnitNodes

(

std::vector< vtkMRMLUnitNode * > &

units

)

Get all the unit node currently observed by the selection node.

See also

GetReferenceNodes()

GetUnitNodeID(), SetUnitNodeID(), GetUnitNodeIDs()

IsA()

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

virtual

Reimplemented from vtkMRMLNode.

IsTypeOf()

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

static

New()

static vtkMRMLSelectionNode * vtkMRMLSelectionNode::New ( )

static

operator=()

void vtkMRMLSelectionNode::operator= ( const vtkMRMLSelectionNode & )

protected

PlaceNodeClassNameInList()

int vtkMRMLSelectionNode::PlaceNodeClassNameInList

(

std::string

className

)

Check for an classname in the list, returning it's index, -1 if not in list.

PrintSelf()

void vtkMRMLSelectionNode::PrintSelf ( ostream & os, vtkIndent indent )

override

ProcessMRMLEvents()

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

overridevirtual

Method to propagate events generated in units nodes.

See also

GetNodeReferenceID(), SetAndObserveNodeReferenceID()

UnitModifiedEvent

Reimplemented from vtkMRMLNode.

ReadXMLAttributes()

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

overridevirtual

Set node attributes.

Reimplemented from vtkMRMLNode.

RemovePlaceNodeClassNameFromList()

void vtkMRMLSelectionNode::RemovePlaceNodeClassNameFromList

(

const char *

className

)

Remove a placeNode class name from the list

See also

PlaceNodeClassNameInList

SafeDownCast()

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

static

SetActiveCameraID()

void vtkMRMLSelectionNode::SetActiveCameraID

(

const char *

id

)

SetActiveLabelVolumeID()

void vtkMRMLSelectionNode::SetActiveLabelVolumeID

(

const char *

id

)

SetActiveLayoutID()

void vtkMRMLSelectionNode::SetActiveLayoutID

(

const char *

id

)

SetActivePlaceNodeClassName()

virtual void vtkMRMLSelectionNode::SetActivePlaceNodeClassName ( const char * )

virtual

Set the classname of the active placeNode type. Use SetReferenceActivePlaceNodeClassName if you need the mouse mode tool bar to update.

See also

GetActivePlaceNodeClassName, SetReferenceActivePlaceNodeClassName

SetActivePlaceNodeID()

void vtkMRMLSelectionNode::SetActivePlaceNodeID

(

const char *

id

)

Set the ID of the currently active placeNode.

See also

GetActivePlaceNodeID, SetReferenceActivePlaceNodeID

SetActivePlaceNodePlacementValid()

void vtkMRMLSelectionNode::SetActivePlaceNodePlacementValid

(

bool

valid

)

Set whether point placement is valid for the active placement node.

SetActivePlotChartID()

void vtkMRMLSelectionNode::SetActivePlotChartID

(

const char *

id

)

SetActiveROIListID()

void vtkMRMLSelectionNode::SetActiveROIListID

(

const char *

id

)

SetActiveTableID()

void vtkMRMLSelectionNode::SetActiveTableID

(

const char *

id

)

SetActiveViewID()

void vtkMRMLSelectionNode::SetActiveViewID

(

const char *

id

)

SetActiveVolumeID()

void vtkMRMLSelectionNode::SetActiveVolumeID

(

const char *

id

)

SetReferenceActiveCameraID()

void vtkMRMLSelectionNode::SetReferenceActiveCameraID ( const char * id )

inline

Deprecated

Use SetActiveCameraID instead

Definition at line 112 of file vtkMRMLSelectionNode.h.

SetReferenceActiveLabelVolumeID()

void vtkMRMLSelectionNode::SetReferenceActiveLabelVolumeID ( const char * id )

inline

Deprecated

Use SetActiveLabelVolumeID instead

Definition at line 71 of file vtkMRMLSelectionNode.h.

SetReferenceActiveLayoutID()

void vtkMRMLSelectionNode::SetReferenceActiveLayoutID ( const char * id )

inline

Deprecated

Use SetActiveLayoutID instead

Definition at line 130 of file vtkMRMLSelectionNode.h.

SetReferenceActivePlaceNodeClassName()

void vtkMRMLSelectionNode::SetReferenceActivePlaceNodeClassName

(

const char *

className

)

Set the active placeNode class name and fire the event ActivePlaceNodeClassNameChangedEvent so that the Mouse mode tool bar will update.

See also

GetActivePlaceNodeClassName, SetActivePlaceNodeClassName

SetReferenceActivePlaceNodeID()

void vtkMRMLSelectionNode::SetReferenceActivePlaceNodeID ( const char * id )

inline

Set the ID of the currently active placeNode and fire the ActivePlaceNodeIDChangedEvent event.

See also

GetActivePlaceNodeID, SetActivePlaceNodeID

Definition at line 98 of file vtkMRMLSelectionNode.h.

SetReferenceActivePlotChartID()

void vtkMRMLSelectionNode::SetReferenceActivePlotChartID ( const char * id )

inline

Deprecated

Use SetActivePlotChartID instead

Definition at line 136 of file vtkMRMLSelectionNode.h.

SetReferenceActiveROIListID()

void vtkMRMLSelectionNode::SetReferenceActiveROIListID ( const char * id )

inline

Deprecated

Use SetActiveROIListID instead

Definition at line 106 of file vtkMRMLSelectionNode.h.

SetReferenceActiveTableID()

void vtkMRMLSelectionNode::SetReferenceActiveTableID ( char * id )

inline

Deprecated

Use SetActiveTableID instead

Definition at line 118 of file vtkMRMLSelectionNode.h.

SetReferenceActiveViewID()

void vtkMRMLSelectionNode::SetReferenceActiveViewID ( const char * id )

inline

Deprecated

Use SetActiveViewID instead

Definition at line 124 of file vtkMRMLSelectionNode.h.

SetReferenceActiveVolumeID()

void vtkMRMLSelectionNode::SetReferenceActiveVolumeID ( const char * id )

inline

Deprecated

Use SetActiveVolumeID instead

Definition at line 59 of file vtkMRMLSelectionNode.h.

SetReferenceSecondaryVolumeID()

void vtkMRMLSelectionNode::SetReferenceSecondaryVolumeID ( char * id )

inline

Deprecated

Use SetSecondaryVolumeID instead

Definition at line 65 of file vtkMRMLSelectionNode.h.

SetSecondaryVolumeID()

void vtkMRMLSelectionNode::SetSecondaryVolumeID

(

const char *

id

)

SetUnitNodeID()

void vtkMRMLSelectionNode::SetUnitNodeID	(	const char *	quantity,
		const char *	id )

WriteXML()

void vtkMRMLSelectionNode::WriteXML ( ostream & of, int indent )

overridevirtual

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

Reimplemented from vtkMRMLNode.

Member Data Documentation

ActivePlaceNodeClassName

char* vtkMRMLSelectionNode::ActivePlaceNodeClassName

protected

Definition at line 231 of file vtkMRMLSelectionNode.h.

ActivePlaceNodePlacementValid

bool vtkMRMLSelectionNode::ActivePlaceNodePlacementValid

protected

Definition at line 232 of file vtkMRMLSelectionNode.h.

PlaceNodeClassNameList

std::vector<std::string> vtkMRMLSelectionNode::PlaceNodeClassNameList

protected

Definition at line 234 of file vtkMRMLSelectionNode.h.

PlaceNodeIconNameList

std::vector<std::string> vtkMRMLSelectionNode::PlaceNodeIconNameList

protected

Definition at line 236 of file vtkMRMLSelectionNode.h.

PlaceNodeResourceList

std::vector<std::string> vtkMRMLSelectionNode::PlaceNodeResourceList

protected

Definition at line 235 of file vtkMRMLSelectionNode.h.

---

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

• Libs/MRML/Core/vtkMRMLSelectionNode.h