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
vtkMRMLFiducialListNode Class Reference

MRML node to represent a list of points in 3D. More...

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

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

Public Types

enum  { DisplayModifiedEvent = 19000, PolyDataModifiedEvent = 19001, FiducialModifiedEvent = 19002, FiducialIndexModifiedEvent = 19003 }
 
enum  GlyphShapes {
  GlyphMin = 1, Vertex2D = GlyphMin, Dash2D, Cross2D,
  ThickCross2D, Triangle2D, Square2D, Circle2D,
  Diamond2D, Arrow2D, ThickArrow2D, HookedArrow2D,
  StarBurst2D, Sphere3D, Diamond3D, GlyphMax = Diamond3D
}
 
enum  NumberingSchemes {
  SchemeMin = 0, UseID = SchemeMin, UseIndex, UsePrevious,
  SchemeMax = UsePrevious
}
 Flags to determine how the next fiducial added to the list is labelled. More...
 
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 AddFiducial ()
 Add a fiducial point to the list with default values. More...
 
int AddFiducialWithLabelXYZSelectedVisibility (const char *label, float x, float y, float z, int selected, int visibility)
 Add a fiducial point to the list with a label, x,y,z, selected flag, visibility. More...
 
int AddFiducialWithXYZ (float x, float y, float z, int selected)
 Add a fiducial point to the list x, y, z. More...
 
void ApplyTransform (vtkAbstractTransform *transform) override
 
bool CanApplyNonLinearTransforms () const override
 transform utility functions More...
 
void Copy (vtkMRMLNode *node) override
 Copy the node's attributes to this object. More...
 
vtkMRMLStorageNodeCreateDefaultStorageNode () override
 Create default storage node or nullptr if does not have one. More...
 
vtkMRMLNodeCreateNodeInstance () override
 
virtual double GetAmbient ()
 
virtual const char * GetClassName ()
 
virtual double * GetColor ()
 
virtual void GetColor (double data[3])
 
virtual double GetDiffuse ()
 
int GetFiducialIndex (std::string fiducialID)
 
virtual int GetGlyphType ()
 
const char * GetGlyphTypeAsString ()
 Return a string representing the glyph type, set it from a string. More...
 
const char * GetGlyphTypeAsString (int g)
 
virtual int GetLocked ()
 
int GetMaximumGlyphType ()
 
int GetMinimumGlyphType ()
 Return the min/max glyph types, for iterating over them in tcl. More...
 
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Model) More...
 
const char * GetNthFiducialID (int n)
 get the id of the nth fiducial More...
 
const char * GetNthFiducialLabelText (int n)
 get the label text of the nth fiducial More...
 
float * GetNthFiducialOrientation (int n)
 get the orientation of the nth fiducial More...
 
int GetNthFiducialSelected (int n)
 get the selected state on the nth fiducial More...
 
int GetNthFiducialVisibility (int n)
 get the visible state on the nth fiducial More...
 
float * GetNthFiducialXYZ (int n)
 
int GetNthFiducialXYZWorld (int n, double *worldxyz)
 
virtual int GetNumberingScheme ()
 
const char * GetNumberingSchemeAsString ()
 Return a string representing the numbering scheme, set it from a string. More...
 
const char * GetNumberingSchemeAsString (int g)
 
int GetNumberOfFiducials ()
 Get the number of fiducials in the list. More...
 
virtual double GetOpacity ()
 
virtual double GetPower ()
 
virtual double * GetSelectedColor ()
 
virtual void GetSelectedColor (double data[3])
 
virtual double GetSpecular ()
 
virtual double GetSymbolScale ()
 
virtual double GetTextScale ()
 
virtual int GetVisibility ()
 
int GlyphTypeIs3D (int glyphType)
 Returns 1 if the type is a 3d one, 0 else. More...
 
int GlyphTypeIs3D ()
 
virtual int IsA (const char *type)
 
int IsFiducialPresent (vtkMRMLFiducial *o)
 is this fiducial on the list? More...
 
int MoveFiducialDown (int fidIndex)
 
int MoveFiducialUp (int fidIndex)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) override
 Process events from the MRML scene. More...
 
void ReadXMLAttributes (const char **atts) override
 Set node attributes. More...
 
void RemoveAllFiducials ()
 remove all fiducials from the list More...
 
void RemoveFiducial (vtkMRMLFiducial *o)
 remove the passed in fiducial from the list More...
 
void RemoveFiducial (int i)
 remove the fiducial at index i More...
 
void RenameFiducials (const char *newName)
 
void RenumberFiducials (int startFrom=0)
 
int SetAllFiducialsSelected (int flag)
 Set all fiducials selected state to flag. More...
 
int SetAllFiducialsVisibility (int flag)
 Set all fiducials visible state to flag. More...
 
void SetAmbient (double val)
 Ambient of the fiducial surface expressed as a number from 0 to 1. More...
 
void SetColor (double r, double g, double b)
 
void SetColor (double c[3])
 
void SetDiffuse (double val)
 Diffuse of the fiducial surface expressed as a number from 0 to 1. More...
 
void SetFiducialLabelTextFromID (vtkMRMLFiducial *fid)
 
int SetFiducialXYZ (std::string fiducialID, float x, float y, float z)
 
void SetGlyphType (int type)
 The glyph type used to display this fiducial. More...
 
void SetGlyphTypeFromString (const char *glyphString)
 
void SetLocked (int locked)
 When fiducial lists are locked, they cannot be manipulated using the interactive widgets. More...
 
int SetNthFiducialID (int n, const char *id)
 
int SetNthFiducialLabelText (int n, const char *text)
 
int SetNthFiducialOrientation (int n, float w, float x, float y, float z)
 
int SetNthFiducialSelected (int n, int flag)
 
int SetNthFiducialSelectedNoModified (int n, int flag)
 
int SetNthFiducialVisibility (int n, int flag)
 
int SetNthFiducialVisibilityNoModified (int n, int flag)
 
int SetNthFiducialXYZ (int n, float x, float y, float z)
 
int SetNthFiducialXYZWorld (int n, float x, float y, float z)
 
virtual void SetNumberingScheme (int)
 Flag determining how to number the next added fiducial. More...
 
void SetNumberingSchemeFromString (const char *schemeString)
 
void SetOpacity (double opacity)
 Opacity of the fiducial surface expressed as a number from 0 to 1. More...
 
void SetPower (double val)
 Power of the fiducial surface expressed as a number from 0 to 1. More...
 
void SetSelectedColor (double r, double g, double b)
 Get/Set for colour for when a fiducial is selected. More...
 
void SetSelectedColor (double c[3])
 
void SetSpecular (double val)
 Specular of the fiducial surface expressed as a number from 0 to 1. More...
 
void SetSymbolScale (double scale)
 vtkSetMacro(SymbolScale,double); More...
 
void SetTextScale (double scale)
 
void SetVisibility (int visible)
 
void UpdateReferences () override
 update display node ids More...
 
void UpdateScene (vtkMRMLScene *scene) override
 
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 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
 
void ProcessMRMLEvents (vtkObject *, unsigned long, void *) override
 
alternative method to propagate events generated in Transform nodes More...
 
void ReadXMLAttributes (const char **atts) override
 
Read node attributes from XML file More...
 
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. More...
 
- Public Member Functions inherited from vtkMRMLStorableNode
void AddAndObserveStorageNodeID (const char *storageNodeID)
 
virtual bool AddDefaultStorageNode (const char *filename=nullptr)
 
void Copy (vtkMRMLNode *node) override
 
Copy the node's attributes to this object More...
 
virtual std::string GetDefaultStorageNodeClassName (const char *filename=nullptr)
 
virtual bool GetModifiedSinceRead ()
 
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 ()
 
void UpdateScene (vtkMRMLScene *scene) override
 
Finds the storage node and read the data More...
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeAddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Convenience method that adds a referencedNodeID at the end of the list. More...
 
void AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr)
 Add a referenceRole. More...
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
 
void CopyWithoutModifiedEvent (vtkMRMLNode *node)
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSceneWithSingleModifiedEvent (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSingleModifiedEvent (vtkMRMLNode *node)
 
void DisableModifiedEventOff ()
 
void DisableModifiedEventOn ()
 
virtual int EndModify (int previousDisableModifiedEventState)
 End modifying the node. More...
 
virtual int GetAddToScene ()
 node added to MRML scene. More...
 
const char * GetAttribute (const char *name)
 Get value of a name value pair attribute. More...
 
std::vector< std::string > GetAttributeNames ()
 Get all attribute names. More...
 
void GetAttributeNames (vtkStringArray *attributeNames)
 Get all attribute names. Python-wrappable version. More...
 
virtual char * GetDescription ()
 
virtual int GetDisableModifiedEvent ()
 Turn on/off generating InvokeEvent for set macros. More...
 
virtual int GetHideFromEditors ()
 Describes if the node is hidden. More...
 
virtual char * GetID ()
 ID use by other nodes to reference this node in XML. More...
 
virtual int GetInMRMLCallbackFlag ()
 Flags to avoid event loops. More...
 
virtual int GetModifiedEventPending ()
 
virtual char * GetName ()
 
vtkMRMLNodeGetNodeReference (const char *referenceRole)
 
const char * GetNodeReferenceID (const char *referenceRole)
 Utility function that returns the first node id for a specific referenceRole. More...
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs)
 Return a list of the referenced node IDs. More...
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes)
 Return a list of the referenced nodes. More...
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole. More...
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role. More...
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceRoles ()
 
int GetNumberOfNodeReferences (const char *referenceRole)
 Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...
 
virtual int GetSaveWithScene ()
 Save node with MRML scene. More...
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
virtual bool GetUndoEnabled ()
 
bool HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Return true if referencedNodeID is in the node ID list for a specific referenceRole. More...
 
virtual void HideFromEditorsOff ()
 
virtual void HideFromEditorsOn ()
 
virtual void InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
 This method allows the node to compress events. More...
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending. More...
 
bool IsSingleton ()
 
void Modified () override
 Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...
 
virtual void OnNodeAddedToScene ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void ProcessChildNode (vtkMRMLNode *)
 Set dependencies between this node and a child node when parsing XML file. More...
 
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 SetSelectable (int)
 
virtual void SetSelected (int)
 
void SetSingletonOff ()
 
void SetSingletonOn ()
 
virtual void SetSingletonTag (const char *)
 Tag that make this node a singleton in the scene. More...
 
virtual void SetUndoEnabled (bool)
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events. More...
 
virtual void UndoEnabledOff ()
 
virtual void UndoEnabledOn ()
 
virtual void UpdateReferenceID (const char *oldID, const char *newID)
 Update the stored reference to another node in the scene. More...
 
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 vtkMRMLFiducialListNodeNew ()
 
static vtkMRMLFiducialListNodeSafeDownCast (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

vtkMRMLFiducialGetNthFiducial (int n)
 
void operator= (const vtkMRMLFiducialListNode &)
 
 vtkMRMLFiducialListNode ()
 
 vtkMRMLFiducialListNode (const vtkMRMLFiducialListNode &)
 
 ~vtkMRMLFiducialListNode () 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::map< std::string, std::string > &references)
 
virtual void SetTempURLString (const char *)
 Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More...
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore)
 
virtual void UpdateNodeReferences (const char *referenceRole=nullptr)
 
virtual void UpdateNthNodeReference (const char *referenceRole, int n)
 
 vtkMRMLNode ()
 
 vtkMRMLNode (const vtkMRMLNode &)
 
 ~vtkMRMLNode () override
 critical to have a virtual destructor! More...
 

Protected Attributes

double Ambient
 
double Color [3]
 
double Diffuse
 
vtkCollection * FiducialList
 The collection of fiducial points that make up this list. More...
 
int GlyphType
 
int Locked
 
int NumberingScheme
 How the next added fiducial will be numbered in it's LabelText field. More...
 
double Opacity
 Numbers relating to the display of the fiducials. More...
 
double Power
 
double SelectedColor [3]
 
double Specular
 
double SymbolScale
 
double TextScale
 
int Visibility
 
- Protected Attributes inherited from vtkMRMLStorableNode
std::string SlicerDataType
 
vtkTimeStamp StorableModifiedTime
 
vtkTagTableUserTagTable
 
- Protected Attributes inherited from vtkMRMLNode
int AddToScene
 
AttributesType Attributes
 
char * Description
 
int HideFromEditors
 
char * ID
 
int InMRMLCallbackFlag
 
Flag to avoid event loops More...
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
 
vtkObserverManagerMRMLObserverManager
 
char * Name
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable
 
int Selected
 
bool UndoEnabled
 

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

MRML node to represent a list of points in 3D.

Deprecated:
Used for backward compatibility for Slicer3 fiducial lists, please use the Annotation Module MRML nodes
See also
vtkMRMLAnnotationNode, vtkMRMLAnnotationFiducialNode

Fiducial list nodes describe a list of points in 3d space. They indicate how to render it (color, opacity, etc).

Definition at line 46 of file vtkMRMLFiducialListNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 53 of file vtkMRMLFiducialListNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

DisplayModifiedEvent is generated when display node parameters is changed PolyDataModifiedEvent is generated when something else is changed

Enumerator
DisplayModifiedEvent 
PolyDataModifiedEvent 
FiducialModifiedEvent 
FiducialIndexModifiedEvent 

Definition at line 184 of file vtkMRMLFiducialListNode.h.

◆ GlyphShapes

Which kind of glyph should be used to display this fiducial? Vertex2D is supposed to start at 1

Enumerator
GlyphMin 
Vertex2D 
Dash2D 
Cross2D 
ThickCross2D 
Triangle2D 
Square2D 
Circle2D 
Diamond2D 
Arrow2D 
ThickArrow2D 
HookedArrow2D 
StarBurst2D 
Sphere3D 
Diamond3D 
GlyphMax 

Definition at line 218 of file vtkMRMLFiducialListNode.h.

◆ NumberingSchemes

Flags to determine how the next fiducial added to the list is labelled.

Enumerator
SchemeMin 
UseID 
UseIndex 
UsePrevious 
SchemeMax 

Definition at line 277 of file vtkMRMLFiducialListNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLFiducialListNode() [1/2]

vtkMRMLFiducialListNode::vtkMRMLFiducialListNode ( )
protected

◆ ~vtkMRMLFiducialListNode()

vtkMRMLFiducialListNode::~vtkMRMLFiducialListNode ( )
overrideprotected

◆ vtkMRMLFiducialListNode() [2/2]

vtkMRMLFiducialListNode::vtkMRMLFiducialListNode ( const vtkMRMLFiducialListNode )
protected

Member Function Documentation

◆ AddFiducial()

int vtkMRMLFiducialListNode::AddFiducial ( )

Add a fiducial point to the list with default values.

◆ AddFiducialWithLabelXYZSelectedVisibility()

int vtkMRMLFiducialListNode::AddFiducialWithLabelXYZSelectedVisibility ( const char *  label,
float  x,
float  y,
float  z,
int  selected,
int  visibility 
)

Add a fiducial point to the list with a label, x,y,z, selected flag, visibility.

◆ AddFiducialWithXYZ()

int vtkMRMLFiducialListNode::AddFiducialWithXYZ ( float  x,
float  y,
float  z,
int  selected 
)

Add a fiducial point to the list x, y, z.

◆ ApplyTransform()

void vtkMRMLFiducialListNode::ApplyTransform ( vtkAbstractTransform *  transform)
overridevirtual

Transforms the node with the provided non-linear transform.

See also
SetAndObserveTransformNodeID, ApplyTransformMatrix, CanApplyNonLinearTransforms

Reimplemented from vtkMRMLTransformableNode.

◆ CanApplyNonLinearTransforms()

bool vtkMRMLFiducialListNode::CanApplyNonLinearTransforms ( ) const
overridevirtual

transform utility functions

Reimplemented from vtkMRMLTransformableNode.

◆ Copy()

void vtkMRMLFiducialListNode::Copy ( vtkMRMLNode node)
overridevirtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLNode.

◆ CreateDefaultStorageNode()

vtkMRMLStorageNode* vtkMRMLFiducialListNode::CreateDefaultStorageNode ( )
overridevirtual

Create default storage node or nullptr if does not have one.

Reimplemented from vtkMRMLStorableNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLFiducialListNode::CreateNodeInstance ( )
overridevirtual

MRMLNode methods

Implements vtkMRMLTransformableNode.

◆ GetAmbient()

virtual double vtkMRMLFiducialListNode::GetAmbient ( )
virtual

◆ GetClassName()

virtual const char* vtkMRMLFiducialListNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLTransformableNode.

◆ GetColor() [1/2]

virtual double* vtkMRMLFiducialListNode::GetColor ( )
virtual

◆ GetColor() [2/2]

virtual void vtkMRMLFiducialListNode::GetColor ( double  data[3])
virtual

◆ GetDiffuse()

virtual double vtkMRMLFiducialListNode::GetDiffuse ( )
virtual

◆ GetFiducialIndex()

int vtkMRMLFiducialListNode::GetFiducialIndex ( std::string  fiducialID)

Look through the list of fiducials for fiducialID and return the current zero based index. Useful when delete fiducials from the list, as the index will change. Returns -1 if none found.

◆ GetGlyphType()

virtual int vtkMRMLFiducialListNode::GetGlyphType ( )
virtual

◆ GetGlyphTypeAsString() [1/2]

const char* vtkMRMLFiducialListNode::GetGlyphTypeAsString ( )

Return a string representing the glyph type, set it from a string.

◆ GetGlyphTypeAsString() [2/2]

const char* vtkMRMLFiducialListNode::GetGlyphTypeAsString ( int  g)

◆ GetLocked()

virtual int vtkMRMLFiducialListNode::GetLocked ( )
virtual

◆ GetMaximumGlyphType()

int vtkMRMLFiducialListNode::GetMaximumGlyphType ( )
inline

Definition at line 240 of file vtkMRMLFiducialListNode.h.

◆ GetMinimumGlyphType()

int vtkMRMLFiducialListNode::GetMinimumGlyphType ( )
inline

Return the min/max glyph types, for iterating over them in tcl.

Definition at line 239 of file vtkMRMLFiducialListNode.h.

◆ GetNodeTagName()

const char* vtkMRMLFiducialListNode::GetNodeTagName ( )
inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLTransformableNode.

Definition at line 73 of file vtkMRMLFiducialListNode.h.

◆ GetNthFiducial()

vtkMRMLFiducial* vtkMRMLFiducialListNode::GetNthFiducial ( int  n)
protected

disallow access to the fiducial points by outside classes, have them use SetNthFiducial

◆ GetNthFiducialID()

const char* vtkMRMLFiducialListNode::GetNthFiducialID ( int  n)

get the id of the nth fiducial

◆ GetNthFiducialLabelText()

const char* vtkMRMLFiducialListNode::GetNthFiducialLabelText ( int  n)

get the label text of the nth fiducial

◆ GetNthFiducialOrientation()

float* vtkMRMLFiducialListNode::GetNthFiducialOrientation ( int  n)

get the orientation of the nth fiducial

◆ GetNthFiducialSelected()

int vtkMRMLFiducialListNode::GetNthFiducialSelected ( int  n)

get the selected state on the nth fiducial

◆ GetNthFiducialVisibility()

int vtkMRMLFiducialListNode::GetNthFiducialVisibility ( int  n)

get the visible state on the nth fiducial

◆ GetNthFiducialXYZ()

float* vtkMRMLFiducialListNode::GetNthFiducialXYZ ( int  n)

Get the elements of the fiducial points Return a three element float holding the position

◆ GetNthFiducialXYZWorld()

int vtkMRMLFiducialListNode::GetNthFiducialXYZWorld ( int  n,
double *  worldxyz 
)

Return a three element double giving the world position (any parent transform on the list applied to the return of GetNthFiducialXYZ. worldxyz is a 4 item array, xyzw returns 0 on failure, 1 on success.

◆ GetNumberingScheme()

virtual int vtkMRMLFiducialListNode::GetNumberingScheme ( )
virtual

◆ GetNumberingSchemeAsString() [1/2]

const char* vtkMRMLFiducialListNode::GetNumberingSchemeAsString ( )

Return a string representing the numbering scheme, set it from a string.

◆ GetNumberingSchemeAsString() [2/2]

const char* vtkMRMLFiducialListNode::GetNumberingSchemeAsString ( int  g)

◆ GetNumberOfFiducials()

int vtkMRMLFiducialListNode::GetNumberOfFiducials ( )

Get the number of fiducials in the list.

◆ GetOpacity()

virtual double vtkMRMLFiducialListNode::GetOpacity ( )
virtual

◆ GetPower()

virtual double vtkMRMLFiducialListNode::GetPower ( )
virtual

◆ GetSelectedColor() [1/2]

virtual double* vtkMRMLFiducialListNode::GetSelectedColor ( )
virtual

◆ GetSelectedColor() [2/2]

virtual void vtkMRMLFiducialListNode::GetSelectedColor ( double  data[3])
virtual

◆ GetSpecular()

virtual double vtkMRMLFiducialListNode::GetSpecular ( )
virtual

◆ GetSymbolScale()

virtual double vtkMRMLFiducialListNode::GetSymbolScale ( )
virtual

◆ GetTextScale()

virtual double vtkMRMLFiducialListNode::GetTextScale ( )
virtual

◆ GetVisibility()

virtual int vtkMRMLFiducialListNode::GetVisibility ( )
virtual

◆ GlyphTypeIs3D() [1/2]

int vtkMRMLFiducialListNode::GlyphTypeIs3D ( int  glyphType)

Returns 1 if the type is a 3d one, 0 else.

◆ GlyphTypeIs3D() [2/2]

int vtkMRMLFiducialListNode::GlyphTypeIs3D ( )
inline

Definition at line 247 of file vtkMRMLFiducialListNode.h.

◆ IsA()

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

Reimplemented from vtkMRMLTransformableNode.

◆ IsFiducialPresent()

int vtkMRMLFiducialListNode::IsFiducialPresent ( vtkMRMLFiducial o)

is this fiducial on the list?

◆ IsTypeOf()

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

◆ MoveFiducialDown()

int vtkMRMLFiducialListNode::MoveFiducialDown ( int  fidIndex)

◆ MoveFiducialUp()

int vtkMRMLFiducialListNode::MoveFiducialUp ( int  fidIndex)

move a fiducial point in the collection, one up/down returns -1 on failure (current index is out of bounds, the fid is already at the top or bottom of the list), the new fiducial index on success

◆ New()

static vtkMRMLFiducialListNode* vtkMRMLFiducialListNode::New ( )
static
Deprecated:
Used for backward compatibility for Slicer3 fiducial lists, please use the Annotation Module MRML nodes
See also
vtkMRMLAnnotationNode, vtkMRMLAnnotationFiducialNode

◆ operator=()

void vtkMRMLFiducialListNode::operator= ( const vtkMRMLFiducialListNode )
protected

◆ PrintSelf()

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

◆ ProcessMRMLEvents()

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

Process events from the MRML scene.

Reimplemented from vtkMRMLNode.

◆ ReadXMLAttributes()

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

Set node attributes.

Reimplemented from vtkMRMLNode.

◆ RemoveAllFiducials()

void vtkMRMLFiducialListNode::RemoveAllFiducials ( )

remove all fiducials from the list

◆ RemoveFiducial() [1/2]

void vtkMRMLFiducialListNode::RemoveFiducial ( vtkMRMLFiducial o)

remove the passed in fiducial from the list

◆ RemoveFiducial() [2/2]

void vtkMRMLFiducialListNode::RemoveFiducial ( int  i)

remove the fiducial at index i

◆ RenameFiducials()

void vtkMRMLFiducialListNode::RenameFiducials ( const char *  newName)

Reanme all the fiducials in the active list. It preserves any numbers already on the ends of the labels.

◆ RenumberFiducials()

void vtkMRMLFiducialListNode::RenumberFiducials ( int  startFrom = 0)

Renumber all the fiducials in the active list. It first removes any numbers from the ends of the label texts and then appends numbers starting from 0 by default.

◆ SafeDownCast()

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

◆ SetAllFiducialsSelected()

int vtkMRMLFiducialListNode::SetAllFiducialsSelected ( int  flag)

Set all fiducials selected state to flag.

◆ SetAllFiducialsVisibility()

int vtkMRMLFiducialListNode::SetAllFiducialsVisibility ( int  flag)

Set all fiducials visible state to flag.

◆ SetAmbient()

void vtkMRMLFiducialListNode::SetAmbient ( double  val)

Ambient of the fiducial surface expressed as a number from 0 to 1.

◆ SetColor() [1/2]

void vtkMRMLFiducialListNode::SetColor ( double  r,
double  g,
double  b 
)

Get/Set for Glyph and Text color vtkSetVector3Macro(Color,double);

◆ SetColor() [2/2]

void vtkMRMLFiducialListNode::SetColor ( double  c[3])

◆ SetDiffuse()

void vtkMRMLFiducialListNode::SetDiffuse ( double  val)

Diffuse of the fiducial surface expressed as a number from 0 to 1.

◆ SetFiducialLabelTextFromID()

void vtkMRMLFiducialListNode::SetFiducialLabelTextFromID ( vtkMRMLFiducial fid)

Generate the label text for a fiducial from it's id. If NumberingScheme is UseID, uses the ID (default). If NumberingScheme is UseIndex, strips the ID of any trailing numbers and appends the fiducial's index to it. If NumberingScheme is UsePrevious, checks the previous fiducial in the list for a trailing number and increments it by 1, and appends the new number. If it's the first fiducial, uses 0. If the previous fiducial has no trailing number in it's label text, will use 1.

◆ SetFiducialXYZ()

int vtkMRMLFiducialListNode::SetFiducialXYZ ( std::string  fiducialID,
float  x,
float  y,
float  z 
)

Restrict access to the fiducial points, access the fiducial by id (used by the vtkSlicerFiducialListWidget). Returns 0 on success.

◆ SetGlyphType()

void vtkMRMLFiducialListNode::SetGlyphType ( int  type)

The glyph type used to display this fiducial.

◆ SetGlyphTypeFromString()

void vtkMRMLFiducialListNode::SetGlyphTypeFromString ( const char *  glyphString)

◆ SetLocked()

void vtkMRMLFiducialListNode::SetLocked ( int  locked)

When fiducial lists are locked, they cannot be manipulated using the interactive widgets.

◆ SetNthFiducialID()

int vtkMRMLFiducialListNode::SetNthFiducialID ( int  n,
const char *  id 
)

◆ SetNthFiducialLabelText()

int vtkMRMLFiducialListNode::SetNthFiducialLabelText ( int  n,
const char *  text 
)

◆ SetNthFiducialOrientation()

int vtkMRMLFiducialListNode::SetNthFiducialOrientation ( int  n,
float  w,
float  x,
float  y,
float  z 
)

◆ SetNthFiducialSelected()

int vtkMRMLFiducialListNode::SetNthFiducialSelected ( int  n,
int  flag 
)

◆ SetNthFiducialSelectedNoModified()

int vtkMRMLFiducialListNode::SetNthFiducialSelectedNoModified ( int  n,
int  flag 
)

◆ SetNthFiducialVisibility()

int vtkMRMLFiducialListNode::SetNthFiducialVisibility ( int  n,
int  flag 
)

◆ SetNthFiducialVisibilityNoModified()

int vtkMRMLFiducialListNode::SetNthFiducialVisibilityNoModified ( int  n,
int  flag 
)

◆ SetNthFiducialXYZ()

int vtkMRMLFiducialListNode::SetNthFiducialXYZ ( int  n,
float  x,
float  y,
float  z 
)

Restrict access to the fiducial points, pass in a value via the list so that the appropriate events can be invoked. Returns 0 on success

◆ SetNthFiducialXYZWorld()

int vtkMRMLFiducialListNode::SetNthFiducialXYZWorld ( int  n,
float  x,
float  y,
float  z 
)

Set the nth fiducial to xyz transformed by the inverse of the transform to world for the list. Calls SetNthFiducialXYZ after transforming the passed in coordinates and returns the result of that call.

◆ SetNumberingScheme()

virtual void vtkMRMLFiducialListNode::SetNumberingScheme ( int  )
virtual

Flag determining how to number the next added fiducial.

◆ SetNumberingSchemeFromString()

void vtkMRMLFiducialListNode::SetNumberingSchemeFromString ( const char *  schemeString)

◆ SetOpacity()

void vtkMRMLFiducialListNode::SetOpacity ( double  opacity)

Opacity of the fiducial surface expressed as a number from 0 to 1.

◆ SetPower()

void vtkMRMLFiducialListNode::SetPower ( double  val)

Power of the fiducial surface expressed as a number from 0 to 1.

◆ SetSelectedColor() [1/2]

void vtkMRMLFiducialListNode::SetSelectedColor ( double  r,
double  g,
double  b 
)

Get/Set for colour for when a fiducial is selected.

◆ SetSelectedColor() [2/2]

void vtkMRMLFiducialListNode::SetSelectedColor ( double  c[3])

◆ SetSpecular()

void vtkMRMLFiducialListNode::SetSpecular ( double  val)

Specular of the fiducial surface expressed as a number from 0 to 1.

◆ SetSymbolScale()

void vtkMRMLFiducialListNode::SetSymbolScale ( double  scale)

vtkSetMacro(SymbolScale,double);

Get/Set for Symbol scale

◆ SetTextScale()

void vtkMRMLFiducialListNode::SetTextScale ( double  scale)

Get/Set for Text scale vtkSetMacro(TextScale,double);

◆ SetVisibility()

void vtkMRMLFiducialListNode::SetVisibility ( int  visible)

Get/Set for list visibility vtkSetMacro(Visibility,int);

◆ UpdateReferences()

void vtkMRMLFiducialListNode::UpdateReferences ( )
overridevirtual

update display node ids

Reimplemented from vtkMRMLNode.

◆ UpdateScene()

void vtkMRMLFiducialListNode::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.

◆ WriteXML()

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

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

Reimplemented from vtkMRMLNode.

Member Data Documentation

◆ Ambient

double vtkMRMLFiducialListNode::Ambient
protected

Definition at line 325 of file vtkMRMLFiducialListNode.h.

◆ Color

double vtkMRMLFiducialListNode::Color[3]
protected

Definition at line 317 of file vtkMRMLFiducialListNode.h.

◆ Diffuse

double vtkMRMLFiducialListNode::Diffuse
protected

Definition at line 326 of file vtkMRMLFiducialListNode.h.

◆ FiducialList

vtkCollection* vtkMRMLFiducialListNode::FiducialList
protected

The collection of fiducial points that make up this list.

Definition at line 321 of file vtkMRMLFiducialListNode.h.

◆ GlyphType

int vtkMRMLFiducialListNode::GlyphType
protected

Definition at line 330 of file vtkMRMLFiducialListNode.h.

◆ Locked

int vtkMRMLFiducialListNode::Locked
protected

Definition at line 329 of file vtkMRMLFiducialListNode.h.

◆ NumberingScheme

int vtkMRMLFiducialListNode::NumberingScheme
protected

How the next added fiducial will be numbered in it's LabelText field.

Definition at line 333 of file vtkMRMLFiducialListNode.h.

◆ Opacity

double vtkMRMLFiducialListNode::Opacity
protected

Numbers relating to the display of the fiducials.

Definition at line 324 of file vtkMRMLFiducialListNode.h.

◆ Power

double vtkMRMLFiducialListNode::Power
protected

Definition at line 328 of file vtkMRMLFiducialListNode.h.

◆ SelectedColor

double vtkMRMLFiducialListNode::SelectedColor[3]
protected

Definition at line 318 of file vtkMRMLFiducialListNode.h.

◆ Specular

double vtkMRMLFiducialListNode::Specular
protected

Definition at line 327 of file vtkMRMLFiducialListNode.h.

◆ SymbolScale

double vtkMRMLFiducialListNode::SymbolScale
protected

Definition at line 314 of file vtkMRMLFiducialListNode.h.

◆ TextScale

double vtkMRMLFiducialListNode::TextScale
protected

Definition at line 315 of file vtkMRMLFiducialListNode.h.

◆ Visibility

int vtkMRMLFiducialListNode::Visibility
protected

Definition at line 316 of file vtkMRMLFiducialListNode.h.


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