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

#include <Modules/Loadable/Markups/MRML/vtkMRMLMarkupsNode.h>

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

Classes

struct  ControlPoint
 

Public Types

enum  {
  LockModifiedEvent = 19000, LabelFormatModifiedEvent, PointAddedEvent, PointRemovedEvent,
  PointModifiedEvent, PointStartInteractionEvent, PointEndInteractionEvent, CenterPointModifiedEvent
}
 
enum  { PositionUndefined, PositionPreview, PositionDefined }
 
typedef std::vector< ControlPoint * > ControlPointsListType
 
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 AddControlPoint (vtkVector3d point, std::string label=std::string())
 Add a new control point, returning the point index, -1 on failure. More...
 
int AddControlPoint (ControlPoint *controlPoint)
 
int AddControlPointWorld (vtkVector3d point, std::string label=std::string())
 
int AddNControlPoints (int n, std::string label=std::string(), vtkVector3d *point=nullptr)
 
void ApplyTransform (vtkAbstractTransform *transform) override
 
bool CanApplyNonLinearTransforms () const override
 
bool ControlPointExists (int n)
 Return true if n is a valid control point, false otherwise. More...
 
void Copy (vtkMRMLNode *node) override
 Copy the node's attributes to this object. More...
 
void CreateDefaultDisplayNodes () override
 Create and observe default display node(s) More...
 
vtkMRMLStorageNodeCreateDefaultStorageNode () override
 Create default storage node or nullptr if does not have one. More...
 
vtkMRMLNodeCreateNodeInstance () override
 MRMLNode methods. More...
 
void GetBounds (double bounds[6]) override
 
void GetCenterPosition (double point[3])
 
vtkVector3d GetCenterPositionVector ()
 
int GetCenterPositionWorld (double worldxyz[3])
 
virtual const char * GetClassName ()
 
int GetClosestControlPointIndexToPositionWorld (double pos[3])
 Get the index of the closest control point to the world coordinates. More...
 
int GetControlPointIndexFromInterpolatedPointIndex (vtkIdType interpolatedPointIndex)
 
void GetControlPointLabels (vtkStringArray *labels)
 
std::vector< ControlPoint * > * GetControlPoints ()
 Return a pointer to the std::vector of control points stored in this node. More...
 
virtual bool GetCurveClosed ()
 
vtkCurveGeneratorGetCurveGenerator ()
 
vtkPoints * GetCurvePointsWorld ()
 
vtkPolyData * GetCurveWorld ()
 
vtkAlgorithmOutput * GetCurveWorldConnection ()
 
virtual const char * GetIcon ()
 
virtual int GetLocked ()
 Get the Locked property on the markupNode/list of control points. More...
 
std::string GetMarkupLabelFormat ()
 
void GetMarkupPoint (int markupIndex, int pointIndex, double point[3])
 
vtkVector3d GetMarkupPointVector (int markupIndex, int)
 
vtkMRMLMarkupsDisplayNodeGetMarkupsDisplayNode ()
 Return a cast display node, returns null if none. More...
 
virtual int GetMaximumNumberOfControlPoints ()
 
bool GetModifiedSinceRead () override
 
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Model) More...
 
ControlPointGetNthControlPoint (int n)
 Return a pointer to the Nth control point stored in this node, null if n is out of bounds. More...
 
std::string GetNthControlPointAssociatedNodeID (int n=0)
 Get/Set the associated node id for the Nth control point. More...
 
ControlPointGetNthControlPointByID (const char *controlPointID)
 Get the Nth control point based on it's ID. More...
 
std::string GetNthControlPointDescription (int n=0)
 
std::string GetNthControlPointID (int n)
 Get the id for the Nth control point. More...
 
int GetNthControlPointIndexByID (const char *controlPointID)
 Get the Nth control point index based on it's ID. More...
 
std::string GetNthControlPointLabel (int n=0)
 
bool GetNthControlPointLocked (int n=0)
 
double * GetNthControlPointNormal (int n)
 Get normal direction (orientation of z axis) in local coordinate system. More...
 
void GetNthControlPointNormalWorld (int n, double normalWorld[3])
 Get normal direction (orientation of z axis) in world coordinate system. More...
 
void GetNthControlPointOrientation (int n, double orientationWXYZ[4])
 Get the WXYZ orientation for the Nth control point. More...
 
double * GetNthControlPointOrientationMatrix (int n)
 Get orientation as 9 values: x, y, and z axis directions, respectively. More...
 
vtkVector4d GetNthControlPointOrientationVector (int pointIndex)
 
void GetNthControlPointPosition (int pointIndex, double point[3])
 
double * GetNthControlPointPosition (int pointIndex)
 
int GetNthControlPointPositionStatus (int pointIndex)
 Get control point position status (PositionUndefined, PositionPreview, PositionDefined) More...
 
vtkVector3d GetNthControlPointPositionVector (int pointIndex)
 
int GetNthControlPointPositionWorld (int pointIndex, double worldxyz[3])
 
bool GetNthControlPointSelected (int n=0)
 
bool GetNthControlPointVisibility (int n=0)
 
std::string GetNthMarkupAssociatedNodeID (int n=0)
 
std::string GetNthMarkupID (int n=0)
 
std::string GetNthMarkupLabel (int n=0)
 
bool GetNthMarkupLocked (int n=0)
 
int GetNumberOfControlPoints ()
 Return the number of control points that are stored in this node. More...
 
int GetNumberOfDefinedControlPoints ()
 Return the number of control points that are already placed (not being previewed or undefined). More...
 
int GetNumberOfMarkups ()
 
int GetNumberOfPointsInNthMarkup (int)
 
void GetRASBounds (double bounds[6]) override
 
virtual int GetRequiredNumberOfControlPoints ()
 
bool InsertControlPoint (ControlPoint *controlPoint, int targetIndex)
 
virtual int IsA (const char *type)
 
virtual void LockedOff ()
 
virtual void LockedOn ()
 
bool MarkupExists (int n)
 Depreceated. Use ControlPointExists instead. More...
 
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 RemoveAllControlPoints ()
 Clear out the node of all control points. More...
 
void RemoveAllMarkups ()
 
void RemoveMarkup (int pointIndex)
 
void RemoveNthControlPoint (int pointIndex)
 Remove Nth Control Point. More...
 
std::string ReplaceListNameInMarkupLabelFormat ()
 
bool ResetNthControlPointID (int n)
 
void SetCenterPosition (const double x, const double y, const double z)
 
void SetCenterPositionFromArray (const double pos[3])
 
void SetCenterPositionFromPointer (const double *pos)
 
void SetCenterPositionWorld (const double x, const double y, const double z)
 
void SetLocked (int locked)
 
void SetMarkupLabelFormat (std::string format)
 
void SetNthControlPointAssociatedNodeID (int n, std::string id)
 
void SetNthControlPointDescription (int n, std::string description)
 Set the Description on the Nth control point. More...
 
void SetNthControlPointLabel (int n, std::string label)
 Set the Label on the Nth control point. More...
 
void SetNthControlPointLocked (int n, bool flag)
 
void SetNthControlPointOrientation (int n, double w, double x, double y, double z)
 Set the orientation for the Nth control point from passed parameters. More...
 
void SetNthControlPointOrientationFromArray (int n, const double orientationWXYZ[4])
 Set the orientation for the Nth control point from a double array WXYZ. More...
 
void SetNthControlPointOrientationFromPointer (int n, const double *orientationWXYZ)
 Set the orientation for the Nth control point from a pointer to a double array WXYZ. More...
 
void SetNthControlPointOrientationMatrix (int n, double orientationMatrix[9])
 Set orientation as 9 values: x, y, and z axis directions, respectively. More...
 
void SetNthControlPointOrientationMatrixWorld (int n, double orientationMatrix[9])
 
void SetNthControlPointPosition (const int pointIndex, const double x, const double y, const double z, int positionStatus=PositionDefined)
 
void SetNthControlPointPositionFromArray (const int pointIndex, const double pos[3], int positionStatus=PositionDefined)
 
void SetNthControlPointPositionFromPointer (const int pointIndex, const double *pos)
 
void SetNthControlPointPositionOrientationWorldFromArray (const int pointIndex, const double pos[3], const double orientationMatrix[9], const char *associatedNodeID, int positionStatus=PositionDefined)
 
void SetNthControlPointPositionWorld (const int pointIndex, const double x, const double y, const double z)
 
void SetNthControlPointPositionWorldFromArray (const int pointIndex, const double pos[3], int positionStatus=PositionDefined)
 
void SetNthControlPointSelected (int n, bool flag)
 
void SetNthControlPointVisibility (int n, bool flag)
 
void SetNthMarkupAssociatedNodeID (int n, std::string id)
 
void SetNthMarkupLabel (int n, std::string label)
 
void SetNthMarkupLocked (int n, bool flag)
 
void SwapControlPoints (int m1, int m2)
 Swap the position of two control points. More...
 
void UnsetNthControlPointPosition (int pointIndex)
 Set control point status to undefined. More...
 
void WriteCLI (std::vector< std::string > &commandLine, std::string prefix, int coordinateSystem=0, int multipleFlag=1) override
 
void WriteXML (ostream &of, int indent) override
 Write this node's information to a MRML file in XML format. More...
 
int GetNumberOfMeasurements ()
 
vtkMRMLMeasurementGetNthMeasurement (int id)
 
void AddMeasurement (vtkMRMLMeasurement *measurement)
 
void SetNthMeasurement (int id, vtkMRMLMeasurement *measurement)
 
void SetNthMeasurement (int id, const std::string &name, double value, const std::string &units, const std::string description="", vtkCodedEntry *quantityCode=nullptr, vtkCodedEntry *derivationCode=nullptr, vtkCodedEntry *unitsCode=nullptr, vtkCodedEntry *methodCode=nullptr)
 
void RemoveNthMeasurement (int id)
 
void RemoveAllMeasurements ()
 
- Public Member Functions inherited from vtkMRMLDisplayableNode
void AddAndObserveDisplayNodeID (const char *displayNodeID)
 
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 std::string GetDefaultStorageNodeClassName (const char *filename=nullptr)
 
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 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 void ConvertOrientationMatrixToWXYZ (const double orientationMatrix[9], double orientationWXYZ[4])
 
static void ConvertOrientationWXYZToMatrix (double orientationWXYZ[4], double orientationMatrix[9])
 
static int IsTypeOf (const char *type)
 
static vtkMRMLMarkupsNodeNew ()
 
static vtkMRMLMarkupsNodeSafeDownCast (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

std::string GenerateControlPointLabel (int controlPointIndex)
 
std::string GenerateUniqueControlPointID ()
 
ControlPointGetNthControlPointCustomLog (int n, const char *failedMethodName)
 
void OnTransformNodeReferenceChanged (vtkMRMLTransformNode *transformNode) override
 Called when transform node reference added/modified/removed. More...
 
void operator= (const vtkMRMLMarkupsNode &)
 
bool SetControlPointLabelsWorld (vtkStringArray *labels, vtkPoints *points, std::string separator="")
 
void SetControlPointPositionsWorld (vtkPoints *points)
 
void SetNthControlPointID (int n, std::string id)
 
virtual void UpdateCurvePolyFromControlPoints ()
 
virtual void UpdateCurvePolyFromCurveInputPoly ()
 
virtual void UpdateMeasurements ()
 
 vtkMRMLMarkupsNode ()
 
 vtkMRMLMarkupsNode (const vtkMRMLMarkupsNode &)
 
 ~vtkMRMLMarkupsNode () override
 
- Protected Member Functions inherited from vtkMRMLDisplayableNode
virtual const char * GetDisplayNodeReferenceMRMLAttributeName ()
 
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...
 
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...
 
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

vtkVector3d CenterPos
 
ControlPointsListType ControlPoints
 
bool CurveClosed
 
vtkSmartPointer< vtkFrenetSerretFrame > CurveCoordinateSystemGeneratorWorld
 
vtkSmartPointer< vtkCurveGeneratorCurveGenerator
 
vtkSmartPointer< vtkPolyData > CurveInputPoly
 
vtkSmartPointer< vtkPolyData > CurvePoly
 
vtkSmartPointer< vtkGeneralTransform > CurvePolyToWorldTransform
 
vtkSmartPointer< vtkTransformPolyDataFilter > CurvePolyToWorldTransformer
 
int LastUsedControlPointNumber
 
int Locked
 
std::string MarkupLabelFormat
 
int MaximumNumberOfControlPoints
 
std::vector< vtkSmartPointer< vtkMRMLMeasurement > > Measurements
 
int RequiredNumberOfControlPoints
 
vtkSmartPointer< vtkStringArray > TextList
 
vtkSmartPointer< vtkPointLocator > TransformedCurvePolyLocator
 
- 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
 

Friends

class vtkMRMLMarkupsFiducialStorageNode
 
class vtkMRMLMarkupsStorageNode
 Make the storage node a friend so that ReadDataInternal can set the ControlPoint ids. More...
 

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 66 of file vtkMRMLMarkupsNode.h.

Member Typedef Documentation

◆ ControlPointsListType

Definition at line 120 of file vtkMRMLMarkupsNode.h.

◆ Superclass

Definition at line 123 of file vtkMRMLMarkupsNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Invoke events when control points change, passing the control point index if applicable.

  • LockModifiedEvent: markups node lock status is changed. Modified event is invoked, too.
  • LabelFormatModifiedEvent: markups node label format changed. Modified event is invoked, too.
  • PointAddedEvent: new control point(s) added. Modified event is NOT invoked.
  • PointRemovedEvent: control point(s) deleted. Modified event is NOT invoked.
  • PointModifiedEvent: existing control point(s) modified, added, or removed. Modified event is NOT invoked.
  • PointStartInteractionEvent when starting interacting with a control point.
  • PointEndInteractionEvent when an interaction eith a control point process finishes.
  • CenterPointModifiedEvent when position of the centerpoint is changed (displayed for example for closed curves)

Event data for Point* events: Event callData is control point index address (int*). If the pointer is nullptr then one or more points are added/removed/modified.

Note: the current active node (control point or line) information are stored in the display node.

Enumerator
LockModifiedEvent 
LabelFormatModifiedEvent 
PointAddedEvent 
PointRemovedEvent 
PointModifiedEvent 
PointStartInteractionEvent 
PointEndInteractionEvent 
CenterPointModifiedEvent 

Definition at line 196 of file vtkMRMLMarkupsNode.h.

◆ anonymous enum

anonymous enum

Placement status of a control point.

  • Undefined: position is undefined (coordinate values must not be used).
  • Preview: point is being placed, position is tentative.
  • Defined: position is specified.
Enumerator
PositionUndefined 
PositionPreview 
PositionDefined 

Definition at line 212 of file vtkMRMLMarkupsNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLMarkupsNode() [1/2]

vtkMRMLMarkupsNode::vtkMRMLMarkupsNode ( )
protected

◆ ~vtkMRMLMarkupsNode()

vtkMRMLMarkupsNode::~vtkMRMLMarkupsNode ( )
overrideprotected

◆ vtkMRMLMarkupsNode() [2/2]

vtkMRMLMarkupsNode::vtkMRMLMarkupsNode ( const vtkMRMLMarkupsNode )
protected

Member Function Documentation

◆ AddControlPoint() [1/2]

int vtkMRMLMarkupsNode::AddControlPoint ( vtkVector3d  point,
std::string  label = std::string() 
)

Add a new control point, returning the point index, -1 on failure.

◆ AddControlPoint() [2/2]

int vtkMRMLMarkupsNode::AddControlPoint ( ControlPoint controlPoint)

Add a controlPoint to the end of the list. Return index of new controlPoint, -1 on failure. Markups node takes over ownership of the pointer (markups node will delete it).

◆ AddControlPointWorld()

int vtkMRMLMarkupsNode::AddControlPointWorld ( vtkVector3d  point,
std::string  label = std::string() 
)

Add a new control point, defined in the world coordinate system. Return index of point index, -1 on failure.

◆ AddMeasurement()

void vtkMRMLMarkupsNode::AddMeasurement ( vtkMRMLMeasurement measurement)

◆ AddNControlPoints()

int vtkMRMLMarkupsNode::AddNControlPoints ( int  n,
std::string  label = std::string(),
vtkVector3d *  point = nullptr 
)

Add n control points. If point is specified then all control point positions will be initialized to that position, otherwise control poin positions are initialized to (0,0,0). Return index of the last placed control point, -1 on failure.

◆ ApplyTransform()

void vtkMRMLMarkupsNode::ApplyTransform ( vtkAbstractTransform *  transform)
overridevirtual

Apply the passed transformation to all of the control points

See also
CanApplyNonLinearTransforms

Reimplemented from vtkMRMLTransformableNode.

◆ CanApplyNonLinearTransforms()

bool vtkMRMLMarkupsNode::CanApplyNonLinearTransforms ( ) const
overridevirtual

Returns true since can apply non linear transforms

See also
ApplyTransform

Reimplemented from vtkMRMLTransformableNode.

◆ ControlPointExists()

bool vtkMRMLMarkupsNode::ControlPointExists ( int  n)

Return true if n is a valid control point, false otherwise.

◆ ConvertOrientationMatrixToWXYZ()

static void vtkMRMLMarkupsNode::ConvertOrientationMatrixToWXYZ ( const double  orientationMatrix[9],
double  orientationWXYZ[4] 
)
static

◆ ConvertOrientationWXYZToMatrix()

static void vtkMRMLMarkupsNode::ConvertOrientationWXYZToMatrix ( double  orientationWXYZ[4],
double  orientationMatrix[9] 
)
static

◆ Copy()

void vtkMRMLMarkupsNode::Copy ( vtkMRMLNode node)
overridevirtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLDisplayableNode.

◆ CreateDefaultDisplayNodes()

void vtkMRMLMarkupsNode::CreateDefaultDisplayNodes ( )
overridevirtual

Create and observe default display node(s)

Reimplemented from vtkMRMLDisplayableNode.

◆ CreateDefaultStorageNode()

vtkMRMLStorageNode* vtkMRMLMarkupsNode::CreateDefaultStorageNode ( )
overridevirtual

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

Reimplemented from vtkMRMLStorableNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLMarkupsNode::CreateNodeInstance ( )
overridevirtual

MRMLNode methods.

Implements vtkMRMLDisplayableNode.

◆ GenerateControlPointLabel()

std::string vtkMRMLMarkupsNode::GenerateControlPointLabel ( int  controlPointIndex)
protected

◆ GenerateUniqueControlPointID()

std::string vtkMRMLMarkupsNode::GenerateUniqueControlPointID ( )
protected

Generate a scene unique ID for a ControlPoint. If the scene is not set, returns a number based on the max number of ControlPoints that have been in this list

◆ GetBounds()

void vtkMRMLMarkupsNode::GetBounds ( double  bounds[6])
overridevirtual

Get bounding box in global RAS form (xmin,xmax, ymin,ymax, zmin,zmax). This method always returns the bounds of the untransformed object.

See also
GetRASBounds()

Reimplemented from vtkMRMLDisplayableNode.

◆ GetCenterPosition()

void vtkMRMLMarkupsNode::GetCenterPosition ( double  point[3])

Get the position of the center setting the elements of point

◆ GetCenterPositionVector()

vtkVector3d vtkMRMLMarkupsNode::GetCenterPositionVector ( )

Get the position of the center returning it as a vtkVector3d, return (0,0,0) if not found

◆ GetCenterPositionWorld()

int vtkMRMLMarkupsNode::GetCenterPositionWorld ( double  worldxyz[3])

Get the position of the center in World coordinate system Returns 0 on failure, 1 on success.

◆ GetClassName()

virtual const char* vtkMRMLMarkupsNode::GetClassName ( )
virtual

◆ GetClosestControlPointIndexToPositionWorld()

int vtkMRMLMarkupsNode::GetClosestControlPointIndexToPositionWorld ( double  pos[3])

Get the index of the closest control point to the world coordinates.

◆ GetControlPointIndexFromInterpolatedPointIndex()

int vtkMRMLMarkupsNode::GetControlPointIndexFromInterpolatedPointIndex ( vtkIdType  interpolatedPointIndex)

◆ GetControlPointLabels()

void vtkMRMLMarkupsNode::GetControlPointLabels ( vtkStringArray *  labels)

◆ GetControlPoints()

std::vector<ControlPoint*>* vtkMRMLMarkupsNode::GetControlPoints ( )

Return a pointer to the std::vector of control points stored in this node.

◆ GetCurveClosed()

virtual bool vtkMRMLMarkupsNode::GetCurveClosed ( )
virtual

◆ GetCurveGenerator()

vtkCurveGenerator* vtkMRMLMarkupsNode::GetCurveGenerator ( )
inline

The internal instance of the curve generator to allow use of the curve for other computations. Any custom overrides of the interpolation modes are not persisted in MRML.

Definition at line 532 of file vtkMRMLMarkupsNode.h.

◆ GetCurvePointsWorld()

vtkPoints* vtkMRMLMarkupsNode::GetCurvePointsWorld ( )

◆ GetCurveWorld()

vtkPolyData* vtkMRMLMarkupsNode::GetCurveWorld ( )

◆ GetCurveWorldConnection()

vtkAlgorithmOutput* vtkMRMLMarkupsNode::GetCurveWorldConnection ( )

◆ GetIcon()

virtual const char* vtkMRMLMarkupsNode::GetIcon ( )
inlinevirtual

◆ GetLocked()

virtual int vtkMRMLMarkupsNode::GetLocked ( )
virtual

Get the Locked property on the markupNode/list of control points.

◆ GetMarkupLabelFormat()

std::string vtkMRMLMarkupsNode::GetMarkupLabelFormat ( )

Get the markup node label format string that defines the markup names.

See also
SetMarkupLabelFormat

◆ GetMarkupPoint()

void vtkMRMLMarkupsNode::GetMarkupPoint ( int  markupIndex,
int  pointIndex,
double  point[3] 
)
Deprecated:
Use GetNthControlPointPosition method instead.

◆ GetMarkupPointVector()

vtkVector3d vtkMRMLMarkupsNode::GetMarkupPointVector ( int  markupIndex,
int   
)
inline
Deprecated:
Use GetNthControlPointPositionVector() method instead.

Definition at line 279 of file vtkMRMLMarkupsNode.h.

◆ GetMarkupsDisplayNode()

vtkMRMLMarkupsDisplayNode* vtkMRMLMarkupsNode::GetMarkupsDisplayNode ( )

Return a cast display node, returns null if none.

◆ GetMaximumNumberOfControlPoints()

virtual int vtkMRMLMarkupsNode::GetMaximumNumberOfControlPoints ( )
virtual

Maximum number of control points limits the number of markups allowed in the node. If maximum number of control points is set to 0 then no it means there is no limit (this is the default value). The value is an indication to the user interface and does not affect prevent adding markups to a node programmatically. If value is set to lower value than the number of markups in the node, then existing markups are not deleted. 2 for line, and 3 for angle Markups

◆ GetModifiedSinceRead()

bool vtkMRMLMarkupsNode::GetModifiedSinceRead ( )
overridevirtual

Reimplemented to take into account the modified time of the markups Returns true if the node (default behavior) or the markups are modified since read/written. Note: The MTime of the markups node is used to know if it has been modified. So if you invoke class specific modified events without calling Modified() on the markups, GetModifiedSinceRead() won't return true.

See also
vtkMRMLStorableNode::GetModifiedSinceRead()

Reimplemented from vtkMRMLStorableNode.

◆ GetNodeTagName()

const char* vtkMRMLMarkupsNode::GetNodeTagName ( )
inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLDisplayableNode.

Definition at line 135 of file vtkMRMLMarkupsNode.h.

◆ GetNthControlPoint()

ControlPoint* vtkMRMLMarkupsNode::GetNthControlPoint ( int  n)

Return a pointer to the Nth control point stored in this node, null if n is out of bounds.

◆ GetNthControlPointAssociatedNodeID()

std::string vtkMRMLMarkupsNode::GetNthControlPointAssociatedNodeID ( int  n = 0)

Get/Set the associated node id for the Nth control point.

◆ GetNthControlPointByID()

ControlPoint* vtkMRMLMarkupsNode::GetNthControlPointByID ( const char *  controlPointID)

Get the Nth control point based on it's ID.

◆ GetNthControlPointCustomLog()

ControlPoint* vtkMRMLMarkupsNode::GetNthControlPointCustomLog ( int  n,
const char *  failedMethodName 
)
protected

Utility function to be used internally for safe access to a control point's data. Return a pointer to the Nth control point stored in this node, nullptr if n is out of bounds If control point does not exist then an error is logged with the supplied failedMethodName.

◆ GetNthControlPointDescription()

std::string vtkMRMLMarkupsNode::GetNthControlPointDescription ( int  n = 0)

Get the Description flag on the Nth control point, returns false if control point doesn't exist

◆ GetNthControlPointID()

std::string vtkMRMLMarkupsNode::GetNthControlPointID ( int  n)

Get the id for the Nth control point.

◆ GetNthControlPointIndexByID()

int vtkMRMLMarkupsNode::GetNthControlPointIndexByID ( const char *  controlPointID)

Get the Nth control point index based on it's ID.

◆ GetNthControlPointLabel()

std::string vtkMRMLMarkupsNode::GetNthControlPointLabel ( int  n = 0)

Get the Label on the Nth control point, returns false if control point doesn't exist

◆ GetNthControlPointLocked()

bool vtkMRMLMarkupsNode::GetNthControlPointLocked ( int  n = 0)

Get the Lock flag on the Nth control point, returns false if control point doesn't exist

◆ GetNthControlPointNormal()

double* vtkMRMLMarkupsNode::GetNthControlPointNormal ( int  n)

Get normal direction (orientation of z axis) in local coordinate system.

◆ GetNthControlPointNormalWorld()

void vtkMRMLMarkupsNode::GetNthControlPointNormalWorld ( int  n,
double  normalWorld[3] 
)

Get normal direction (orientation of z axis) in world coordinate system.

◆ GetNthControlPointOrientation()

void vtkMRMLMarkupsNode::GetNthControlPointOrientation ( int  n,
double  orientationWXYZ[4] 
)

Get the WXYZ orientation for the Nth control point.

◆ GetNthControlPointOrientationMatrix()

double* vtkMRMLMarkupsNode::GetNthControlPointOrientationMatrix ( int  n)

Get orientation as 9 values: x, y, and z axis directions, respectively.

◆ GetNthControlPointOrientationVector()

vtkVector4d vtkMRMLMarkupsNode::GetNthControlPointOrientationVector ( int  pointIndex)

Get the WXYZ orientation for the Nth control point returning it as a vtkVector4d, return (0,0,0,0) if not found. Note that vtkVector4d stores components in the order XYZW (in all other methods we get/set components in WXYZ order).

◆ GetNthControlPointPosition() [1/2]

void vtkMRMLMarkupsNode::GetNthControlPointPosition ( int  pointIndex,
double  point[3] 
)

Get the position of the Nth control point setting the elements of point

◆ GetNthControlPointPosition() [2/2]

double* vtkMRMLMarkupsNode::GetNthControlPointPosition ( int  pointIndex)

◆ GetNthControlPointPositionStatus()

int vtkMRMLMarkupsNode::GetNthControlPointPositionStatus ( int  pointIndex)

Get control point position status (PositionUndefined, PositionPreview, PositionDefined)

◆ GetNthControlPointPositionVector()

vtkVector3d vtkMRMLMarkupsNode::GetNthControlPointPositionVector ( int  pointIndex)

Get the position of the Nth control point returning it as a vtkVector3d, return (0,0,0) if not found

◆ GetNthControlPointPositionWorld()

int vtkMRMLMarkupsNode::GetNthControlPointPositionWorld ( int  pointIndex,
double  worldxyz[3] 
)

Get the position of the Nth control point in World coordinate system Returns 0 on failure, 1 on success.

◆ GetNthControlPointSelected()

bool vtkMRMLMarkupsNode::GetNthControlPointSelected ( int  n = 0)

Get the Selected flag on the Nth control point, returns false if control point doesn't exist

◆ GetNthControlPointVisibility()

bool vtkMRMLMarkupsNode::GetNthControlPointVisibility ( int  n = 0)

Get the Visibility flag on the Nth control point, returns false if control point doesn't exist

◆ GetNthMarkupAssociatedNodeID()

std::string vtkMRMLMarkupsNode::GetNthMarkupAssociatedNodeID ( int  n = 0)
inline
Deprecated:
Use GetNthControlPointAssociatedNodeID instead.

Definition at line 390 of file vtkMRMLMarkupsNode.h.

◆ GetNthMarkupID()

std::string vtkMRMLMarkupsNode::GetNthMarkupID ( int  n = 0)
inline
Deprecated:
Use GetNthControlPointID instead.

Definition at line 398 of file vtkMRMLMarkupsNode.h.

◆ GetNthMarkupLabel()

std::string vtkMRMLMarkupsNode::GetNthMarkupLabel ( int  n = 0)
inline
Deprecated:
Use GetNthControlPointLabel instead.

Definition at line 447 of file vtkMRMLMarkupsNode.h.

◆ GetNthMarkupLocked()

bool vtkMRMLMarkupsNode::GetNthMarkupLocked ( int  n = 0)
inline
Deprecated:
Use GetNthControlPointLocked instead.

Definition at line 424 of file vtkMRMLMarkupsNode.h.

◆ GetNthMeasurement()

vtkMRMLMeasurement* vtkMRMLMarkupsNode::GetNthMeasurement ( int  id)

◆ GetNumberOfControlPoints()

int vtkMRMLMarkupsNode::GetNumberOfControlPoints ( )

Return the number of control points that are stored in this node.

◆ GetNumberOfDefinedControlPoints()

int vtkMRMLMarkupsNode::GetNumberOfDefinedControlPoints ( )

Return the number of control points that are already placed (not being previewed or undefined).

◆ GetNumberOfMarkups()

int vtkMRMLMarkupsNode::GetNumberOfMarkups ( )
inline
Deprecated:
Use GetNumberOfControlPoints() instead.

Definition at line 252 of file vtkMRMLMarkupsNode.h.

◆ GetNumberOfMeasurements()

int vtkMRMLMarkupsNode::GetNumberOfMeasurements ( )

Get/set measurement data, such as length, angle, diameter, cross-section area.

◆ GetNumberOfPointsInNthMarkup()

int vtkMRMLMarkupsNode::GetNumberOfPointsInNthMarkup ( int  )
inline
Deprecated:
Use GetNumberOfControlPoints() instead.

Definition at line 254 of file vtkMRMLMarkupsNode.h.

◆ GetRASBounds()

void vtkMRMLMarkupsNode::GetRASBounds ( double  bounds[6])
overridevirtual

Get bounding box in global RAS form (xmin,xmax, ymin,ymax, zmin,zmax). This method returns the bounds of the object with any transforms that may be applied to it.

See also
GetBounds()

Reimplemented from vtkMRMLDisplayableNode.

◆ GetRequiredNumberOfControlPoints()

virtual int vtkMRMLMarkupsNode::GetRequiredNumberOfControlPoints ( )
virtual

Return the number of control points that are required for defining this widget. Interaction mode remains in "place" mode until this number is reached. If the number is set to 0 then no it means there is no preference (this is the default value).

◆ InsertControlPoint()

bool vtkMRMLMarkupsNode::InsertControlPoint ( ControlPoint controlPoint,
int  targetIndex 
)

Insert a control point in this list at targetIndex. If targetIndex is < 0, insert at the start of the list. If targetIndex is > list size - 1, append to end of list. If the insertion is successful, ownership of the controlPoint is transferred to the markups node. Returns true on success, false on failure.

◆ IsA()

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

◆ IsTypeOf()

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

◆ LockedOff()

virtual void vtkMRMLMarkupsNode::LockedOff ( )
virtual

◆ LockedOn()

virtual void vtkMRMLMarkupsNode::LockedOn ( )
virtual

Get/Set the Locked property on the markupNode. If set to 1 then parameters should not be changed

◆ MarkupExists()

bool vtkMRMLMarkupsNode::MarkupExists ( int  n)
inline

Depreceated. Use ControlPointExists instead.

Definition at line 246 of file vtkMRMLMarkupsNode.h.

◆ New()

static vtkMRMLMarkupsNode* vtkMRMLMarkupsNode::New ( )
static

◆ OnTransformNodeReferenceChanged()

void vtkMRMLMarkupsNode::OnTransformNodeReferenceChanged ( vtkMRMLTransformNode transformNode)
overrideprotectedvirtual

Called when transform node reference added/modified/removed.

Reimplemented from vtkMRMLTransformableNode.

◆ operator=()

void vtkMRMLMarkupsNode::operator= ( const vtkMRMLMarkupsNode )
protected

◆ PrintSelf()

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

◆ ProcessMRMLEvents()

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

Alternative method to propagate events generated in Display nodes.

Reimplemented from vtkMRMLDisplayableNode.

◆ ReadXMLAttributes()

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

Read node attributes from XML file.

Reimplemented from vtkMRMLDisplayableNode.

◆ RemoveAllControlPoints()

virtual void vtkMRMLMarkupsNode::RemoveAllControlPoints ( )
virtual

Clear out the node of all control points.

◆ RemoveAllMarkups()

void vtkMRMLMarkupsNode::RemoveAllMarkups ( )
inline
Deprecated:
Use RemoveAllControlPoints instead.

Definition at line 223 of file vtkMRMLMarkupsNode.h.

◆ RemoveAllMeasurements()

void vtkMRMLMarkupsNode::RemoveAllMeasurements ( )

◆ RemoveMarkup()

void vtkMRMLMarkupsNode::RemoveMarkup ( int  pointIndex)
inline
Deprecated:
Use RemoveNthControlPoint instead.

Definition at line 302 of file vtkMRMLMarkupsNode.h.

◆ RemoveNthControlPoint()

void vtkMRMLMarkupsNode::RemoveNthControlPoint ( int  pointIndex)

Remove Nth Control Point.

◆ RemoveNthMeasurement()

void vtkMRMLMarkupsNode::RemoveNthMeasurement ( int  id)

◆ ReplaceListNameInMarkupLabelFormat()

std::string vtkMRMLMarkupsNode::ReplaceListNameInMarkupLabelFormat ( )

If the MarkupLabelFormat contains the string N, return a string in which that has been replaced with the list name. If the list name is nullptr, replace it with an empty string. If the MarkupLabelFormat doesn't contain N, return MarkupLabelFormat

◆ ResetNthControlPointID()

bool vtkMRMLMarkupsNode::ResetNthControlPointID ( int  n)

Reset the id of the Nth control point according to the local policy Called after an already initialised markup has been added to the scene. Returns false if n out of bounds, true on success.

◆ SafeDownCast()

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

◆ SetCenterPosition()

void vtkMRMLMarkupsNode::SetCenterPosition ( const double  x,
const double  y,
const double  z 
)

Set the center position position from coordinates

See also
SetCenterPositionFromPointer, SetCenterPositionFromArray

◆ SetCenterPositionFromArray()

void vtkMRMLMarkupsNode::SetCenterPositionFromArray ( const double  pos[3])

Set the center position position from an array

See also
SetCenterPosition

◆ SetCenterPositionFromPointer()

void vtkMRMLMarkupsNode::SetCenterPositionFromPointer ( const double *  pos)

Set the center position from a pointer to an array

See also
SetCenterPosition

◆ SetCenterPositionWorld()

void vtkMRMLMarkupsNode::SetCenterPositionWorld ( const double  x,
const double  y,
const double  z 
)

Set the center position position using World coordinate system Calls SetCenterPosition after transforming the passed in coordinate

See also
SetCenterPosition

◆ SetControlPointLabelsWorld()

bool vtkMRMLMarkupsNode::SetControlPointLabelsWorld ( vtkStringArray *  labels,
vtkPoints *  points,
std::string  separator = "" 
)
protected

Set label of closest control point. If one control point is closest to multiple labels then all of them will be assigned to the same control point, separated with the provided "separator" string. Erase labels of all other control points. The method is protected because the API may still change.

◆ SetControlPointPositionsWorld()

void vtkMRMLMarkupsNode::SetControlPointPositionsWorld ( vtkPoints *  points)
protected

Set all control point positions from a point list. The method is protected because the API may still change. If points is nullptr then all control points are removed. New control points are added if needed. Existing control points are updated with the new positions. Any extra existing control points are removed.

◆ SetLocked()

void vtkMRMLMarkupsNode::SetLocked ( int  locked)

Set the Locked property on the markupNode/list of control points If set to 1 then parameters should not be changed, and dragging the control points is disabled in 2d and 3d. Overrides the Locked flag on individual control points in that when the node is set to be locked, all the control points in the list are locked. When the node is unlocked, use the locked flag on the individual control points to determine their locked state.

◆ SetMarkupLabelFormat()

void vtkMRMLMarkupsNode::SetMarkupLabelFormat ( std::string  format)

Set the markup node label format strign that defines the markup names, then invoke the LabelFormatModifedEvent In standard printf notation, with the addition of N being replaced by the list name. d will resolve to the highest not yet used list index integer. Character strings will otherwise pass through Defaults to N-d which will yield markup names of Name-0, Name-1, Name-2

See also
GetMarkupLabelFormat

◆ SetNthControlPointAssociatedNodeID()

void vtkMRMLMarkupsNode::SetNthControlPointAssociatedNodeID ( int  n,
std::string  id 
)

◆ SetNthControlPointDescription()

void vtkMRMLMarkupsNode::SetNthControlPointDescription ( int  n,
std::string  description 
)

Set the Description on the Nth control point.

◆ SetNthControlPointID()

void vtkMRMLMarkupsNode::SetNthControlPointID ( int  n,
std::string  id 
)
protected

Set the id of the nth control point. The goal is to keep this ID unique, so it's managed by the markups node.

◆ SetNthControlPointLabel()

void vtkMRMLMarkupsNode::SetNthControlPointLabel ( int  n,
std::string  label 
)

Set the Label on the Nth control point.

◆ SetNthControlPointLocked()

void vtkMRMLMarkupsNode::SetNthControlPointLocked ( int  n,
bool  flag 
)

Set Locked property on Nth control point. If locked is set to true on the node/list as a whole, the Nth control point locked flag is used to determine if it is locked. If the locked flag is set to false on the node as a whole, all control point are locked but keep this value for when the list as a whole is turned unlocked.

See also
vtMRMLMarkupsNode::SetLocked

◆ SetNthControlPointOrientation()

void vtkMRMLMarkupsNode::SetNthControlPointOrientation ( int  n,
double  w,
double  x,
double  y,
double  z 
)

Set the orientation for the Nth control point from passed parameters.

◆ SetNthControlPointOrientationFromArray()

void vtkMRMLMarkupsNode::SetNthControlPointOrientationFromArray ( int  n,
const double  orientationWXYZ[4] 
)

Set the orientation for the Nth control point from a double array WXYZ.

◆ SetNthControlPointOrientationFromPointer()

void vtkMRMLMarkupsNode::SetNthControlPointOrientationFromPointer ( int  n,
const double *  orientationWXYZ 
)

Set the orientation for the Nth control point from a pointer to a double array WXYZ.

◆ SetNthControlPointOrientationMatrix()

void vtkMRMLMarkupsNode::SetNthControlPointOrientationMatrix ( int  n,
double  orientationMatrix[9] 
)

Set orientation as 9 values: x, y, and z axis directions, respectively.

◆ SetNthControlPointOrientationMatrixWorld()

void vtkMRMLMarkupsNode::SetNthControlPointOrientationMatrixWorld ( int  n,
double  orientationMatrix[9] 
)

Set orientation as 9 values: x, y, and z axis directions, respectively. Important: this method just calls SetNthControlPointOrientationMatrix and does not convert from world coordinate yet.

◆ SetNthControlPointPosition()

void vtkMRMLMarkupsNode::SetNthControlPointPosition ( const int  pointIndex,
const double  x,
const double  y,
const double  z,
int  positionStatus = PositionDefined 
)

Set of the Nth control point position from coordinates

See also
SetNthControlPointPositionFromPointer, SetNthControlPointPositionFromArray

◆ SetNthControlPointPositionFromArray()

void vtkMRMLMarkupsNode::SetNthControlPointPositionFromArray ( const int  pointIndex,
const double  pos[3],
int  positionStatus = PositionDefined 
)

Set of the Nth control point position from an array

See also
SetNthControlPointPosition

◆ SetNthControlPointPositionFromPointer()

void vtkMRMLMarkupsNode::SetNthControlPointPositionFromPointer ( const int  pointIndex,
const double *  pos 
)

Set of the Nth control point position from a pointer to an array

See also
SetNthControlPointPosition

◆ SetNthControlPointPositionOrientationWorldFromArray()

void vtkMRMLMarkupsNode::SetNthControlPointPositionOrientationWorldFromArray ( const int  pointIndex,
const double  pos[3],
const double  orientationMatrix[9],
const char *  associatedNodeID,
int  positionStatus = PositionDefined 
)

Set of the Nth control point position and orientation from an array using World coordinate system.

See also
SetNthControlPointPosition

◆ SetNthControlPointPositionWorld()

void vtkMRMLMarkupsNode::SetNthControlPointPositionWorld ( const int  pointIndex,
const double  x,
const double  y,
const double  z 
)

Set of the Nth control point position using World coordinate system Calls SetNthControlPointPosition after transforming the passed in coordinate

See also
SetNthControlPointPosition

◆ SetNthControlPointPositionWorldFromArray()

void vtkMRMLMarkupsNode::SetNthControlPointPositionWorldFromArray ( const int  pointIndex,
const double  pos[3],
int  positionStatus = PositionDefined 
)

Set of the Nth control point position from an array using World coordinate system

See also
SetNthControlPointPosition

◆ SetNthControlPointSelected()

void vtkMRMLMarkupsNode::SetNthControlPointSelected ( int  n,
bool  flag 
)

Set the Selected flag on the Nth control point

See also
vtkMRMLNode::SetSelected

◆ SetNthControlPointVisibility()

void vtkMRMLMarkupsNode::SetNthControlPointVisibility ( int  n,
bool  flag 
)

Set Visibility property on Nth control point. If the visibility is set to true on the node/list as a whole, the Nth control point visibility is used to determine if it is visible. If the visibility is set to false on the node as a whole, all control points are hidden but keep this value for when the list as a whole is turned visible.

See also
vtkMRMLDisplayableNode::SetDisplayVisibility
vtkMRMLDisplayNode::SetVisibility

◆ SetNthMarkupAssociatedNodeID()

void vtkMRMLMarkupsNode::SetNthMarkupAssociatedNodeID ( int  n,
std::string  id 
)
inline
Deprecated:
Use SetNthControlPointAssociatedNodeID instead.

Definition at line 392 of file vtkMRMLMarkupsNode.h.

◆ SetNthMarkupLabel()

void vtkMRMLMarkupsNode::SetNthMarkupLabel ( int  n,
std::string  label 
)
inline
Deprecated:
Use SetNthControlPointLabel instead.

Definition at line 449 of file vtkMRMLMarkupsNode.h.

◆ SetNthMarkupLocked()

void vtkMRMLMarkupsNode::SetNthMarkupLocked ( int  n,
bool  flag 
)
inline
Deprecated:
Use SetNthControlPointLocked instead.

Definition at line 426 of file vtkMRMLMarkupsNode.h.

◆ SetNthMeasurement() [1/2]

void vtkMRMLMarkupsNode::SetNthMeasurement ( int  id,
vtkMRMLMeasurement measurement 
)

◆ SetNthMeasurement() [2/2]

void vtkMRMLMarkupsNode::SetNthMeasurement ( int  id,
const std::string &  name,
double  value,
const std::string &  units,
const std::string  description = "",
vtkCodedEntry quantityCode = nullptr,
vtkCodedEntry derivationCode = nullptr,
vtkCodedEntry unitsCode = nullptr,
vtkCodedEntry methodCode = nullptr 
)

◆ SwapControlPoints()

void vtkMRMLMarkupsNode::SwapControlPoints ( int  m1,
int  m2 
)

Swap the position of two control points.

◆ UnsetNthControlPointPosition()

void vtkMRMLMarkupsNode::UnsetNthControlPointPosition ( int  pointIndex)

Set control point status to undefined.

◆ UpdateCurvePolyFromControlPoints()

virtual void vtkMRMLMarkupsNode::UpdateCurvePolyFromControlPoints ( )
protectedvirtual

◆ UpdateCurvePolyFromCurveInputPoly()

virtual void vtkMRMLMarkupsNode::UpdateCurvePolyFromCurveInputPoly ( )
protectedvirtual

Reimplemented in vtkMRMLMarkupsFiducialNode.

◆ UpdateMeasurements()

virtual void vtkMRMLMarkupsNode::UpdateMeasurements ( )
protectedvirtual

Reimplemented in vtkMRMLMarkupsAngleNode.

◆ WriteCLI()

void vtkMRMLMarkupsNode::WriteCLI ( std::vector< std::string > &  commandLine,
std::string  prefix,
int  coordinateSystem = 0,
int  multipleFlag = 1 
)
override

Write this node's information to a vector of strings for passing to a CLI, precede each datum with the prefix if not an empty string coordinateSystemFlag = 0 for RAS, 1 for LPS multipleFlag = 1 for the whole list, 1 for the first selected control point

◆ WriteXML()

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

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

Reimplemented from vtkMRMLDisplayableNode.

Friends And Related Function Documentation

◆ vtkMRMLMarkupsFiducialStorageNode

friend class vtkMRMLMarkupsFiducialStorageNode
friend

Definition at line 70 of file vtkMRMLMarkupsNode.h.

◆ vtkMRMLMarkupsStorageNode

friend class vtkMRMLMarkupsStorageNode
friend

Make the storage node a friend so that ReadDataInternal can set the ControlPoint ids.

Definition at line 69 of file vtkMRMLMarkupsNode.h.

Member Data Documentation

◆ CenterPos

vtkVector3d vtkMRMLMarkupsNode::CenterPos
protected

Definition at line 633 of file vtkMRMLMarkupsNode.h.

◆ ControlPoints

ControlPointsListType vtkMRMLMarkupsNode::ControlPoints
protected

Definition at line 595 of file vtkMRMLMarkupsNode.h.

◆ CurveClosed

bool vtkMRMLMarkupsNode::CurveClosed
protected

Definition at line 592 of file vtkMRMLMarkupsNode.h.

◆ CurveCoordinateSystemGeneratorWorld

vtkSmartPointer<vtkFrenetSerretFrame> vtkMRMLMarkupsNode::CurveCoordinateSystemGeneratorWorld
protected

Definition at line 604 of file vtkMRMLMarkupsNode.h.

◆ CurveGenerator

vtkSmartPointer<vtkCurveGenerator> vtkMRMLMarkupsNode::CurveGenerator
protected

Definition at line 598 of file vtkMRMLMarkupsNode.h.

◆ CurveInputPoly

vtkSmartPointer<vtkPolyData> vtkMRMLMarkupsNode::CurveInputPoly
protected

Definition at line 608 of file vtkMRMLMarkupsNode.h.

◆ CurvePoly

vtkSmartPointer<vtkPolyData> vtkMRMLMarkupsNode::CurvePoly
protected

Definition at line 612 of file vtkMRMLMarkupsNode.h.

◆ CurvePolyToWorldTransform

vtkSmartPointer<vtkGeneralTransform> vtkMRMLMarkupsNode::CurvePolyToWorldTransform
protected

Definition at line 615 of file vtkMRMLMarkupsNode.h.

◆ CurvePolyToWorldTransformer

vtkSmartPointer<vtkTransformPolyDataFilter> vtkMRMLMarkupsNode::CurvePolyToWorldTransformer
protected

Definition at line 614 of file vtkMRMLMarkupsNode.h.

◆ LastUsedControlPointNumber

int vtkMRMLMarkupsNode::LastUsedControlPointNumber
protected

Definition at line 629 of file vtkMRMLMarkupsNode.h.

◆ Locked

int vtkMRMLMarkupsNode::Locked
protected

Definition at line 622 of file vtkMRMLMarkupsNode.h.

◆ MarkupLabelFormat

std::string vtkMRMLMarkupsNode::MarkupLabelFormat
protected

Definition at line 624 of file vtkMRMLMarkupsNode.h.

◆ MaximumNumberOfControlPoints

int vtkMRMLMarkupsNode::MaximumNumberOfControlPoints
protected

Definition at line 589 of file vtkMRMLMarkupsNode.h.

◆ Measurements

std::vector< vtkSmartPointer<vtkMRMLMeasurement> > vtkMRMLMarkupsNode::Measurements
protected

Definition at line 635 of file vtkMRMLMarkupsNode.h.

◆ RequiredNumberOfControlPoints

int vtkMRMLMarkupsNode::RequiredNumberOfControlPoints
protected

Definition at line 590 of file vtkMRMLMarkupsNode.h.

◆ TextList

vtkSmartPointer<vtkStringArray> vtkMRMLMarkupsNode::TextList
protected

Definition at line 546 of file vtkMRMLMarkupsNode.h.

◆ TransformedCurvePolyLocator

vtkSmartPointer<vtkPointLocator> vtkMRMLMarkupsNode::TransformedCurvePolyLocator
protected

Definition at line 619 of file vtkMRMLMarkupsNode.h.


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