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

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

Inheritance diagram for vtkMRMLAnnotationNode:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLAnnotationNode:
Collaboration graph
[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 modidied. 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
}
 
typedef vtkObject Superclass
 

Public Member Functions

int AddText (const char *newText, int selectedFlag, int visibleFlag)
 
bool CanApplyNonLinearTransforms () const override
 
void ClearBackup ()
 
void CreateAnnotationTextDisplayNode ()
 
void CreateBackup ()
 Creates a backup of the current MRML state of this node and keeps a reference. More...
 
vtkMRMLStorageNodeCreateDefaultStorageNode () override
 
vtkMRMLNodeCreateNodeInstance () override
 MRMLNode methods. More...
 
int DeleteAttribute (vtkIdType idAttEntry, vtkIdType idAttType)
 
int DeleteText (int id)
 
int GetAnnotationAttribute (vtkIdType id, int att)
 
vtkDataArray * GetAnnotationAttributes (int att)
 
vtkMRMLAnnotationTextDisplayNodeGetAnnotationTextDisplayNode ()
 
virtual const char * GetAttributeTypesEnumAsString (int val)
 
vtkMRMLAnnotationNodeGetBackup ()
 Returns the associated backup of this node. More...
 
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) More...
 
int GetNumberOfTexts ()
 
virtual char * GetReferenceNodeID ()
 
vtkStdString GetText (int id)
 
double GetTextScale ()
 Get the text scale of the associated text. More...
 
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
 alternative method to propagate events generated in Display nodes More...
 
void ReadXMLAttributes (const char **atts) override
 
Read node attributes from XML file More...
 
virtual void ResetAnnotations ()
 
void RestoreBackup ()
 Restore an attached backup of this node. More...
 
void RestoreView ()
 Restores a previously saved view. More...
 
void SaveView ()
 Saves the current view. More...
 
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. More...
 
void UpdateScene (vtkMRMLScene *scene) override
 
Finds the storage node and read the data More...
 
 vtkMRMLCopyContentMacro (vtkMRMLAnnotationNode)
 
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 vtkMRMLModelNode
void AddCellScalars (vtkDataArray *array)
 
void AddPointScalars (vtkDataArray *array)
 Utility function that adds an array to the mesh's point data. /. More...
 
void AddScalars (vtkDataArray *array, int location)
 
void ApplyTransform (vtkAbstractTransform *transform) 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. More...
 
const char * GetActiveCellScalarName (int type)
 
const char * GetActivePointScalarName (int type)
 
void GetBounds (double bounds[6]) override
 
virtual vtkPointSet * GetMesh ()
 
virtual vtkAlgorithmOutput * GetMeshConnection ()
 
virtual MeshTypeHint GetMeshType ()
 
vtkMRMLModelDisplayNodeGetModelDisplayNode ()
 Get associated model display MRML node. More...
 
bool GetModifiedSinceRead () override
 
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 RemoveScalars (const char *scalarName)
 Remove an array from the mesh's point/cell data. More...
 
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)
 
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 More...
 
virtual void CreateDefaultSequenceDisplayNodes ()
 
virtual int GetDisplayClassVisibility (const char *nodeClass)
 
vtkMRMLDisplayNodeGetDisplayNode ()
 
const char * GetDisplayNodeID ()
 
virtual const char * GetDisplayNodeReferenceRole ()
 
virtual int GetDisplayVisibility ()
 
vtkMRMLDisplayNodeGetNthDisplayNode (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. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void RemoveAllDisplayNodeIDs ()
 
Remove all display node IDs and associated display nodes. More...
 
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)=0, int vtkNotUsed(multipleFlag)=1)
 
- Public Member Functions inherited from vtkMRMLTransformableNode
virtual void ApplyTransformMatrix (vtkMatrix4x4 *transformMatrix)
 
vtkMRMLTransformNodeGetParentTransformNode ()
 
Associated transform MRML node More...
 
const char * GetTransformNodeID ()
 Get referenced transform node id. More...
 
bool HardenTransform ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
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)
 
- Public Member Functions inherited from vtkMRMLStorableNode
void AddAndObserveStorageNodeID (const char *storageNodeID)
 
virtual bool AddDefaultStorageNode (const char *filename=nullptr)
 
virtual vtkMRMLStorageNodeCreateDefaultSequenceStorageNode ()
 
vtkMRMLStorageNodeGetNthStorageNode (int n)
 
Get associated display MRML node More...
 
const char * GetNthStorageNodeID (int n)
 
int GetNumberOfStorageNodes ()
 
const char * GetSlicerDataType ()
 
vtkMRMLStorageNodeGetStorageNode ()
 
const char * GetStorageNodeID ()
 
virtual vtkTagTableGetUserTagTable ()
 Methods for user-specified metadata. More...
 
bool HasStorageNodeID (const char *storageNodeID)
 
Return true if storageNodeID is in the storage node ID list. More...
 
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 More...
 
void SetSlicerDataType (const char *type)
 
virtual void StorableModified ()
 
 vtkMRMLCopyContentMacro (vtkMRMLStorableNode)
 
- 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 CopyContent (vtkMRMLNode *node, bool deepCopy=true)
 Copy node contents from another node of the same type. Does not copy node ID, Scene, Name, SingletonTag, HideFromEditors, AddToScene, UndoEnabled, and node references. If deepCopy is set to false then a shallow copy of bulk data (such as image or mesh data) could be made; copying may be faster but the node may share some data with the source node instead of creating an independent copy. More...
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void DisableModifiedEventOff ()
 
void DisableModifiedEventOn ()
 
virtual int EndModify (int previousDisableModifiedEventState)
 End modifying the node. More...
 
virtual int GetAddToScene ()
 node added to MRML scene. More...
 
const char * GetAttribute (const char *name)
 Get value of a name value pair attribute. More...
 
std::vector< std::string > GetAttributeNames ()
 Get all attribute names. More...
 
void GetAttributeNames (vtkStringArray *attributeNames)
 Get all attribute names. Python-wrappable version. More...
 
virtual vtkIntArray * GetContentModifiedEvents ()
 
virtual char * GetDescription ()
 
virtual int GetDisableModifiedEvent ()
 Turn on/off generating InvokeEvent for set macros. More...
 
virtual int GetHideFromEditors ()
 Describes if the node is hidden. More...
 
virtual char * GetID ()
 ID use by other nodes to reference this node in XML. More...
 
virtual int GetInMRMLCallbackFlag ()
 Flags to avoid event loops. More...
 
virtual int GetModifiedEventPending ()
 
virtual char * GetName ()
 
vtkMRMLNodeGetNodeReference (const char *referenceRole)
 
const char * GetNodeReferenceID (const char *referenceRole)
 Utility function that returns the first node id for a specific referenceRole. More...
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs)
 Return a list of the referenced node IDs. More...
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes)
 Return a list of the referenced nodes. More...
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole. More...
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role. More...
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceRoles ()
 
int GetNumberOfNodeReferences (const char *referenceRole)
 Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...
 
virtual int GetSaveWithScene ()
 Save node with MRML scene. More...
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
virtual bool GetUndoEnabled ()
 
virtual bool HasCopyContent () const
 Returns true if the class supports deep and shallow copying node content. More...
 
bool HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Return true if referencedNodeID is in the node ID list for a specific referenceRole. More...
 
virtual void HideFromEditorsOff ()
 
virtual void HideFromEditorsOn ()
 
virtual void InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
 This method allows the node to compress events. More...
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending. More...
 
bool IsSingleton ()
 
void Modified () override
 Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...
 
virtual void OnNodeAddedToScene ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void ProcessChildNode (vtkMRMLNode *)
 Set dependencies between this node and a child node when parsing XML file. More...
 
void RemoveAttribute (const char *name)
 Remove attribute with the specified name. More...
 
void RemoveNodeReferenceIDs (const char *referenceRole)
 Remove all node IDs and associated nodes for a specific referenceRole. More...
 
void RemoveNthNodeReferenceID (const char *referenceRole, int n)
 Convenience method that removes the Nth node ID from the list. More...
 
virtual void Reset (vtkMRMLNode *defaultNode)
 Reset node attributes to the initial state as defined in the constructor or the passed default node. More...
 
virtual void SaveWithSceneOff ()
 
virtual void SaveWithSceneOn ()
 
virtual void SelectableOff ()
 
virtual void SelectableOn ()
 
virtual void SelectedOff ()
 
virtual void SelectedOn ()
 
virtual void SetAddToScene (int)
 
void SetAddToSceneNoModify (int value)
 
vtkMRMLNodeSetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe the Nth node ID for a specific reference role. More...
 
void SetAttribute (const char *name, const char *value)
 Set a name value pair attribute. More...
 
virtual void SetDescription (const char *)
 Text description of this node, to be set by the user. More...
 
void SetDisableModifiedEvent (int onOff)
 
virtual void SetHideFromEditors (int)
 
void SetInMRMLCallbackFlag (int flag)
 
virtual void SetName (const char *)
 Name of this node, to be set by the user. More...
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
 Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More...
 
virtual void SetSaveWithScene (int)
 
virtual void SetScene (vtkMRMLScene *scene)
 This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene. More...
 
virtual void SetSceneReferences ()
 Update the references of the node to the scene. More...
 
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...
 
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 int IsTypeOf (const char *type)
 
static vtkMRMLAnnotationNodeNew ()
 
static vtkMRMLAnnotationNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLModelNode
static int GetAttributeTypeFromString (const char *typeName)
 
static int IsTypeOf (const char *type)
 
static vtkMRMLModelNodeNew ()
 
static vtkMRMLModelNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLDisplayableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLDisplayableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLTransformableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLTransformableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLStorableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLStorableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (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). More...
 
void OnNodeReferenceModified (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is modified. More...
 
void operator= (const vtkMRMLModelNode &)
 
virtual void SetMeshConnection (vtkAlgorithmOutput *inputPort)
 Called by SetPolyDataConnection and SetUnstructuredGridConnection. More...
 
virtual void SetMeshToDisplayNode (vtkMRMLModelDisplayNode *modelDisplayNode)
 
void SetMeshToDisplayNodes ()
 
virtual void UpdateDisplayNodeMesh (vtkMRMLDisplayNode *dnode)
 
 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). More...
 
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). More...
 
void OnNodeReferenceModified (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is modified. More...
 
void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) override
 
Called after a node reference ID is removed (list size decreased). More...
 
virtual void OnTransformNodeReferenceChanged (vtkMRMLTransformNode *transformNode)
 Called when transform node reference added/modified/removed. More...
 
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. 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...
 
void operator= (const vtkMRMLNode &)
 
void ParseReferencesAttribute (const char *attValue, std::set< 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 Locked
 
vtkMRMLAnnotationNodem_Backup
 
vtkSmartPointer< vtkMRMLCameraNodem_CameraNode
 
vtkSmartPointer< vtkMRMLSliceNodem_GreenSliceNode
 
vtkSmartPointer< vtkMRMLSliceNodem_RedSliceNode
 
vtkSmartPointer< vtkMRMLSliceNodem_YellowSliceNode
 
char * ReferenceNodeID
 
vtkStringArray * TextList
 
- Protected Attributes inherited from vtkMRMLModelNode
vtkEventForwarderCommand * DataEventForwarder
 
vtkAlgorithmOutput * MeshConnection
 Data. More...
 
MeshTypeHint MeshType
 
- Protected Attributes inherited from vtkMRMLStorableNode
std::string SlicerDataType
 
vtkTimeStamp StorableModifiedTime
 
vtkTagTableUserTagTable
 
- Protected Attributes inherited from vtkMRMLNode
int AddToScene {1}
 
AttributesType Attributes
 
vtkIntArray * ContentModifiedEvents
 
char * Description {nullptr}
 
int HideFromEditors {0}
 
char * ID {nullptr}
 
int InMRMLCallbackFlag {0}
 
Flag to avoid event loops More...
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
 
vtkObserverManagerMRMLObserverManager
 
char * Name {nullptr}
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene {true}
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable {1}
 
int Selected {0}
 
bool UndoEnabled {false}
 

Additional Inherited Members

- Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string > AttributesType
 
typedef std::map< std::string, vtkSmartPointer< vtkIntArray > > NodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 
- Static Protected Member Functions inherited from 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 28 of file vtkMRMLAnnotationNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 32 of file vtkMRMLAnnotationNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
TEXT_SELECTED 
TEXT_VISIBLE 
NUM_TEXT_ATTRIBUTE_TYPES 
LockModifiedEvent 

Definition at line 90 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 vtkMRMLModelNode.

Definition at line 81 of file vtkMRMLAnnotationNode.h.

◆ ClearBackup()

void vtkMRMLAnnotationNode::ClearBackup ( )

◆ CreateAnnotationTextDisplayNode()

void vtkMRMLAnnotationNode::CreateAnnotationTextDisplayNode ( )

◆ CreateBackup()

void vtkMRMLAnnotationNode::CreateBackup ( )

Creates a backup of the current MRML state of this node and keeps a reference.

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

Reimplemented in vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationSnapshotNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLAnnotationNode::CreateNodeInstance ( )
overridevirtual

◆ 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

◆ GetBackup()

vtkMRMLAnnotationNode* vtkMRMLAnnotationNode::GetBackup ( )

Returns the associated backup of this node.

◆ GetClassName()

virtual const char* vtkMRMLAnnotationNode::GetClassName ( )
virtual

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

◆ GetIcon()

virtual const char* vtkMRMLAnnotationNode::GetIcon ( )
inlinevirtual

◆ 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

◆ GetNumberOfTexts()

int vtkMRMLAnnotationNode::GetNumberOfTexts ( )

◆ GetPoints()

vtkPoints* vtkMRMLAnnotationNode::GetPoints ( )
protected

◆ GetReferenceNodeID()

virtual char* vtkMRMLAnnotationNode::GetReferenceNodeID ( )
virtual

◆ GetText()

vtkStdString vtkMRMLAnnotationNode::GetText ( int  id)

◆ GetTextScale()

double vtkMRMLAnnotationNode::GetTextScale ( )

Get the text scale of the associated text.

◆ Initialize()

virtual void vtkMRMLAnnotationNode::Initialize ( vtkMRMLScene mrmlScene)
virtual

◆ IsA()

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

◆ 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

◆ PrintSelf()

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

◆ ProcessMRMLEvents()

void vtkMRMLAnnotationNode::ProcessMRMLEvents ( vtkObject *  ,
unsigned  long,
void *   
)
overridevirtual

alternative method to propagate events generated in Display nodes

Reimplemented from vtkMRMLModelNode.

Reimplemented in vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationSplineNode.

◆ ReadXMLAttributes()

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


Read node attributes from XML file

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLAnnotationSnapshotNode, vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationSplineNode.

◆ ResetAnnotations()

virtual void vtkMRMLAnnotationNode::ResetAnnotations ( )
virtual

◆ ResetAttributes()

void vtkMRMLAnnotationNode::ResetAttributes ( int  id)
protected

◆ ResetTextAttributesAll()

void vtkMRMLAnnotationNode::ResetTextAttributesAll ( )
protected

◆ RestoreBackup()

void vtkMRMLAnnotationNode::RestoreBackup ( )

Restore an attached backup of this node.

◆ RestoreView()

void vtkMRMLAnnotationNode::RestoreView ( )

Restores a previously saved view.

◆ SafeDownCast()

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

◆ SaveView()

void vtkMRMLAnnotationNode::SaveView ( )

Saves the current view.

◆ 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 scene)
overridevirtual


Finds the storage node and read the data

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLAnnotationROINode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationSplineNode.

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

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLAnnotationROINode, vtkMRMLAnnotationSnapshotNode, vtkMRMLAnnotationRulerNode, and vtkMRMLAnnotationSplineNode.

Member Data Documentation

◆ Locked

int vtkMRMLAnnotationNode::Locked
protected

Definition at line 172 of file vtkMRMLAnnotationNode.h.

◆ m_Backup

vtkMRMLAnnotationNode* vtkMRMLAnnotationNode::m_Backup
protected

Definition at line 174 of file vtkMRMLAnnotationNode.h.

◆ m_CameraNode

vtkSmartPointer<vtkMRMLCameraNode> vtkMRMLAnnotationNode::m_CameraNode
protected

Definition at line 179 of file vtkMRMLAnnotationNode.h.

◆ m_GreenSliceNode

vtkSmartPointer<vtkMRMLSliceNode> vtkMRMLAnnotationNode::m_GreenSliceNode
protected

Definition at line 178 of file vtkMRMLAnnotationNode.h.

◆ m_RedSliceNode

vtkSmartPointer<vtkMRMLSliceNode> vtkMRMLAnnotationNode::m_RedSliceNode
protected

Definition at line 176 of file vtkMRMLAnnotationNode.h.

◆ m_YellowSliceNode

vtkSmartPointer<vtkMRMLSliceNode> vtkMRMLAnnotationNode::m_YellowSliceNode
protected

Definition at line 177 of file vtkMRMLAnnotationNode.h.

◆ ReferenceNodeID

char* vtkMRMLAnnotationNode::ReferenceNodeID
protected

Definition at line 170 of file vtkMRMLAnnotationNode.h.

◆ TextList

vtkStringArray* vtkMRMLAnnotationNode::TextList
protected

Definition at line 169 of file vtkMRMLAnnotationNode.h.


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