#include <Modules/Loadable/Annotations/MRML/vtkMRMLAnnotationNode.h>

Inheritance diagram for vtkMRMLAnnotationNode:

[legend]

Collaboration diagram for vtkMRMLAnnotationNode:

[legend]

Public Types
enum	{ TEXT_SELECTED = 0 , TEXT_VISIBLE , NUM_TEXT_ATTRIBUTE_TYPES , LockModifiedEvent }

typedef vtkMRMLModelNode	Superclass

Public Types inherited from vtkMRMLModelNode
enum	{ MeshModifiedEvent = 17001 , PolyDataModifiedEvent = 17001 }

enum	MeshTypeHint { PolyDataMeshType = 0 , UnstructuredGridMeshType }

typedef vtkMRMLDisplayableNode	Superclass

Public Types inherited from vtkMRMLDisplayableNode
enum	{ DisplayModifiedEvent = 17000 }

typedef vtkMRMLTransformableNode	Superclass

Public Types inherited from vtkMRMLTransformableNode
enum	{ TransformModifiedEvent = 15000 }
	TransformModifiedEvent is send when the parent transform is modified. More...

typedef vtkMRMLStorableNode	Superclass

Public Types inherited from vtkMRMLStorableNode
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
int	AddText (const char *newText, int selectedFlag, int visibleFlag)

bool	CanApplyNonLinearTransforms () const override

void	CreateAnnotationTextDisplayNode ()

vtkMRMLStorageNode *	CreateDefaultStorageNode () override

vtkMRMLNode *	CreateNodeInstance () override
	MRMLNode methods.

int	DeleteAttribute (vtkIdType idAttEntry, vtkIdType idAttType)

int	DeleteText (int id)

int	GetAnnotationAttribute (vtkIdType id, int att)

vtkDataArray *	GetAnnotationAttributes (int att)

vtkMRMLAnnotationTextDisplayNode *	GetAnnotationTextDisplayNode ()

virtual const char *	GetAttributeTypesEnumAsString (int val)

virtual const char *	GetClassName ()

std::string	GetDefaultStorageNodeClassName (const char *filename) override

virtual const char *	GetIcon ()

virtual int	GetLocked ()

const char *	GetNodeTagName () override
	Get node XML tag name (like Volume, Model)

int	GetNumberOfTexts ()

virtual char *	GetReferenceNodeID ()

std::string	GetText (int id)

double	GetTextScale ()
	Get the text scale of the associated text.

virtual void	Initialize (vtkMRMLScene *mrmlScene)

virtual int	IsA (const char *type)

virtual void	PrintAnnotationInfo (ostream &os, vtkIndent indent, int titleFlag=1)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	ProcessMRMLEvents (vtkObject , unsigned long, void ) override
	Propagate events generated in mrml.

void	ReadXMLAttributes (const char **atts) override

virtual void	ResetAnnotations ()

void	SetAnnotationAttribute (vtkIdType id, int att, double value)

void	SetLocked (int init)

virtual void	SetReferenceNodeID (const char *)

void	SetText (int id, const char *newText, int selectedFlag, int visibleFlag)

void	SetTextScale (double textScale)
	Set the text scale of the associated text.

void	UpdateScene (vtkMRMLScene *scene) override

	vtkMRMLCopyContentMacro (vtkMRMLAnnotationNode)

void	WriteXML (ostream &of, int indent) override

Public Member Functions inherited from vtkMRMLModelNode
void	AddCellScalars (vtkDataArray *array)

void	AddPointScalars (vtkDataArray *array)
	Utility function that adds an array to the mesh's point data. /.

void	AddScalars (vtkDataArray *array, int location)

void	ApplyTransform (vtkAbstractTransform *transform) override

bool	CanApplyNonLinearTransforms () const override

int	CompositeScalars (const char backgroundName, const char overlayName, float overlayMin, float overlayMax, int showOverlayPositive, int showOverlayNegative, int reverseOverlay)

void	CreateDefaultDisplayNodes () override
	Create and observe default display node.

vtkMRMLStorageNode *	CreateDefaultStorageNode () override

vtkMRMLNode *	CreateNodeInstance () override
	MRMLNode methods.

const char *	GetActiveCellScalarName (int type)

const char *	GetActivePointScalarName (int type)

void	GetBounds (double bounds[6]) override

std::string	GetDefaultStorageNodeClassName (const char *filename) override

vtkImplicitFunction *	GetImplicitFunctionWorld () override

virtual vtkPointSet *	GetMesh ()

virtual vtkAlgorithmOutput *	GetMeshConnection ()

virtual MeshTypeHint	GetMeshType ()

vtkMRMLModelDisplayNode *	GetModelDisplayNode ()
	Get associated model display MRML node.

bool	GetModifiedSinceRead () override

const char *	GetNodeTagName () override
	Get node XML tag name (like Volume, Model)

virtual vtkPolyData *	GetPolyData ()

virtual vtkAlgorithmOutput *	GetPolyDataConnection ()

void	GetRASBounds (double bounds[6]) override

virtual vtkUnstructuredGrid *	GetUnstructuredGrid ()

virtual vtkAlgorithmOutput *	GetUnstructuredGridConnection ()

bool	HasCellScalarName (const char *scalarName)

bool	HasPointScalarName (const char *scalarName)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	ProcessMRMLEvents (vtkObject , unsigned long, void ) override
	alternative method to propagate events generated in Display nodes

void	RemoveScalars (const char *scalarName)
	Remove an array from the mesh's point/cell data.

int	SetActiveCellScalars (const char *scalarName, int attributeType)

int	SetActivePointScalars (const char *scalarName, int attributeType)

virtual void	SetAndObserveMesh (vtkPointSet *Mesh)

virtual void	SetAndObservePolyData (vtkPolyData *polyData)

virtual void	SetPolyDataConnection (vtkAlgorithmOutput *inputPort)

virtual void	SetUnstructuredGridConnection (vtkAlgorithmOutput *inputPort)

bool	ShowDefaultScalarData ()

virtual void	TransformBoundsToRAS (double inputBounds_Local[6], double outputBounds_RAS[6])

	vtkMRMLCopyContentMacro (vtkMRMLModelNode)

Public Member Functions inherited from vtkMRMLDisplayableNode
void	AddAndObserveDisplayNodeID (const char *displayNodeID)

void	Copy (vtkMRMLNode *node) override
	Copy the node's attributes to this object.

virtual void	CreateDefaultSequenceDisplayNodes ()

virtual int	GetDisplayClassVisibility (const char *nodeClass)

vtkMRMLDisplayNode *	GetDisplayNode ()

const char *	GetDisplayNodeID ()

virtual const char *	GetDisplayNodeReferenceRole ()

virtual int	GetDisplayVisibility ()

vtkMRMLDisplayNode *	GetNthDisplayNode (int n)

const char *	GetNthDisplayNodeID (int n)

int	GetNumberOfDisplayNodes ()

bool	HasDisplayNodeID (const char *displayNodeID)
	Return true if displayNodeID is in the display node ID list.

void	PrintSelf (ostream &os, vtkIndent indent) override

void	ReadXMLAttributes (const char **atts) override
	Read node attributes from XML file.

void	RemoveAllDisplayNodeIDs ()
	Remove all display node IDs and associated display nodes.

void	RemoveNthDisplayNodeID (int n)

void	SetAndObserveDisplayNodeID (const char *displayNodeID)

void	SetAndObserveNthDisplayNodeID (int n, const char *displayNodeID)

virtual void	SetDisplayClassVisibility (const char *nodeClass, int visible)

virtual void	SetDisplayVisibility (int visible)

void	SetSelectable (int) override

virtual void	WriteCLI (std::vector< std::string > &vtkNotUsed(commandLine), std::string vtkNotUsed(prefix), int vtkNotUsed(coordinateSystemFlag)=vtkMRMLStorageNode::CoordinateSystemRAS, int vtkNotUsed(multipleFlag)=1)

void	WriteXML (ostream &of, int indent) override
	Write this node's information to a MRML file in XML format.

Public Member Functions inherited from vtkMRMLTransformableNode
virtual void	ApplyTransformMatrix (vtkMatrix4x4 *transformMatrix)

vtkMRMLTransformNode *	GetParentTransformNode ()
	Associated transform MRML node.

const char *	GetTransformNodeID ()
	Get referenced transform node id.

bool	HardenTransform ()

void	PrintSelf (ostream &os, vtkIndent indent) override

void	ProcessMRMLEvents (vtkObject , unsigned long, void ) override
	alternative method to propagate events generated in Transform nodes

void	ReadXMLAttributes (const char **atts) override
	Read node attributes from XML file.

bool	SetAndObserveTransformNodeID (const char *transformNodeID)

virtual void	TransformPointFromWorld (const double inWorld[3], double outLocal[3])

virtual void	TransformPointFromWorld (const vtkVector3d &inWorld, vtkVector3d &outLocal)

virtual void	TransformPointToWorld (const double inLocal[3], double outWorld[3])

virtual void	TransformPointToWorld (const vtkVector3d &inLocal, vtkVector3d &outWorld)

void	WriteXML (ostream &of, int indent) override
	Write this node's information to a MRML file in XML format.

Public Member Functions inherited from vtkMRMLStorableNode
void	AddAndObserveStorageNodeID (const char *storageNodeID)

virtual bool	AddDefaultStorageNode (const char *filename=nullptr)

void	Copy (vtkMRMLNode *node) override
	Copy node contents from another node of the same type. Reimplemented to copy default sequence storage node class.

virtual vtkMRMLStorageNode *	CreateDefaultSequenceStorageNode ()

virtual std::string	GetDefaultSequenceStorageNodeClassName ()

vtkMRMLStorageNode *	GetNthStorageNode (int n)
	Get associated display MRML node.

const char *	GetNthStorageNodeID (int n)

int	GetNumberOfStorageNodes ()

const char *	GetSlicerDataType ()

vtkMRMLStorageNode *	GetStorageNode ()

const char *	GetStorageNodeID ()

virtual vtkTagTable *	GetUserTagTable ()
	Methods for user-specified metadata.

bool	HasStorageNodeID (const char *storageNodeID)
	Return true if storageNodeID is in the storage node ID list.

void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)

void	SetAndObserveStorageNodeID (const char *storageNodeID)
	String ID of the storage MRML node.

virtual void	SetDefaultSequenceStorageNodeClassName (std::string)

void	SetSlicerDataType (const char *type)

virtual void	StorableModified ()

void	UpdateScene (vtkMRMLScene *scene) override
	Finds the storage node and read the data.

	vtkMRMLCopyContentMacro (vtkMRMLStorableNode)

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

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 vtkMRMLAnnotationNode *	New ()

static vtkMRMLAnnotationNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLModelNode
static int	GetAttributeTypeFromString (const char *typeName)

static int	IsTypeOf (const char *type)

static vtkMRMLModelNode *	New ()

static vtkMRMLModelNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLDisplayableNode
static int	IsTypeOf (const char *type)

static vtkMRMLDisplayableNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLTransformableNode
static int	IsTypeOf (const char *type)

static vtkMRMLTransformableNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLStorableNode
static int	IsTypeOf (const char *type)

static vtkMRMLStorableNode *	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	CreatePolyData ()

vtkCellArray *	GetLines ()

vtkPoints *	GetPoints ()

void	operator= (const vtkMRMLAnnotationNode &)

void	ResetAttributes (int id)

void	ResetTextAttributesAll ()

void	SetAttributeSize (vtkIdType id, vtkIdType n)

	vtkMRMLAnnotationNode ()

	vtkMRMLAnnotationNode (const vtkMRMLAnnotationNode &)

	~vtkMRMLAnnotationNode () override

Protected Member Functions inherited from vtkMRMLModelNode
void	OnNodeReferenceAdded (vtkMRMLNodeReference *reference) override
	Called when a node reference ID is added (list size increased).

void	OnNodeReferenceModified (vtkMRMLNodeReference *reference) override
	Called when a node reference ID is modified.

void	operator= (const vtkMRMLModelNode &)

virtual void	SetMeshConnection (vtkAlgorithmOutput *inputPort)
	Called by SetPolyDataConnection and SetUnstructuredGridConnection.

virtual void	SetMeshToDisplayNode (vtkMRMLModelDisplayNode *modelDisplayNode)

void	SetMeshToDisplayNodes ()

virtual void	UpdateDisplayNodeMesh (vtkMRMLDisplayNode *dnode)

void	UpdateImplicitDistanceFunction ()
	Updates the implicit function connection.

	vtkMRMLModelNode ()

	vtkMRMLModelNode (const vtkMRMLModelNode &)

	~vtkMRMLModelNode () override

Protected Member Functions inherited from vtkMRMLDisplayableNode
virtual const char *	GetDisplayNodeReferenceMRMLAttributeName ()

void	OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) override
	Called after a node reference ID is removed (list size decreased).

void	operator= (const vtkMRMLDisplayableNode &)

	vtkMRMLDisplayableNode ()

	vtkMRMLDisplayableNode (const vtkMRMLDisplayableNode &)

	~vtkMRMLDisplayableNode () override

Protected Member Functions inherited from vtkMRMLTransformableNode
virtual const char *	GetTransformNodeReferenceMRMLAttributeName ()

virtual const char *	GetTransformNodeReferenceRole ()

void	OnNodeReferenceAdded (vtkMRMLNodeReference *reference) override
	Called when a node reference ID is added (list size increased).

void	OnNodeReferenceModified (vtkMRMLNodeReference *reference) override
	Called when a node reference ID is modified.

void	OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) override
	Called after a node reference ID is removed (list size decreased).

virtual void	OnTransformNodeReferenceChanged (vtkMRMLTransformNode *transformNode)
	Called when transform node reference added/modified/removed.

void	operator= (const vtkMRMLTransformableNode &)

	vtkMRMLTransformableNode ()

	vtkMRMLTransformableNode (const vtkMRMLTransformableNode &)

	~vtkMRMLTransformableNode () override

Protected Member Functions inherited from vtkMRMLStorableNode
virtual const char *	GetStorageNodeReferenceMRMLAttributeName ()

virtual const char *	GetStorageNodeReferenceRole ()

virtual vtkTimeStamp	GetStoredTime ()

void	operator= (const vtkMRMLStorableNode &)

	vtkMRMLStorableNode ()

	vtkMRMLStorableNode (const vtkMRMLStorableNode &)

	~vtkMRMLStorableNode () 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)

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
int	Locked

vtkMRMLAnnotationNode *	m_Backup

vtkSmartPointer< vtkMRMLCameraNode >	m_CameraNode

vtkSmartPointer< vtkMRMLSliceNode >	m_GreenSliceNode

vtkSmartPointer< vtkMRMLSliceNode >	m_RedSliceNode

vtkSmartPointer< vtkMRMLSliceNode >	m_YellowSliceNode

char *	ReferenceNodeID

vtkStringArray *	TextList

Protected Attributes inherited from vtkMRMLModelNode
vtkEventForwarderCommand *	DataEventForwarder

vtkSmartPointer< vtkImplicitPolyDataDistance >	ImplicitPolyDataDistanceWorld

vtkAlgorithmOutput *	MeshConnection
	Data.

MeshTypeHint	MeshType

vtkSmartPointer< vtkTransformFilter >	PolyDataLocalToWorldTransformFilter

Protected Attributes inherited from vtkMRMLStorableNode
std::string	DefaultSequenceStorageNodeClassName

std::string	SlicerDataType

vtkTimeStamp	StorableModifiedTime

vtkTagTable *	UserTagTable

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)

Static Protected Attributes inherited from vtkMRMLDisplayableNode
static const char *	DisplayNodeReferenceMRMLAttributeName

static const char *	DisplayNodeReferenceRole

Static Protected Attributes inherited from vtkMRMLTransformableNode
static const char *	TransformNodeReferenceMRMLAttributeName

static const char *	TransformNodeReferenceRole

Static Protected Attributes inherited from vtkMRMLStorableNode
static const char *	StorageNodeReferenceMRMLAttributeName

static const char *	StorageNodeReferenceRole

Detailed Description

Definition at line 30 of file vtkMRMLAnnotationNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLModelNode vtkMRMLAnnotationNode::Superclass

Definition at line 34 of file vtkMRMLAnnotationNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
TEXT_SELECTED
TEXT_VISIBLE
NUM_TEXT_ATTRIBUTE_TYPES
LockModifiedEvent

Definition at line 92 of file vtkMRMLAnnotationNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLAnnotationNode() [1/2]

vtkMRMLAnnotationNode::vtkMRMLAnnotationNode ( )

protected

◆ ~vtkMRMLAnnotationNode()

vtkMRMLAnnotationNode::~vtkMRMLAnnotationNode ( )

overrideprotected

◆ vtkMRMLAnnotationNode() [2/2]

vtkMRMLAnnotationNode::vtkMRMLAnnotationNode ( const vtkMRMLAnnotationNode & )

protected

Member Function Documentation

◆ AddText()

int vtkMRMLAnnotationNode::AddText	(	const char *	newText,
		int	selectedFlag,
		int	visibleFlag )

◆ CanApplyNonLinearTransforms()

bool vtkMRMLAnnotationNode::CanApplyNonLinearTransforms ( ) const

inlineoverridevirtual

Returns false since in general cannot apply non linear transforms

See also: ApplyTransformMatrix, ApplyTransform

Reimplemented from vtkMRMLTransformableNode.

Definition at line 83 of file vtkMRMLAnnotationNode.h.

◆ CreateAnnotationTextDisplayNode()

void vtkMRMLAnnotationNode::CreateAnnotationTextDisplayNode ( )

◆ CreateDefaultStorageNode()

vtkMRMLStorageNode * vtkMRMLAnnotationNode::CreateDefaultStorageNode ( )

overridevirtual

Create a storage node for this node type. If it returns nullptr then it means the node can be stored in the scene (in XML), without using a storage node. Null by default. This must be overwritten by subclasses that use storage nodes.

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationSnapshotNode.

◆ CreateNodeInstance()

vtkMRMLNode * vtkMRMLAnnotationNode::CreateNodeInstance ( )

overridevirtual

MRMLNode methods.

Implements vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationSnapshotNode.

◆ CreatePolyData()

void vtkMRMLAnnotationNode::CreatePolyData ( )

protected

◆ DeleteAttribute()

int vtkMRMLAnnotationNode::DeleteAttribute	(	vtkIdType	idAttEntry,
		vtkIdType	idAttType )

◆ DeleteText()

int vtkMRMLAnnotationNode::DeleteText ( int id )

◆ GetAnnotationAttribute()

int vtkMRMLAnnotationNode::GetAnnotationAttribute	(	vtkIdType	id,
		int	att )

◆ GetAnnotationAttributes()

vtkDataArray * vtkMRMLAnnotationNode::GetAnnotationAttributes ( int att )

◆ GetAnnotationTextDisplayNode()

vtkMRMLAnnotationTextDisplayNode * vtkMRMLAnnotationNode::GetAnnotationTextDisplayNode ( )

◆ GetAttributeTypesEnumAsString()

virtual const char * vtkMRMLAnnotationNode::GetAttributeTypesEnumAsString ( int val )

virtual

Reimplemented in vtkMRMLAnnotationControlPointsNode, and vtkMRMLAnnotationLinesNode.

◆ GetClassName()

virtual const char * vtkMRMLAnnotationNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLModelNode.

Reimplemented in vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationFiducialNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationSnapshotNode.

◆ GetDefaultStorageNodeClassName()

std::string vtkMRMLAnnotationNode::GetDefaultStorageNodeClassName ( const char * filename )

overridevirtual

Determines the most appropriate storage node class for the provided file name and node content. If the method is not overwritten by subclass then it uses CreateDefaultStorageNode to determine storage node class name.

Reimplemented from vtkMRMLStorableNode.

◆ GetIcon()

virtual const char * vtkMRMLAnnotationNode::GetIcon ( )

inlinevirtual

Reimplemented in vtkMRMLAnnotationFiducialNode, vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationSnapshotNode.

Definition at line 40 of file vtkMRMLAnnotationNode.h.

◆ GetLines()

vtkCellArray * vtkMRMLAnnotationNode::GetLines ( )

protected

◆ GetLocked()

virtual int vtkMRMLAnnotationNode::GetLocked ( )

virtual

If set to 1 then parameters should not be changed. Fires vtkMRMLAnnotationNode::LockModifiedEvent if changed except if GetDisableModifiedEvent() is true.

◆ GetNodeTagName()

const char * vtkMRMLAnnotationNode::GetNodeTagName ( )

inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationSnapshotNode.

Definition at line 49 of file vtkMRMLAnnotationNode.h.

◆ GetNumberOfTexts()

int vtkMRMLAnnotationNode::GetNumberOfTexts ( )

◆ GetPoints()

vtkPoints * vtkMRMLAnnotationNode::GetPoints ( )

protected

◆ GetReferenceNodeID()

virtual char * vtkMRMLAnnotationNode::GetReferenceNodeID ( )

virtual

◆ GetText()

std::string vtkMRMLAnnotationNode::GetText ( int id )

◆ GetTextScale()

double vtkMRMLAnnotationNode::GetTextScale ( )

Get the text scale of the associated text.

◆ Initialize()

virtual void vtkMRMLAnnotationNode::Initialize ( vtkMRMLScene * mrmlScene )

virtual

Reimplemented in vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, and vtkMRMLAnnotationROINode.

◆ IsA()

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

virtual

Reimplemented from vtkMRMLModelNode.

Reimplemented in vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationFiducialNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationSnapshotNode.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLAnnotationNode * vtkMRMLAnnotationNode::New ( )

static

◆ operator=()

void vtkMRMLAnnotationNode::operator= ( const vtkMRMLAnnotationNode & )

protected

◆ PrintAnnotationInfo()

virtual void vtkMRMLAnnotationNode::PrintAnnotationInfo	(	ostream &	os,
		vtkIndent	indent,
		int	titleFlag = 1 )

virtual

Reimplemented in vtkMRMLAnnotationControlPointsNode, vtkMRMLAnnotationLinesNode, vtkMRMLAnnotationROINode, and vtkMRMLAnnotationRulerNode.

◆ PrintSelf()

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

override

◆ ProcessMRMLEvents()

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

overridevirtual

Propagate events generated in mrml.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLAnnotationROINode, and vtkMRMLAnnotationRulerNode.

◆ ReadXMLAttributes()

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

overridevirtual

Set node attributes

Note: Subclasses should implement this method. Call this method in the subclass implementation.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationSnapshotNode.

◆ ResetAnnotations()

virtual void vtkMRMLAnnotationNode::ResetAnnotations ( )

virtual

Reimplemented in vtkMRMLAnnotationControlPointsNode, and vtkMRMLAnnotationLinesNode.

◆ ResetAttributes()

void vtkMRMLAnnotationNode::ResetAttributes ( int id )

protected

◆ ResetTextAttributesAll()

void vtkMRMLAnnotationNode::ResetTextAttributesAll ( )

protected

◆ SafeDownCast()

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

static

◆ SetAnnotationAttribute()

void vtkMRMLAnnotationNode::SetAnnotationAttribute	(	vtkIdType	id,
		int	att,
		double	value )

◆ SetAttributeSize()

void vtkMRMLAnnotationNode::SetAttributeSize	(	vtkIdType	id,
		vtkIdType	n )

protected

◆ SetLocked()

void vtkMRMLAnnotationNode::SetLocked ( int init )

◆ SetReferenceNodeID()

virtual void vtkMRMLAnnotationNode::SetReferenceNodeID ( const char * )

virtual

◆ SetText()

void vtkMRMLAnnotationNode::SetText	(	int	id,
		const char *	newText,
		int	selectedFlag,
		int	visibleFlag )

◆ SetTextScale()

void vtkMRMLAnnotationNode::SetTextScale ( double textScale )

Set the text scale of the associated text.

◆ UpdateScene()

void vtkMRMLAnnotationNode::UpdateScene ( vtkMRMLScene * )

overridevirtual

Updates other nodes in the scene depending on this node or updates this node if it depends on other nodes when the scene is read in This method is called automatically by XML parser after all nodes are created

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLAnnotationROINode, and vtkMRMLAnnotationRulerNode.

◆ vtkMRMLCopyContentMacro()

vtkMRMLAnnotationNode::vtkMRMLCopyContentMacro ( vtkMRMLAnnotationNode )

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

See also: vtkMRMLNode::CopyContent

◆ WriteXML()

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

overridevirtual

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

Note: Subclasses should implement this method. Call this method in the subclass implementation.

Parameters

indent Deprecated argument that is kept for API backward-compatibility

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationSnapshotNode.

Member Data Documentation

◆ Locked

int vtkMRMLAnnotationNode::Locked

protected

Definition at line 159 of file vtkMRMLAnnotationNode.h.

◆ m_Backup

vtkMRMLAnnotationNode* vtkMRMLAnnotationNode::m_Backup

protected

Definition at line 161 of file vtkMRMLAnnotationNode.h.

◆ m_CameraNode

vtkSmartPointer<vtkMRMLCameraNode> vtkMRMLAnnotationNode::m_CameraNode

protected

Definition at line 166 of file vtkMRMLAnnotationNode.h.

◆ m_GreenSliceNode

vtkSmartPointer<vtkMRMLSliceNode> vtkMRMLAnnotationNode::m_GreenSliceNode

protected

Definition at line 165 of file vtkMRMLAnnotationNode.h.

◆ m_RedSliceNode

vtkSmartPointer<vtkMRMLSliceNode> vtkMRMLAnnotationNode::m_RedSliceNode

protected

Definition at line 163 of file vtkMRMLAnnotationNode.h.

◆ m_YellowSliceNode

vtkSmartPointer<vtkMRMLSliceNode> vtkMRMLAnnotationNode::m_YellowSliceNode

protected

Definition at line 164 of file vtkMRMLAnnotationNode.h.

◆ ReferenceNodeID

char* vtkMRMLAnnotationNode::ReferenceNodeID

protected

Definition at line 157 of file vtkMRMLAnnotationNode.h.

◆ TextList

vtkStringArray* vtkMRMLAnnotationNode::TextList

protected

Definition at line 156 of file vtkMRMLAnnotationNode.h.

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

Modules/Loadable/Annotations/MRML/vtkMRMLAnnotationNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkMRMLAnnotationNode() [1/2]

◆ ~vtkMRMLAnnotationNode()

◆ vtkMRMLAnnotationNode() [2/2]

Member Function Documentation

◆ AddText()

◆ CanApplyNonLinearTransforms()

◆ CreateAnnotationTextDisplayNode()

◆ CreateDefaultStorageNode()

◆ CreateNodeInstance()

◆ CreatePolyData()

◆ DeleteAttribute()

◆ DeleteText()

◆ GetAnnotationAttribute()

◆ GetAnnotationAttributes()

◆ GetAnnotationTextDisplayNode()

◆ GetAttributeTypesEnumAsString()

◆ GetClassName()

◆ GetDefaultStorageNodeClassName()

◆ GetIcon()

◆ GetLines()

◆ GetLocked()

◆ GetNodeTagName()

◆ GetNumberOfTexts()

◆ GetPoints()

◆ GetReferenceNodeID()

◆ GetText()

◆ GetTextScale()

◆ Initialize()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ operator=()

◆ PrintAnnotationInfo()

◆ PrintSelf()

◆ ProcessMRMLEvents()

◆ ReadXMLAttributes()

◆ ResetAnnotations()

◆ ResetAttributes()

◆ ResetTextAttributesAll()

◆ SafeDownCast()

◆ SetAnnotationAttribute()

◆ SetAttributeSize()

◆ SetLocked()

◆ SetReferenceNodeID()

◆ SetText()

◆ SetTextScale()

◆ UpdateScene()

◆ vtkMRMLCopyContentMacro()

◆ WriteXML()

Member Data Documentation

◆ Locked

◆ m_Backup

◆ m_CameraNode

◆ m_GreenSliceNode

◆ m_RedSliceNode

◆ m_YellowSliceNode

◆ ReferenceNodeID

◆ TextList