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

Inheritance diagram for vtkMRMLMarkupsNode:

[legend]

Collaboration diagram for vtkMRMLMarkupsNode:

[legend]

Classes
struct	ControlPoint

Public Types
enum	{ LockModifiedEvent = 19000 , LabelFormatModifiedEvent , PointAddedEvent , PointRemovedEvent , PointPositionDefinedEvent , PointPositionUndefinedEvent , PointPositionMissingEvent , PointPositionNonMissingEvent , PointModifiedEvent , PointStartInteractionEvent , PointEndInteractionEvent , CenterOfRotationModifiedEvent , FixedNumberOfControlPointsModifiedEvent , PointAboutToBeRemovedEvent }

enum	{ PositionUndefined , PositionPreview , PositionDefined , PositionMissing , PositionStatus_Last }
	Placement status of a control point. More...

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

typedef vtkMRMLStorableNode	Superclass

Public Types inherited from vtkMRMLStorableNode
typedef vtkMRMLNode	Superclass

Public Types inherited from vtkMRMLNode
enum	{ HierarchyModifiedEvent = 16000 , IDChangedEvent = 16001 , ReferenceAddedEvent , ReferenceModifiedEvent , ReferenceRemovedEvent , ReferencedNodeModifiedEvent }

enum	ContentModifiedObserveType { ContentModifiedObserveUndefined = -1 , ContentModifiedObserveDisabled = 0 , ContentModifiedObserveEnabled = 1 }

typedef std::map< std::string, std::string >	ReferencePropertiesType
	Get the node reference properties for a specific referenceRole.

typedef vtkObject	Superclass

Public Member Functions
int	AddControlPoint (ControlPoint *controlPoint, bool autoLabel=true)

void	AddMeasurement (vtkMRMLMeasurement *measurement)

void	ApplyTransform (vtkAbstractTransform *transform) override

virtual void	ApplyTransform (vtkAbstractTransform *transform, bool applyToLockedControlPoints)

bool	CanApplyNonLinearTransforms () const override

void	ClearValueForAllMeasurements ()

bool	ControlPointExists (int n)
	Return true if n is a valid control point, false otherwise.

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

vtkMRMLStorageNode *	CreateDefaultStorageNode () override
	Create default storage node or nullptr if does not have one.

int	EndModify (int previousDisableModifiedEventState) override
	End modifying the node. Updates pending measurements and other updates.

virtual const char *	GetAddIcon ()

void	GetBounds (double bounds[6]) override

vtkVector3d	GetCenterOfRotation ()

bool	GetCenterOfRotation (double point[3])

vtkVector3d	GetCenterOfRotationVector ()

bool	GetCenterOfRotationWorld (double worldxyz[3])

virtual const char *	GetClassName ()

int	GetClosestControlPointIndexToPositionWorld (double pos[3], bool visibleOnly=false)

int	GetControlPointIndexFromInterpolatedPointIndex (vtkIdType interpolatedPointIndex)
	Converts curve point index to control point index.

void	GetControlPointLabels (vtkStringArray *labels)
	Get all control point labels at once.

virtual bool	GetControlPointPlacementComplete ()
	Returns true if no additional control points can be added to this node.

void	GetControlPointPositionsWorld (vtkPoints *points)
	Get a copy of all control point positions in world coordinate system.

std::vector< ControlPoint * > *	GetControlPoints ()
	Return a pointer to the std::vector of control points stored in this node.

virtual bool	GetCurveClosed ()
	Returns true if the curve generator creates a closed curve.

vtkParallelTransportFrame *	GetCurveCoordinateSystemGeneratorWorld ()

vtkCurveGenerator *	GetCurveGenerator ()

virtual const char *	GetDefaultNodeNamePrefix ()

virtual const char *	GetIcon ()

virtual vtkMatrix4x4 *	GetInteractionHandleToWorldMatrix ()
	4x4 matrix detailing the orientation and position in world coordinates of the interaction handles.

std::string	GetMarkupLabelFormat ()

void	GetMarkupPoint (int markupIndex, int pointIndex, double point[3])

vtkVector3d	GetMarkupPointVector (int markupIndex, int)

vtkMRMLMarkupsDisplayNode *	GetMarkupsDisplayNode ()
	Return a cast display node, returns null if none.

virtual const char *	GetMarkupType ()

virtual int	GetMaximumNumberOfControlPoints ()

vtkMRMLMeasurement *	GetMeasurement (const char *name)

bool	GetModifiedSinceRead () override

ControlPoint *	GetNthControlPoint (int n)
	Return a pointer to the Nth control point stored in this node, null if n is out of bounds.

ControlPoint *	GetNthControlPointByID (const char *controlPointID)
	Get the Nth control point based on it's ID.

std::string	GetNthControlPointID (int n)
	Get the id for the Nth control point.

int	GetNthControlPointIndexByID (const char *controlPointID)

int	GetNthControlPointIndexByPositionStatus (int pointIndex, int positionStatus)

bool	GetNthControlPointLocked (int n=0)

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

vtkVector4d	GetNthControlPointOrientationVector (int pointIndex)

int	GetNthControlPointPositionStatus (int pointIndex)
	Get control point position status (PositionUndefined, PositionPreview, PositionDefined)

vtkVector3d	GetNthControlPointPositionVector (int pointIndex)

bool	GetNthControlPointPositionVisibility (int n=0)

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)

vtkMRMLMeasurement *	GetNthMeasurement (int id)

int	GetNumberOfControlPoints ()
	Return the number of control points that are stored in this node.

int	GetNumberOfDefinedControlPoints (bool includePreview=false)
	Return the number of control points that are already placed (not being previewed or undefined).

int	GetNumberOfEnabledMeasurements ()

int	GetNumberOfMarkups ()

int	GetNumberOfMeasurements ()

int	GetNumberOfMovableControlPoints ()
	Return the number of unlocked control points with defined position in this node.

int	GetNumberOfPointsInNthMarkup (int)

int	GetNumberOfUndefinedControlPoints (bool includePreview=false)
	Return the number of control points that have not been placed (not being previewed or skipped).

virtual const char *	GetPlaceAddIcon ()

virtual std::string	GetPropertiesLabelText ()

void	GetRASBounds (double bounds[6]) override

virtual int	GetRequiredNumberOfControlPoints ()

virtual const char *	GetTypeDisplayName () override

vtkMRMLUnitNode *	GetUnitNode (const char *quantity)
	Utility function to get unit node from scene.

virtual int	IsA (const char *type)

bool	MarkupExists (int n)

void	PrintSelf (ostream &os, vtkIndent indent) override

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

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

virtual void	RemoveAllControlPoints ()
	Clear out the node of all control points.

void	RemoveAllMarkups ()

void	RemoveAllMeasurements ()

void	RemoveMarkup (int pointIndex)

void	RemoveNthControlPoint (int pointIndex)
	Remove Nth Control Point.

void	RemoveNthMeasurement (int id)

std::string	ReplaceListNameInControlPointLabelFormat ()

std::string	ReplaceListNameInMarkupLabelFormat ()

bool	ResetNthControlPointID (int n)

void	ResetNthControlPointPosition (int n)
	Set control point status to preview.

void	RestoreNthControlPointPosition (int n)
	Set control point status to defined and return to the previous position.

void	SetCenterOfRotationFromArray (const double pos[3])

void	SetCenterOfRotationFromPointer (const double *pos)

void	SetControlPointPositionsWorld (vtkPoints *points, bool setUndefinedPoints=true)

void	SetMarkupLabelFormat (std::string format)

void	SetNthControlPointLocked (int n, bool flag)

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

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

VTK_PROPEXCLUDE void	SetNthControlPointPositionMissing (int pointIndex)
	Set control point status to ignored.

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

void	SetNthControlPointPositionOrientationWorldFromArray (const int pointIndex, const double positionWorld[3], const double orientationMatrix_World[9], const char *associatedNodeID, int positionStatus=PositionDefined)

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	SetNthMeasurement (int id, const std::string &name, double value, const std::string &units, std::string printFormat="", const std::string description="", vtkCodedEntry quantityCode=nullptr, vtkCodedEntry derivationCode=nullptr, vtkCodedEntry unitsCode=nullptr, vtkCodedEntry methodCode=nullptr)

void	SetNthMeasurement (int id, vtkMRMLMeasurement *measurement)

void	SwapControlPoints (int m1, int m2)
	Swap two control points (position data and all other properties).

virtual void	UnsetAllControlPoints ()

void	UnsetNthControlPointPosition (int pointIndex)
	Set control point status to undefined.

void	UpdateAllMeasurements ()

virtual void	UpdateAssignedAttribute ()

	vtkMRMLCopyContentMacro (vtkMRMLMarkupsNode)

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

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


virtual int	GetLocked ()

void	SetLocked (int locked)

virtual void	LockedOn ()

virtual void	LockedOff ()


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

int	AddNControlPoints (int n, std::string label, double point[3])


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

int	AddControlPoint (double point[3], std::string label=std::string())

int	AddControlPoint (double x, double y, double z, std::string label=std::string())


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

int	AddControlPointWorld (double point[3], std::string label=std::string())

int	AddControlPointWorld (double x, double y, double z, std::string label=std::string())


bool	InsertControlPoint (ControlPoint *controlPoint, int targetIndex)

bool	InsertControlPoint (int n, vtkVector3d point, std::string label=std::string())

bool	InsertControlPoint (int n, double point[3], std::string label=std::string())


bool	InsertControlPointWorld (int n, vtkVector3d pointWorld, std::string label=std::string())

bool	InsertControlPointWorld (int n, double pointWorld[3], std::string label=std::string())


bool	GetNthControlPointAutoCreated (int n)

void	SetNthControlPointAutoCreated (int n, bool flag)


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

double *	GetNthControlPointPosition (int pointIndex) VTK_SIZEHINT(3)


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

vtkVector3d	GetNthControlPointPositionWorld (int pointIndex)


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

void	SetNthControlPointPosition (const int pointIndex, const double position[3], int positionStatus=PositionDefined)


void	SetNthControlPointPositionWorld (const int pointIndex, const double x, const double y, const double z, int positionStatus=PositionDefined)

void	SetNthControlPointPositionWorld (const int pointIndex, const double position[3], int positionStatus=PositionDefined)


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

void	SetNthControlPointOrientation (int n, const double wxyz[4])


double *	GetNthControlPointOrientationMatrix (int n) VTK_SIZEHINT(9)

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


void	GetNthControlPointOrientationMatrix (int n, vtkMatrix3x3 *matrix)

void	SetNthControlPointOrientationMatrix (int n, vtkMatrix3x3 *matrix)


void	GetNthControlPointOrientationMatrixWorld (int n, double orientationMatrix[9])

vtkVector< double, 9 >	GetNthControlPointOrientationMatrixWorld (int n)

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


void	GetNthControlPointOrientationMatrixWorld (int n, vtkMatrix3x3 *matrix)

void	SetNthControlPointOrientationMatrixWorld (int n, vtkMatrix3x3 *matrix)


void	SetCenterOfRotation (const double x, const double y, const double z)

void	SetCenterOfRotation (const double position[3])


void	SetCenterOfRotationWorld (const double x, const double y, const double z)

void	SetCenterOfRotationWorld (const double positionWorld[3])


void	GetNthControlPointNormal (int n, double normal[3])

vtkVector3d	GetNthControlPointNormal (int n)


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

vtkVector3d	GetNthControlPointNormalWorld (int n)


std::string	GetNthControlPointAssociatedNodeID (int n=0)

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


int	GetControlPointIndexByID (const char *id)

int	GetControlPointIndexByLabel (const char *label)

int	GetControlPointIndexByDescription (const char *description)


std::string	GetNthControlPointLabel (int n=0)

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


std::string	GetNthControlPointDescription (int n=0)

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


std::string	GetControlPointLabelFormat ()

void	SetControlPointLabelFormat (std::string format)


bool	GetFixedNumberOfControlPoints ()

void	SetFixedNumberOfControlPoints (bool fixed)


virtual vtkPoints *	GetCurvePoints ()

virtual vtkPoints *	GetCurvePointsWorld ()

virtual vtkPolyData *	GetCurve ()

virtual vtkPolyData *	GetCurveWorld ()

virtual vtkAlgorithmOutput *	GetCurveWorldConnection ()


int	GetControlPointPlacementStartIndex ()

void	SetControlPointPlacementStartIndex (int)


virtual int	GetLastUsedControlPointNumber ()

virtual void	SetLastUsedControlPointNumber (int)


void	SetNthControlPointOrientationFromPointer (int n, const double *orientationWXYZ)

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

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

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

virtual void	CreateDefaultSequenceDisplayNodes ()

vtkMRMLNode *	CreateNodeInstance () override=0
	MRMLNode methods.

virtual int	GetDisplayClassVisibility (const char *nodeClass)

vtkMRMLDisplayNode *	GetDisplayNode ()

const char *	GetDisplayNodeID ()

virtual const char *	GetDisplayNodeReferenceRole ()

virtual int	GetDisplayVisibility ()

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

vtkMRMLDisplayNode *	GetNthDisplayNode (int n)

const char *	GetNthDisplayNodeID (int n)

int	GetNumberOfDisplayNodes ()

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

void	PrintSelf (ostream &os, vtkIndent indent) override

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

void	RemoveNthDisplayNodeID (int n)

void	SetAndObserveDisplayNodeID (const char *displayNodeID)

void	SetAndObserveNthDisplayNodeID (int n, const char *displayNodeID)

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

virtual void	SetDisplayVisibility (int visible)

void	SetSelectable (int) override

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

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

virtual vtkImplicitFunction *	GetImplicitFunctionWorld ()

vtkMRMLTransformNode *	GetParentTransformNode ()
	Associated transform MRML node.

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

bool	HardenTransform ()

void	PrintSelf (ostream &os, vtkIndent indent) override

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

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

bool	SetAndObserveTransformNodeID (const char *transformNodeID)

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

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

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

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

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

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

virtual bool	AddDefaultStorageNode (const char *filename=nullptr)

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

virtual vtkMRMLStorageNode *	CreateDefaultSequenceStorageNode ()

virtual std::string	GetDefaultSequenceStorageNodeClassName ()

virtual std::string	GetDefaultStorageNodeClassName (const char *filename=nullptr)

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

const char *	GetNthStorageNodeID (int n)

int	GetNumberOfStorageNodes ()

const char *	GetSlicerDataType ()

vtkMRMLStorageNode *	GetStorageNode ()

const char *	GetStorageNodeID ()

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

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

void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)

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

virtual void	SetDefaultSequenceStorageNodeClassName (std::string)

void	SetSlicerDataType (const char *type)

virtual void	StorableModified ()

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

	vtkMRMLCopyContentMacro (vtkMRMLStorableNode)

Public Member Functions inherited from vtkMRMLNode
vtkMRMLNode *	AddAndObserveNodeReferenceID (const char referenceRole, const char referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Add and observe a reference node from this node for a specific referenceRole.

vtkMRMLNode *	AddNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Convenience method that adds a referencedNodeID at the end of the list.

void	AddNodeReferenceRole (const char referenceRole, const char mrmlAttributeName=nullptr, vtkIntArray *events=nullptr, bool observeContentModifiedEvents=false)
	Add a referenceRole.

virtual void	AddToSceneOff ()

virtual void	AddToSceneOn ()

void	ClearNodeReferenceProperties (const std::string &referenceRole)
	Remove all node reference properties for a specific referenceRole.

void	ClearNthNodeReferenceProperties (const std::string &referenceRole, int n)

virtual void	CopyContent (vtkMRMLNode *node, bool deepCopy=true)
	Copy node contents from another node of the same type. Does not copy node ID, Scene, Name, SingletonTag, HideFromEditors, AddToScene, UndoEnabled, and node references. If deepCopy is set to false then a shallow copy of bulk data (such as image or mesh data) could be made; copying may be faster but the node may share some data with the source node instead of creating an independent copy.

virtual void	CopyReferences (vtkMRMLNode *node)
	Copy the references of the node into this.

void	CopyWithScene (vtkMRMLNode *node)
	Copy everything (including Scene and ID) from another node of the same type.

void	DisableModifiedEventOff ()

void	DisableModifiedEventOn ()

virtual int	GetAddToScene ()
	node added to MRML scene.

const char *	GetAttribute (const char *name)
	Get value of a name value pair attribute.

std::vector< std::string >	GetAttributeNames ()
	Get all attribute names.

void	GetAttributeNames (vtkStringArray *attributeNames)
	Get all attribute names. Python-wrappable version.

virtual vtkIntArray *	GetContentModifiedEvents ()

int	GetCustomModifiedEventPending (int eventId)

virtual char *	GetDescription ()

virtual int	GetDisableModifiedEvent ()
	Turn on/off generating InvokeEvent for set macros.

virtual int	GetHideFromEditors ()
	Describes if the node is hidden.

virtual char *	GetID ()
	ID use by other nodes to reference this node in XML.

virtual int	GetInMRMLCallbackFlag ()
	Flags to avoid event loops.

virtual int	GetModifiedEventPending ()

virtual char *	GetName ()

vtkMRMLNode *	GetNodeReference (const char *referenceRole)

const char *	GetNodeReferenceID (const char *referenceRole)
	Utility function that returns the first node id for a specific referenceRole.

void	GetNodeReferenceIDs (const char referenceRole, std::vector< const char > &referencedNodeIDs)
	Return a list of the referenced node IDs.

const ReferencePropertiesType *	GetNodeReferenceProperties (const char *referenceRole)

std::string	GetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
	Get the node reference property for a specific referenceRole.

std::string	GetNodeReferencePropertyName (const std::string &referenceRole, int propertyIndex)
	Get the name of the Nth node reference property for a specific referenceRole.

std::vector< std::string >	GetNodeReferencePropertyNames (const std::string &referenceRole)
	Get the names of all node reference properties for a specific referenceRole.

void	GetNodeReferenceRoles (std::vector< std::string > &roles)

void	GetNodeReferences (const char referenceRole, std::vector< vtkMRMLNode > &nodes)
	Return a list of the referenced nodes.

vtkMRMLNode *	GetNthNodeReference (const char *referenceRole, int n)
	Get referenced MRML node for a specific referenceRole.

const char *	GetNthNodeReferenceID (const char *referenceRole, int n)
	Return the string of the Nth node ID for a specific reference role.

const ReferencePropertiesType *	GetNthNodeReferenceProperties (const char *referenceRole, int n)

std::string	GetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)

std::string	GetNthNodeReferencePropertyName (const std::string &referenceRole, int referenceIndex, int propertyIndex)

std::vector< std::string >	GetNthNodeReferencePropertyNames (const std::string &referenceRole, int n)

const char *	GetNthNodeReferenceRole (int n)

int	GetNumberOfNodeReferenceProperties (const std::string &referenceRole)
	Get the number of node reference properties for a specific referenceRole.

int	GetNumberOfNodeReferenceRoles ()

int	GetNumberOfNodeReferences (const char *referenceRole)
	Return the number of node IDs for a specific reference role (and nodes as they always have the same size).

int	GetNumberOfNthNodeReferenceProperties (const std::string &referenceRole, int n)

virtual int	GetSaveWithScene ()
	Save node with MRML scene.

virtual vtkMRMLScene *	GetScene ()
	Get the scene this node has been added to.

virtual int	GetSelectable ()
	Describes if the node is selectable.

virtual int	GetSelected ()
	Get/Set for Selected.

virtual char *	GetSingletonTag ()

virtual bool	GetUndoEnabled ()

virtual bool	HasCopyContent () const
	Returns true if the class supports deep and shallow copying node content.

bool	HasNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Return true if referencedNodeID is in the node ID list for a specific referenceRole.

virtual void	HideFromEditorsOff ()

virtual void	HideFromEditorsOn ()

virtual void	InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
	This method allows the node to compress events.

virtual int	InvokePendingModifiedEvent ()
	Invokes any modified events that are `pending`.

bool	IsSingleton ()

void	Modified () override
	Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent.

virtual void	OnNodeAddedToScene ()

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	ProcessChildNode (vtkMRMLNode *)
	Set dependencies between this node and a child node when parsing XML file.

void	RemoveAttribute (const char *name)
	Remove attribute with the specified name.

void	RemoveNodeReferenceIDs (const char *referenceRole)
	Remove all node IDs and associated nodes for a specific referenceRole.

void	RemoveNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
	Remove a node reference property for a specific referenceRole.

void	RemoveNthNodeReferenceID (const char *referenceRole, int n)
	Convenience method that removes the Nth node ID from the list.

void	RemoveNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)

virtual void	Reset (vtkMRMLNode *defaultNode)
	Reset node attributes to the initial state as defined in the constructor or the passed default node.

virtual void	SaveWithSceneOff ()

virtual void	SaveWithSceneOn ()

virtual void	SelectableOff ()

virtual void	SelectableOn ()

virtual void	SelectedOff ()

virtual void	SelectedOn ()

virtual void	SetAddToScene (int)

void	SetAddToSceneNoModify (int value)

vtkMRMLNode *	SetAndObserveNodeReferenceID (const char referenceRole, const char referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Set and observe a reference node from this node for a specific referenceRole.

vtkMRMLNode *	SetAndObserveNthNodeReferenceID (const char referenceRole, int n, const char referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Set and observe the Nth node ID for a specific reference role.

void	SetAttribute (const char name, const char value)
	Set a name value pair attribute.

virtual void	SetDescription (const char *)
	Text description of this node, to be set by the user.

void	SetDisableModifiedEvent (int onOff)

virtual void	SetHideFromEditors (int)

void	SetInMRMLCallbackFlag (int flag)

virtual void	SetName (const char *)
	Name of this node, to be set by the user.

vtkMRMLNode *	SetNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Set a reference to a node with specified nodeID from this node for a specific referenceRole.

void	SetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName, const std::string &value)
	Set the node reference property for a specific referenceRole.

vtkMRMLNode *	SetNthNodeReferenceID (const char referenceRole, int n, const char referencedNodeID)
	Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole.

void	SetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName, const std::string &value)

virtual void	SetSaveWithScene (int)

virtual void	SetScene (vtkMRMLScene *scene)
	This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene.

virtual void	SetSceneReferences ()
	Update the references of the node to the scene.

virtual void	SetSelected (int)

void	SetSingletonOff ()

void	SetSingletonOn ()

virtual void	SetSingletonTag (const char *)
	Tag that make this node a singleton in the scene.

virtual void	SetUndoEnabled (bool)

virtual int	StartModify ()
	Start modifying the node. Disable Modify events.

virtual void	UndoEnabledOff ()

virtual void	UndoEnabledOn ()

virtual void	UpdateReferenceID (const char oldID, const char newID)
	Update the stored reference to another node in the scene.

virtual void	UpdateReferences ()
	The method should remove all pointers and observations to all nodes that are not in the scene anymore.

const char *	URLDecodeString (const char *inString)
	Decode a URL string.

const char *	URLEncodeString (const char *inString)
	Encode a URL string.

virtual void	WriteNodeBodyXML (ostream &of, int indent)
	Write this node's body to a MRML file in XML format.

std::string	XMLAttributeDecodeString (const std::string &inString)
	Decode an XML attribute string.

std::string	XMLAttributeEncodeString (const std::string &inString)
	Encode an XML attribute string (replaces special characters by code sequences)

Static Public Member Functions
static const char *	GetPositionStatusAsString (int id)

static int	GetPositionStatusFromString (const char *name)

static int	IsTypeOf (const char *type)

static vtkMRMLMarkupsNode *	SafeDownCast (vtkObject *o)


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

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

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

static vtkMRMLDisplayableNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLTransformableNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLStorableNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLNode *	SafeDownCast (vtkObject *o)

Protected Member Functions
std::string	GenerateControlPointLabel (int controlPointIndex)

std::string	GenerateUniqueControlPointID ()

ControlPoint *	GetNthControlPointCustomLog (int n, const char *failedMethodName)

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

void	operator= (const vtkMRMLMarkupsNode &)

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

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

virtual void	TransformOrientationMatrixFromNodeToWorld (const double position_Node[3], const double orientationMatrix_Node[9], double orientationMatrix_World[9])
	Transform the orientation matrix from node to world coordinates.

virtual void	TransformOrientationMatrixFromWorldToNode (const double position_World[3], const double orientationMatrix_World[9], double orientationMatrix_Node[9])
	Transform the orientation matrix from world to node coordinates.

virtual void	UpdateCurvePolyFromControlPoints ()

virtual void	UpdateInteractionHandleToWorldMatrix ()
	Calculates the handle to world matrix based on the current control points.

virtual void	UpdateMeasurementsInternal ()

	vtkMRMLMarkupsNode ()

	vtkMRMLMarkupsNode (const vtkMRMLMarkupsNode &)

virtual void	WriteMeasurementsToDescription ()

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

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

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

void	operator= (const vtkMRMLDisplayableNode &)

	vtkMRMLDisplayableNode ()

	vtkMRMLDisplayableNode (const vtkMRMLDisplayableNode &)

	~vtkMRMLDisplayableNode () override

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

virtual const char *	GetTransformNodeReferenceRole ()

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

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

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

void	operator= (const vtkMRMLTransformableNode &)

	vtkMRMLTransformableNode ()

	vtkMRMLTransformableNode (const vtkMRMLTransformableNode &)

	~vtkMRMLTransformableNode () override

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

virtual const char *	GetStorageNodeReferenceRole ()

virtual vtkTimeStamp	GetStoredTime ()

void	operator= (const vtkMRMLStorableNode &)

	vtkMRMLStorableNode ()

	vtkMRMLStorableNode (const vtkMRMLStorableNode &)

	~vtkMRMLStorableNode () override

Protected Member Functions inherited from vtkMRMLNode
virtual const char *	GetMRMLAttributeNameFromReferenceRole (const char *refRole)
	Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise.

virtual const char *	GetReferenceRoleFromMRMLAttributeName (const char *attName)
	Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise.

virtual char *	GetTempURLString ()

void	GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray oldConsolidatedEventList, vtkIntArray newConsolidatedEventList, vtkMRMLNode oldReferencedNode, vtkMRMLNode newReferencedNode, vtkMRMLNodeReference referenceToIgnore, vtkIntArray newEvents, bool newObserveContentModifiedEvents)

virtual void	InvalidateNodeReferences ()

virtual bool	IsReferenceRoleGeneric (const char *refRole)
	Return true if the reference role is generic (ends with '/') or false otherwise.

std::string	NodeReferencePropertyDecodeString (const std::string &inString)
	Decode a node reference property string.

std::string	NodeReferencePropertyEncodeString (const std::string &inString)
	Encode a node reference property string (replaces special characters by code sequences)

void	operator= (const vtkMRMLNode &)

void	ParseReferencesAttribute (const char *attValue, std::set< std::string > &references)

void	RemoveInvalidReferences (const std::set< std::string > &validNodeIDs)

virtual void	SetTempURLString (const char *)
	Get/Set the string used to manage encoding/decoding of strings/URLs with special characters.

vtkMRMLNode *	UpdateNodeReferenceEventObserver (vtkMRMLNode oldReferencedNode, vtkMRMLNode newReferencedNode, vtkIntArray newEvents, bool newObserveContentModifiedEvents, vtkMRMLNodeReference referenceToIgnore)

virtual void	UpdateNodeReferences (const char *referenceRole=nullptr)

virtual void	UpdateNthNodeReference (const char *referenceRole, int n)

	vtkMRMLNode ()

	vtkMRMLNode (const vtkMRMLNode &)

	~vtkMRMLNode () override
	critical to have a virtual destructor!

Protected Attributes
vtkVector3d	CenterOfRotation

std::string	ControlPointLabelFormat {"%N-%d"}

int	ControlPointPlacementStartIndex { -1 }
	Index of the control point index that placement is started from (if no other point is requested specifically).

ControlPointsListType	ControlPoints
	Vector of control points.

bool	CurveClosed {false}

vtkSmartPointer< vtkParallelTransportFrame >	CurveCoordinateSystemGeneratorWorld

vtkSmartPointer< vtkCurveGenerator >	CurveGenerator
	Converts curve control points to curve points.

vtkSmartPointer< vtkPolyData >	CurveInputPoly

vtkSmartPointer< vtkGeneralTransform >	CurvePolyToWorldTransform

vtkSmartPointer< vtkTransformPolyDataFilter >	CurvePolyToWorldTransformer

std::string	DefaultNodeNamePrefix
	Store markup short name. Translated to the application language.

bool	FixedNumberOfControlPoints {false}

vtkSmartPointer< vtkMatrix4x4 >	InteractionHandleToWorldMatrix
	Transform that moves the xyz unit vectors and origin of the interaction handles to local coordinates.

bool	IsUpdatingPoints {false}
	Flag set from SetControlPointPositionsWorld that pauses update of measurements until the update is complete.

int	LastUsedControlPointNumber {0}

int	Locked {0}
	Locks all the points and GUI.

int	MaximumNumberOfControlPoints {-1}

vtkCollection *	Measurements
	List of measurements stored for the markup.

std::string	PropertiesLabelText

int	RequiredNumberOfControlPoints {0}

vtkSmartPointer< vtkStringArray >	TextList

vtkSmartPointer< vtkPointLocator >	TransformedCurvePolyLocator

std::string	TypeDisplayName
	Store markup type GUI display name. Translated to the application language.

Protected Attributes inherited from vtkMRMLStorableNode
std::string	DefaultSequenceStorageNodeClassName

std::string	SlicerDataType

vtkTimeStamp	StorableModifiedTime

vtkTagTable *	UserTagTable

Protected Attributes inherited from vtkMRMLNode
int	AddToScene {1}

AttributesType	Attributes

vtkIntArray *	ContentModifiedEvents

char *	Description {nullptr}

int	HideFromEditors {0}

char *	ID {nullptr}

int	InMRMLCallbackFlag {0}
	Flag to avoid event loops.

vtkCallbackCommand *	MRMLCallbackCommand
	Holders for MRML callbacks.

vtkObserverManager *	MRMLObserverManager

char *	Name {nullptr}

NodeReferenceEventsType	NodeReferenceEvents

std::map< std::string, std::string >	NodeReferenceMRMLAttributeNames

NodeReferencesType	NodeReferences

int	SaveWithScene {true}

vtkWeakPointer< vtkMRMLScene >	Scene

int	Selectable {1}

int	Selected {0}

bool	UndoEnabled {false}

Friends
class	qSlicerMarkupsModuleWidget

class	vtkMRMLMarkupsFiducialStorageNode

class	vtkMRMLMarkupsJsonStorageNode

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

Additional Inherited Members
Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string >	AttributesType

typedef std::map< std::string, NodeReferenceEventList >	NodeReferenceEventsType

typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > >	NodeReferenceListType

typedef std::map< std::string, NodeReferenceListType >	NodeReferencesType

Static Protected Member Functions inherited from vtkMRMLNode
static void	MRMLCallback (vtkObject caller, unsigned long eid, void clientData, void *callData)

Static Protected Attributes inherited from vtkMRMLDisplayableNode
static const char *	DisplayNodeReferenceMRMLAttributeName

static const char *	DisplayNodeReferenceRole

Static Protected Attributes inherited from vtkMRMLTransformableNode
static const char *	TransformNodeReferenceMRMLAttributeName

static const char *	TransformNodeReferenceRole

Static Protected Attributes inherited from vtkMRMLStorableNode
static const char *	StorageNodeReferenceMRMLAttributeName

static const char *	StorageNodeReferenceRole

Detailed Description

Definition at line 81 of file vtkMRMLMarkupsNode.h.

Member Typedef Documentation

◆ ControlPointsListType

typedef std::vector<ControlPoint*> vtkMRMLMarkupsNode::ControlPointsListType

Definition at line 138 of file vtkMRMLMarkupsNode.h.

◆ Superclass

typedef vtkMRMLDisplayableNode vtkMRMLMarkupsNode::Superclass

Definition at line 140 of file vtkMRMLMarkupsNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

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

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	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.
PointPositionDefinedEvent	Point was not defined (undefined, preview position status, or non-existent point) before but now it is defined.
PointPositionUndefinedEvent	Point position was defined and now it is not defined anymore (point deleted or position is not defined).
PointPositionMissingEvent	Point was not not missing before and now it is missing.
PointPositionNonMissingEvent	Point missing before and now it is not missing.
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 with a control point process finishes.
CenterOfRotationModifiedEvent	When position of the center of rotation is changed (used for example for rotating closed curves).
FixedNumberOfControlPointsModifiedEvent	When fixed number of points set/unset.
PointAboutToBeRemovedEvent	Point is about to be deleted. Thus it is alive when event is called.

Definition at line 241 of file vtkMRMLMarkupsNode.h.

◆ anonymous enum

anonymous enum

Placement status of a control point.

Enumerator
PositionUndefined	PositionUndefined: position is undefined (coordinate values must not be used).
PositionPreview	PositionPreview: new point is being placed, position is tentative.
PositionDefined	PositionDefined: position is specified.
PositionMissing	PositionMissing: point is undefined and placement should not be attempted.
PositionStatus_Last	PositionStatus_Last: indicates the end of the enum (int first = 0, int last = PositionStatus_Last)

Definition at line 261 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/4]

int vtkMRMLMarkupsNode::AddControlPoint	(	ControlPoint *	controlPoint,
		bool	autoLabel = true )

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)

Parameters

autoLabel if enabled (by default it is) then empty point label will be replaced with automatically generated label.

◆ AddControlPoint() [2/4]

int vtkMRMLMarkupsNode::AddControlPoint	(	double	point[3],
		std::string	label = std::string() )

◆ AddControlPoint() [3/4]

int vtkMRMLMarkupsNode::AddControlPoint	(	double	x,
		double	y,
		double	z,
		std::string	label = std::string() )

◆ AddControlPoint() [4/4]

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

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

◆ AddControlPointWorld() [1/3]

int vtkMRMLMarkupsNode::AddControlPointWorld	(	double	point[3],
		std::string	label = std::string() )

◆ AddControlPointWorld() [2/3]

int vtkMRMLMarkupsNode::AddControlPointWorld	(	double	x,
		double	y,
		double	z,
		std::string	label = std::string() )

◆ AddControlPointWorld() [3/3]

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() [1/2]

int vtkMRMLMarkupsNode::AddNControlPoints	(	int	n,
		std::string	label,
		double	point[3] )

◆ AddNControlPoints() [2/2]

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 point positions are initialized to (0,0,0). If requested number of points would result more points than the maximum allowed number of points then no points are added at all. Return index of the last placed control point, -1 on failure.

◆ ApplyTransform() [1/2]

void vtkMRMLMarkupsNode::ApplyTransform ( vtkAbstractTransform * transform )

overridevirtual

Apply the passed transformation to all of the control points

See also: CanApplyNonLinearTransforms

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

◆ ApplyTransform() [2/2]

virtual void vtkMRMLMarkupsNode::ApplyTransform	(	vtkAbstractTransform *	transform,
		bool	applyToLockedControlPoints )

virtual

Reimplemented in vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

◆ CanApplyNonLinearTransforms()

bool vtkMRMLMarkupsNode::CanApplyNonLinearTransforms ( ) const

overridevirtual

Returns true since can apply non linear transforms

See also: ApplyTransform

Reimplemented from vtkMRMLTransformableNode.

◆ ClearValueForAllMeasurements()

void vtkMRMLMarkupsNode::ClearValueForAllMeasurements ( )

◆ 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

Helper methods for converting orientation between WXYZ quaternion and 3x3 matrix representation. WXYZ: W rotation angle in degrees, XYZ is rotation axis.

◆ ConvertOrientationWXYZToMatrix()

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

static

◆ CreateDefaultDisplayNodes()

void vtkMRMLMarkupsNode::CreateDefaultDisplayNodes ( )

overridevirtual

Create and observe default display node(s)

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

◆ CreateDefaultStorageNode()

vtkMRMLStorageNode * vtkMRMLMarkupsNode::CreateDefaultStorageNode ( )

overridevirtual

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

Reimplemented from vtkMRMLStorableNode.

Reimplemented in vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

◆ EndModify()

int vtkMRMLMarkupsNode::EndModify ( int previousDisableModifiedEventState )

overridevirtual

End modifying the node. Updates pending measurements and other updates.

See also: StartModify()

Reimplemented from vtkMRMLNode.

◆ 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

◆ GetAddIcon()

virtual const char * vtkMRMLMarkupsNode::GetAddIcon ( )

inlinevirtual

Reimplemented in vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsClosedCurveNode, vtkMRMLMarkupsCurveNode, vtkMRMLMarkupsFiducialNode, vtkMRMLMarkupsLineNode, vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

Definition at line 145 of file vtkMRMLMarkupsNode.h.

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

Reimplemented in vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

◆ GetCenterOfRotation() [1/2]

vtkVector3d vtkMRMLMarkupsNode::GetCenterOfRotation ( )

Get the center position of the transformations, such as rotation and scaling. Return (0,0,0) if undefined.

See also: GetCenterOfRotationWorld

◆ GetCenterOfRotation() [2/2]

bool vtkMRMLMarkupsNode::GetCenterOfRotation ( double point[3] )

Get the center position of the transformations, such as rotation and scaling. Returns false if center position is undefined.

See also: GetCenterOfRotationWorld

◆ GetCenterOfRotationVector()

vtkVector3d vtkMRMLMarkupsNode::GetCenterOfRotationVector ( )

inline

Get the position of the center.

Deprecated: Use GetCenterOfRotation instead. Return (0,0,0) if center position is undefined.

Definition at line 833 of file vtkMRMLMarkupsNode.h.

◆ GetCenterOfRotationWorld()

bool vtkMRMLMarkupsNode::GetCenterOfRotationWorld ( double worldxyz[3] )

Get the center position of the transformations, such as rotation and scaling, in World coordinate system. Returns true on success.

◆ GetClassName()

virtual const char * vtkMRMLMarkupsNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsClosedCurveNode, vtkMRMLMarkupsCurveNode, vtkMRMLMarkupsFiducialNode, vtkMRMLMarkupsLineNode, vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

◆ GetClosestControlPointIndexToPositionWorld()

int vtkMRMLMarkupsNode::GetClosestControlPointIndexToPositionWorld	(	double	pos[3],
		bool	visibleOnly = false )

Get the index of the closest control point to the world coordinates. If visibleOnly is set to true then index of the closest visible control point will be returned.

◆ GetControlPointIndexByDescription()

int vtkMRMLMarkupsNode::GetControlPointIndexByDescription ( const char * description )

◆ GetControlPointIndexByID()

int vtkMRMLMarkupsNode::GetControlPointIndexByID ( const char * id )

Find the first control point index by the specified id, label, or description. Returns -1 if no such control point was found.

◆ GetControlPointIndexByLabel()

int vtkMRMLMarkupsNode::GetControlPointIndexByLabel ( const char * label )

◆ GetControlPointIndexFromInterpolatedPointIndex()

int vtkMRMLMarkupsNode::GetControlPointIndexFromInterpolatedPointIndex ( vtkIdType interpolatedPointIndex )

Converts curve point index to control point index.

◆ GetControlPointLabelFormat()

std::string vtkMRMLMarkupsNode::GetControlPointLabelFormat ( )

Get/Set the ControlPointLabelFormat string that defines the control point names. 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 control point names of Name-0, Name-1, Name-2. If format string is changed then LabelFormatModifiedEvent event is invoked.

◆ GetControlPointLabels()

void vtkMRMLMarkupsNode::GetControlPointLabels ( vtkStringArray * labels )

Get all control point labels at once.

◆ GetControlPointPlacementComplete()

virtual bool vtkMRMLMarkupsNode::GetControlPointPlacementComplete ( )

virtual

Returns true if no additional control points can be added to this node.

◆ GetControlPointPlacementStartIndex()

int vtkMRMLMarkupsNode::GetControlPointPlacementStartIndex ( )

Set the index of the control point that will be placed next.

Currently, this property is not stored persistently in the scene and modifying it does not trigger a node modification event, because it is considered to be a temporary value. For example, it would not be desirable to store this value for each item in a markups node sequence, or include it in undo/redo.

◆ GetControlPointPositionsWorld()

void vtkMRMLMarkupsNode::GetControlPointPositionsWorld ( vtkPoints * points )

Get a copy of all control point positions in world coordinate system.

◆ GetControlPoints()

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

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

◆ GetCurve()

virtual vtkPolyData * vtkMRMLMarkupsNode::GetCurve ( )

virtual

◆ GetCurveClosed()

virtual bool vtkMRMLMarkupsNode::GetCurveClosed ( )

virtual

Returns true if the curve generator creates a closed curve.

◆ GetCurveCoordinateSystemGeneratorWorld()

vtkParallelTransportFrame * vtkMRMLMarkupsNode::GetCurveCoordinateSystemGeneratorWorld ( )

inline

The internal instance of the curve coordinate system generator to allow use of the coordinate systems computed for curve point for other computations.

Definition at line 694 of file vtkMRMLMarkupsNode.h.

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

◆ GetCurvePoints()

virtual vtkPoints * vtkMRMLMarkupsNode::GetCurvePoints ( )

virtual

Get markup control points.

◆ GetCurvePointsWorld()

virtual vtkPoints * vtkMRMLMarkupsNode::GetCurvePointsWorld ( )

virtual

Reimplemented in vtkMRMLMarkupsCurveNode.

◆ GetCurveWorld()

virtual vtkPolyData * vtkMRMLMarkupsNode::GetCurveWorld ( )

virtual

Reimplemented in vtkMRMLMarkupsCurveNode.

◆ GetCurveWorldConnection()

virtual vtkAlgorithmOutput * vtkMRMLMarkupsNode::GetCurveWorldConnection ( )

virtual

Reimplemented in vtkMRMLMarkupsCurveNode.

◆ GetDefaultNodeNamePrefix()

virtual const char * vtkMRMLMarkupsNode::GetDefaultNodeNamePrefix ( )

virtual

Get markup short name. This may be displayed to the user and therefore it is translated to the application language.

◆ GetFixedNumberOfControlPoints()

bool vtkMRMLMarkupsNode::GetFixedNumberOfControlPoints ( )

Get/Set locking of control point count. If number of control points is fixed then points cannot be added or removed only their position can be set/unset.

◆ GetIcon()

virtual const char * vtkMRMLMarkupsNode::GetIcon ( )

inlinevirtual

Reimplemented in vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsClosedCurveNode, vtkMRMLMarkupsCurveNode, vtkMRMLMarkupsFiducialNode, vtkMRMLMarkupsLineNode, vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

Definition at line 144 of file vtkMRMLMarkupsNode.h.

◆ GetInteractionHandleToWorldMatrix()

virtual vtkMatrix4x4 * vtkMRMLMarkupsNode::GetInteractionHandleToWorldMatrix ( )

virtual

4x4 matrix detailing the orientation and position in world coordinates of the interaction handles.

◆ GetLastUsedControlPointNumber()

virtual int vtkMRMLMarkupsNode::GetLastUsedControlPointNumber ( )

virtual

This value is used for generating number in the control point's name when a new point is added. The value is not decremented when a control point is deleted to keep the control point names unique. The value is reset to 0 when

See also: RemoveAllControlPoints is called.

◆ GetLocked()

virtual int vtkMRMLMarkupsNode::GetLocked ( )

virtual

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

◆ GetMarkupLabelFormat()

std::string vtkMRMLMarkupsNode::GetMarkupLabelFormat ( )

inline

Deprecated: Use GetControlPointLabelFormat instead.

Definition at line 910 of file vtkMRMLMarkupsNode.h.

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

◆ GetMarkupsDisplayNode()

vtkMRMLMarkupsDisplayNode * vtkMRMLMarkupsNode::GetMarkupsDisplayNode ( )

Return a cast display node, returns null if none.

◆ GetMarkupType()

virtual const char * vtkMRMLMarkupsNode::GetMarkupType ( )

inlinevirtual

Get markup type internal name. This type name is the same regardless of the chosen application language and should not be displayed to end users.

Reimplemented in vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsClosedCurveNode, vtkMRMLMarkupsCurveNode, vtkMRMLMarkupsFiducialNode, vtkMRMLMarkupsLineNode, vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

Definition at line 154 of file vtkMRMLMarkupsNode.h.

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

◆ GetMeasurement()

vtkMRMLMeasurement * vtkMRMLMarkupsNode::GetMeasurement ( const char * name )

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

◆ 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

◆ GetNthControlPointAutoCreated()

bool vtkMRMLMarkupsNode::GetNthControlPointAutoCreated ( int n )

Get/Set control point auto-created status. Set to true if point was generated automatically

◆ 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/Set 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. Deprecated. Use GetControlPointIndexByID instead.

◆ GetNthControlPointIndexByPositionStatus()

int vtkMRMLMarkupsNode::GetNthControlPointIndexByPositionStatus	(	int	pointIndex,
		int	positionStatus )

Get index of N-th control point of the specified status. (for example, get index of N-th placed control point). pointIndex is zero-based, so to get index of the first control point, use pointIndex=0. Return -1 if no such control point is found.

◆ GetNthControlPointLabel()

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

Get/Set the Label on the Nth control point.

◆ 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() [1/2]

vtkVector3d vtkMRMLMarkupsNode::GetNthControlPointNormal ( int n )

◆ GetNthControlPointNormal() [2/2]

void vtkMRMLMarkupsNode::GetNthControlPointNormal	(	int	n,
		double	normal[3] )

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

◆ GetNthControlPointNormalWorld() [1/2]

vtkVector3d vtkMRMLMarkupsNode::GetNthControlPointNormalWorld ( int n )

◆ GetNthControlPointNormalWorld() [2/2]

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 The value W is in degrees.

◆ GetNthControlPointOrientationMatrix() [1/2]

double * vtkMRMLMarkupsNode::GetNthControlPointOrientationMatrix ( int n )

Get/Set orientation as 9 values: x, y, and z axis directions, respectively: x (0, 3, 6), y (1, 4, 7), z (2, 5, 8)

◆ GetNthControlPointOrientationMatrix() [2/2]

void vtkMRMLMarkupsNode::GetNthControlPointOrientationMatrix	(	int	n,
		vtkMatrix3x3 *	matrix )

Get/Set orientation as a vtkMatrix3x3.

◆ GetNthControlPointOrientationMatrixWorld() [1/3]

vtkVector< double, 9 > vtkMRMLMarkupsNode::GetNthControlPointOrientationMatrixWorld ( int n )

◆ GetNthControlPointOrientationMatrixWorld() [2/3]

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

Get/Set orientation in world coordinate system as 9 values: x, y, and z axis directions, respectively: x (0, 3, 6), y (1, 4, 7), z (2, 5, 8)

◆ GetNthControlPointOrientationMatrixWorld() [3/3]

void vtkMRMLMarkupsNode::GetNthControlPointOrientationMatrixWorld	(	int	n,
		vtkMatrix3x3 *	matrix )

Get/Set orientation in world coordinate system as a vtkMatrix3x3.

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

Deprecated: Use GetNthControlPointOrientation instead - with a different XYZW/WXYZ component order!

◆ GetNthControlPointPosition() [1/2]

double * vtkMRMLMarkupsNode::GetNthControlPointPosition ( int pointIndex )

◆ GetNthControlPointPosition() [2/2]

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

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

◆ 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

◆ GetNthControlPointPositionVisibility()

bool vtkMRMLMarkupsNode::GetNthControlPointPositionVisibility ( int n = 0 )

Get point visibility and visibility of point position status returns true if point visibility is enabled and the position is defined or in preview mode.

◆ GetNthControlPointPositionWorld() [1/2]

vtkVector3d vtkMRMLMarkupsNode::GetNthControlPointPositionWorld ( int pointIndex )

◆ GetNthControlPointPositionWorld() [2/2]

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

◆ GetNthMarkupID()

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

inline

Deprecated: Use GetNthControlPointID instead.

Definition at line 878 of file vtkMRMLMarkupsNode.h.

◆ GetNthMarkupLabel()

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

inline

Deprecated: Use GetNthControlPointLabel instead.

Definition at line 898 of file vtkMRMLMarkupsNode.h.

◆ GetNthMarkupLocked()

bool vtkMRMLMarkupsNode::GetNthMarkupLocked ( int n = 0 )

inline

Deprecated: Use GetNthControlPointLocked instead.

Definition at line 885 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 ( bool includePreview = false )

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

◆ GetNumberOfEnabledMeasurements()

int vtkMRMLMarkupsNode::GetNumberOfEnabledMeasurements ( )

◆ GetNumberOfMarkups()

int vtkMRMLMarkupsNode::GetNumberOfMarkups ( )

inline

Deprecated: Use GetNumberOfControlPoints() instead.

Definition at line 762 of file vtkMRMLMarkupsNode.h.

◆ GetNumberOfMeasurements()

int vtkMRMLMarkupsNode::GetNumberOfMeasurements ( )

Get measurement data, such as length, angle, diameter, cross-section area. Add/remove/clear measurements.

◆ GetNumberOfMovableControlPoints()

int vtkMRMLMarkupsNode::GetNumberOfMovableControlPoints ( )

Return the number of unlocked control points with defined position in this node.

◆ GetNumberOfPointsInNthMarkup()

int vtkMRMLMarkupsNode::GetNumberOfPointsInNthMarkup ( int )

inline

Deprecated: Use GetNumberOfControlPoints() instead.

Definition at line 768 of file vtkMRMLMarkupsNode.h.

◆ GetNumberOfUndefinedControlPoints()

int vtkMRMLMarkupsNode::GetNumberOfUndefinedControlPoints ( bool includePreview = false )

Return the number of control points that have not been placed (not being previewed or skipped).

◆ GetPlaceAddIcon()

virtual const char * vtkMRMLMarkupsNode::GetPlaceAddIcon ( )

inlinevirtual

Reimplemented in vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsClosedCurveNode, vtkMRMLMarkupsCurveNode, vtkMRMLMarkupsFiducialNode, vtkMRMLMarkupsLineNode, vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

Definition at line 146 of file vtkMRMLMarkupsNode.h.

◆ GetPositionStatusAsString()

static const char * vtkMRMLMarkupsNode::GetPositionStatusAsString ( int id )

static

◆ GetPositionStatusFromString()

static int vtkMRMLMarkupsNode::GetPositionStatusFromString ( const char * name )

static

◆ GetPropertiesLabelText()

virtual std::string vtkMRMLMarkupsNode::GetPropertiesLabelText ( )

virtual

Get displayable string of the properties label (containing name, measurements, etc.) that identifies the node and provides basic information.

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

Reimplemented in vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

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

◆ GetTypeDisplayName()

virtual const char * vtkMRMLMarkupsNode::GetTypeDisplayName ( )

overridevirtual

Get markup type GUI display name This may be displayed to the user and therefore it is translated to the application language.

Reimplemented from vtkMRMLNode.

◆ GetUnitNode()

vtkMRMLUnitNode * vtkMRMLMarkupsNode::GetUnitNode ( const char * quantity )

Utility function to get unit node from scene.

◆ InsertControlPoint() [1/3]

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.

◆ InsertControlPoint() [2/3]

bool vtkMRMLMarkupsNode::InsertControlPoint	(	int	n,
		double	point[3],
		std::string	label = std::string() )

◆ InsertControlPoint() [3/3]

bool vtkMRMLMarkupsNode::InsertControlPoint	(	int	n,
		vtkVector3d	point,
		std::string	label = std::string() )

◆ InsertControlPointWorld() [1/2]

bool vtkMRMLMarkupsNode::InsertControlPointWorld	(	int	n,
		double	pointWorld[3],
		std::string	label = std::string() )

◆ InsertControlPointWorld() [2/2]

bool vtkMRMLMarkupsNode::InsertControlPointWorld	(	int	n,
		vtkVector3d	pointWorld,
		std::string	label = std::string() )

◆ IsA()

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

virtual

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsClosedCurveNode, vtkMRMLMarkupsCurveNode, vtkMRMLMarkupsFiducialNode, vtkMRMLMarkupsLineNode, vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

◆ IsTypeOf()

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

static

◆ LockedOff()

virtual void vtkMRMLMarkupsNode::LockedOff ( )

virtual

◆ LockedOn()

virtual void vtkMRMLMarkupsNode::LockedOn ( )

virtual

◆ MarkupExists()

bool vtkMRMLMarkupsNode::MarkupExists ( int n )

inline

Deprecated: Use ControlPointExists instead.

Definition at line 755 of file vtkMRMLMarkupsNode.h.

◆ OnTransformNodeReferenceChanged()

void vtkMRMLMarkupsNode::OnTransformNodeReferenceChanged ( vtkMRMLTransformNode * transformNode )

overrideprotectedvirtual

Called when transform node reference added/modified/removed.

Reimplemented from vtkMRMLTransformableNode.

Reimplemented in vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

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

Reimplemented in vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

◆ ReadXMLAttributes()

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

overridevirtual

Read node attributes from XML file.

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLMarkupsPlaneNode.

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

◆ RemoveAllMeasurements()

void vtkMRMLMarkupsNode::RemoveAllMeasurements ( )

◆ RemoveMarkup()

void vtkMRMLMarkupsNode::RemoveMarkup ( int pointIndex )

inline

Deprecated: Use RemoveNthControlPoint instead.

Definition at line 785 of file vtkMRMLMarkupsNode.h.

◆ RemoveNthControlPoint()

void vtkMRMLMarkupsNode::RemoveNthControlPoint ( int pointIndex )

Remove Nth Control Point.

◆ RemoveNthMeasurement()

void vtkMRMLMarkupsNode::RemoveNthMeasurement ( int id )

◆ ReplaceListNameInControlPointLabelFormat()

std::string vtkMRMLMarkupsNode::ReplaceListNameInControlPointLabelFormat ( )

If the ControlPointLabelFormat 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 ControlPointLabelFormat doesn't contain N, return ControlPointLabelFormat

◆ ReplaceListNameInMarkupLabelFormat()

std::string vtkMRMLMarkupsNode::ReplaceListNameInMarkupLabelFormat ( )

inline

Deprecated: Use ReplaceListNameInControlPointLabelFormat instead.

Definition at line 923 of file vtkMRMLMarkupsNode.h.

◆ ResetNthControlPointID()

bool vtkMRMLMarkupsNode::ResetNthControlPointID ( int n )

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

◆ ResetNthControlPointPosition()

void vtkMRMLMarkupsNode::ResetNthControlPointPosition ( int n )

Set control point status to preview.

◆ RestoreNthControlPointPosition()

void vtkMRMLMarkupsNode::RestoreNthControlPointPosition ( int n )

Set control point status to defined and return to the previous position.

◆ SafeDownCast()

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

static

◆ SetCenterOfRotation() [1/2]

void vtkMRMLMarkupsNode::SetCenterOfRotation ( const double position[3] )

◆ SetCenterOfRotation() [2/2]

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

Set the center position of the transformations, such as rotation and scaling.

See also: SetCenterOfRotationWorld

◆ SetCenterOfRotationFromArray()

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

inline

Set the center position position from an array

Deprecated: Use SetCenterOfRotation instead.

See also: SetCenterOfRotation

Definition at line 846 of file vtkMRMLMarkupsNode.h.

◆ SetCenterOfRotationFromPointer()

void vtkMRMLMarkupsNode::SetCenterOfRotationFromPointer ( const double * pos )

Set the center position from a pointer to an array

Deprecated: Use SetCenterOfRotation instead.

See also: SetCenterOfRotation

◆ SetCenterOfRotationWorld() [1/2]

void vtkMRMLMarkupsNode::SetCenterOfRotationWorld ( const double positionWorld[3] )

◆ SetCenterOfRotationWorld() [2/2]

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

Set the center position of the transformations, such as rotation and scaling.

See also: SetCenterOfRotation

◆ SetControlPointLabelFormat()

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

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

◆ SetControlPointPlacementStartIndex()

void vtkMRMLMarkupsNode::SetControlPointPlacementStartIndex ( int )

◆ SetControlPointPositionsWorld()

void vtkMRMLMarkupsNode::SetControlPointPositionsWorld	(	vtkPoints *	points,
		bool	setUndefinedPoints = true )

Set all control point positions from a point list. 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.

◆ SetFixedNumberOfControlPoints()

void vtkMRMLMarkupsNode::SetFixedNumberOfControlPoints ( bool fixed )

◆ SetLastUsedControlPointNumber()

virtual void vtkMRMLMarkupsNode::SetLastUsedControlPointNumber ( int )

virtual

◆ SetLocked()

void vtkMRMLMarkupsNode::SetLocked ( int locked )

◆ SetMarkupLabelFormat()

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

inline

Deprecated: Use SetControlPointLabelFormat instead.

Definition at line 916 of file vtkMRMLMarkupsNode.h.

◆ SetNthControlPointAssociatedNodeID()

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

◆ SetNthControlPointAutoCreated()

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

◆ SetNthControlPointDescription()

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

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

◆ 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: vtkMRMLMarkupsNode::SetLocked

◆ SetNthControlPointOrientation() [1/2]

void vtkMRMLMarkupsNode::SetNthControlPointOrientation	(	int	n,
		const double	wxyz[4] )

◆ SetNthControlPointOrientation() [2/2]

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

Set the orientation for the Nth control point from a WXYZ orientation. The value W is in degrees.

◆ SetNthControlPointOrientationFromArray()

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

inline

Definition at line 857 of file vtkMRMLMarkupsNode.h.

◆ SetNthControlPointOrientationFromPointer()

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

Set the orientation for the Nth control point from a WXYZ orientation. The value W is in degrees.

Deprecated: Use SetNthControlPointOrientation instead.

◆ SetNthControlPointOrientationMatrix() [1/2]

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

◆ SetNthControlPointOrientationMatrix() [2/2]

void vtkMRMLMarkupsNode::SetNthControlPointOrientationMatrix	(	int	n,
		vtkMatrix3x3 *	matrix )

◆ SetNthControlPointOrientationMatrixWorld() [1/2]

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

◆ SetNthControlPointOrientationMatrixWorld() [2/2]

void vtkMRMLMarkupsNode::SetNthControlPointOrientationMatrixWorld	(	int	n,
		vtkMatrix3x3 *	matrix )

◆ SetNthControlPointPosition() [1/2]

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

◆ SetNthControlPointPosition() [2/2]

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.

◆ SetNthControlPointPositionFromArray()

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

inline

Set of the Nth control point position from an array

Deprecated: Use SetNthControlPointPosition instead.

Definition at line 798 of file vtkMRMLMarkupsNode.h.

◆ SetNthControlPointPositionFromPointer()

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

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

Deprecated: Use SetNthControlPointPosition instead.

See also: SetNthControlPointPosition

◆ SetNthControlPointPositionMissing()

VTK_PROPEXCLUDE void vtkMRMLMarkupsNode::SetNthControlPointPositionMissing ( int pointIndex )

Set control point status to ignored.

◆ SetNthControlPointPositionOrientationWorld()

void vtkMRMLMarkupsNode::SetNthControlPointPositionOrientationWorld	(	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. Orientation: x (0, 3, 6), y (1, 4, 7), z (2, 5, 8)

See also: SetNthControlPointPosition

◆ SetNthControlPointPositionOrientationWorldFromArray()

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

inline

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

Deprecated: Use SetNthControlPointPositionOrientationWorld instead. Orientation: x (0, 3, 6), y (1, 4, 7), z (2, 5, 8)

See also: SetNthControlPointPosition

Definition at line 813 of file vtkMRMLMarkupsNode.h.

◆ SetNthControlPointPositionWorld() [1/2]

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

◆ SetNthControlPointPositionWorld() [2/2]

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

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

Deprecated: Use SetNthControlPointPositionWorld instead.

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

◆ SetNthMarkupLabel()

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

inline

Deprecated: Use SetNthControlPointLabel instead.

Definition at line 904 of file vtkMRMLMarkupsNode.h.

◆ SetNthMarkupLocked()

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

inline

Deprecated: Use SetNthControlPointLocked instead.

Definition at line 891 of file vtkMRMLMarkupsNode.h.

◆ SetNthMeasurement() [1/2]

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

◆ SetNthMeasurement() [2/2]

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

Set measurement data, such as length, angle, diameter, cross-section area.

IMPORTANT: These functions should not be used any more. Setting measurements now happens in the

See also: UpdateMeasurementsInternal functions by calling Compute on the measurements. Similarly, RemoveAllMeasurements should not be called to clear the values, because the measurements are not set externally but added internally in the constructors and only updated (Compute called) as needed.

◆ SwapControlPoints()

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

Swap two control points (position data and all other properties).

◆ TransformOrientationMatrixFromNodeToWorld()

virtual void vtkMRMLMarkupsNode::TransformOrientationMatrixFromNodeToWorld	(	const double	position_Node[3],
		const double	orientationMatrix_Node[9],
		double	orientationMatrix_World[9] )

protectedvirtual

Transform the orientation matrix from node to world coordinates.

◆ TransformOrientationMatrixFromWorldToNode()

virtual void vtkMRMLMarkupsNode::TransformOrientationMatrixFromWorldToNode	(	const double	position_World[3],
		const double	orientationMatrix_World[9],
		double	orientationMatrix_Node[9] )

protectedvirtual

Transform the orientation matrix from world to node coordinates.

◆ UnsetAllControlPoints()

virtual void vtkMRMLMarkupsNode::UnsetAllControlPoints ( )

virtual

◆ UnsetNthControlPointPosition()

void vtkMRMLMarkupsNode::UnsetNthControlPointPosition ( int pointIndex )

Set control point status to undefined.

◆ UpdateAllMeasurements()

void vtkMRMLMarkupsNode::UpdateAllMeasurements ( )

Update all measurements. It should not be necessary for users to call this method.

◆ UpdateAssignedAttribute()

virtual void vtkMRMLMarkupsNode::UpdateAssignedAttribute ( )

inlinevirtual

Update the AssignAttribute filter based on its ActiveScalarName and its ActiveAttributeLocation To be re-implemented in subclasses

Reimplemented in vtkMRMLMarkupsCurveNode.

Definition at line 715 of file vtkMRMLMarkupsNode.h.

◆ UpdateCurvePolyFromControlPoints()

virtual void vtkMRMLMarkupsNode::UpdateCurvePolyFromControlPoints ( )

protectedvirtual

◆ UpdateInteractionHandleToWorldMatrix()

virtual void vtkMRMLMarkupsNode::UpdateInteractionHandleToWorldMatrix ( )

protectedvirtual

Calculates the handle to world matrix based on the current control points.

Reimplemented in vtkMRMLMarkupsAngleNode, vtkMRMLMarkupsLineNode, vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

◆ UpdateMeasurementsInternal()

virtual void vtkMRMLMarkupsNode::UpdateMeasurementsInternal ( )

protectedvirtual

Calculate the updated measurements. May be overridden in subclasses to compute special measurements (for example that apply on the curve polydata).

Reimplemented in vtkMRMLMarkupsCurveNode.

◆ vtkMRMLCopyContentMacro()

vtkMRMLMarkupsNode::vtkMRMLCopyContentMacro ( vtkMRMLMarkupsNode )

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

See also: vtkMRMLNode::CopyContent

◆ WriteCLI()

void vtkMRMLMarkupsNode::WriteCLI	(	std::vector< std::string > &	commandLine,
		std::string	prefix,
		int	coordinateSystem = vtkMRMLStorageNode::CoordinateSystemRAS,
		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 = vtkMRMLStorageNode::CoordinateSystemRAS or vtkMRMLStorageNode::CoordinateSystemLPS multipleFlag = 1 for the whole list, 1 for the first selected control point

◆ WriteMeasurementsToDescription()

virtual void vtkMRMLMarkupsNode::WriteMeasurementsToDescription ( )

protectedvirtual

Helper function to write measurements to node Description property. This is a short-term solution until measurements display is properly implemented.

◆ WriteXML()

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

overridevirtual

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

Reimplemented from vtkMRMLDisplayableNode.

Reimplemented in vtkMRMLMarkupsPlaneNode.

Friends And Related Symbol Documentation

◆ qSlicerMarkupsModuleWidget

friend class qSlicerMarkupsModuleWidget

friend

Definition at line 1054 of file vtkMRMLMarkupsNode.h.

◆ vtkMRMLMarkupsFiducialStorageNode

friend class vtkMRMLMarkupsFiducialStorageNode

friend

Definition at line 85 of file vtkMRMLMarkupsNode.h.

◆ vtkMRMLMarkupsJsonStorageNode

friend class vtkMRMLMarkupsJsonStorageNode

friend

Definition at line 86 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 84 of file vtkMRMLMarkupsNode.h.

Member Data Documentation

◆ CenterOfRotation

vtkVector3d vtkMRMLMarkupsNode::CenterOfRotation

protected

Markup centerpoint (in local coordinates). It may be used as rotation center or as a handle to grab the widget by.

Definition at line 1035 of file vtkMRMLMarkupsNode.h.

◆ ControlPointLabelFormat

std::string vtkMRMLMarkupsNode::ControlPointLabelFormat {"%N-%d"}

protected

Definition at line 1023 of file vtkMRMLMarkupsNode.h.

◆ ControlPointPlacementStartIndex

int vtkMRMLMarkupsNode::ControlPointPlacementStartIndex { -1 }

protected

Index of the control point index that placement is started from (if no other point is requested specifically).

Definition at line 1031 of file vtkMRMLMarkupsNode.h.

◆ ControlPoints

ControlPointsListType vtkMRMLMarkupsNode::ControlPoints

protected

Vector of control points.

Definition at line 994 of file vtkMRMLMarkupsNode.h.

◆ CurveClosed

bool vtkMRMLMarkupsNode::CurveClosed {false}

protected

Definition at line 991 of file vtkMRMLMarkupsNode.h.

◆ CurveCoordinateSystemGeneratorWorld

vtkSmartPointer<vtkParallelTransportFrame> vtkMRMLMarkupsNode::CurveCoordinateSystemGeneratorWorld

protected

Computes tangent and smooth normal for each curve point. It provides a fully specified coordinate system at each point of the curve, which is useful for image reslicing or defining camera pose. Curve is defined in the world coordinate system.

Definition at line 1003 of file vtkMRMLMarkupsNode.h.

◆ CurveGenerator

vtkSmartPointer<vtkCurveGenerator> vtkMRMLMarkupsNode::CurveGenerator

protected

Converts curve control points to curve points.

Definition at line 997 of file vtkMRMLMarkupsNode.h.

◆ CurveInputPoly

vtkSmartPointer<vtkPolyData> vtkMRMLMarkupsNode::CurveInputPoly

protected

Stores control point positions in a polydata (in local coordinate system). Line cells connect all points into a curve.

Definition at line 1007 of file vtkMRMLMarkupsNode.h.

◆ CurvePolyToWorldTransform

vtkSmartPointer<vtkGeneralTransform> vtkMRMLMarkupsNode::CurvePolyToWorldTransform

protected

Definition at line 1010 of file vtkMRMLMarkupsNode.h.

◆ CurvePolyToWorldTransformer

vtkSmartPointer<vtkTransformPolyDataFilter> vtkMRMLMarkupsNode::CurvePolyToWorldTransformer

protected

Definition at line 1009 of file vtkMRMLMarkupsNode.h.

◆ DefaultNodeNamePrefix

std::string vtkMRMLMarkupsNode::DefaultNodeNamePrefix

protected

Store markup short name. Translated to the application language.

Definition at line 1046 of file vtkMRMLMarkupsNode.h.

◆ FixedNumberOfControlPoints

bool vtkMRMLMarkupsNode::FixedNumberOfControlPoints {false}

protected

Locks number of control points. If enabled then points cannot be added or removed. Point position can be unset instead of deleting the point.

Definition at line 1021 of file vtkMRMLMarkupsNode.h.

◆ InteractionHandleToWorldMatrix

vtkSmartPointer<vtkMatrix4x4> vtkMRMLMarkupsNode::InteractionHandleToWorldMatrix

protected

Transform that moves the xyz unit vectors and origin of the interaction handles to local coordinates.

Definition at line 1049 of file vtkMRMLMarkupsNode.h.

◆ IsUpdatingPoints

bool vtkMRMLMarkupsNode::IsUpdatingPoints {false}

protected

Flag set from SetControlPointPositionsWorld that pauses update of measurements until the update is complete.

Definition at line 1052 of file vtkMRMLMarkupsNode.h.

◆ LastUsedControlPointNumber

int vtkMRMLMarkupsNode::LastUsedControlPointNumber {0}

protected

Keep track of the number of markups that were added to the list, always incrementing, not decreasing when they're removed. Used to help create unique names and ids. Reset to 0 when

See also: RemoveAllControlPoints called

Definition at line 1028 of file vtkMRMLMarkupsNode.h.

◆ Locked

int vtkMRMLMarkupsNode::Locked {0}

protected

Locks all the points and GUI.

Definition at line 1017 of file vtkMRMLMarkupsNode.h.

◆ MaximumNumberOfControlPoints

int vtkMRMLMarkupsNode::MaximumNumberOfControlPoints {-1}

protected

Used for limiting number of control points that may be placed. This is a hard limit at which new control points cannot be added.

Definition at line 989 of file vtkMRMLMarkupsNode.h.

◆ Measurements

vtkCollection* vtkMRMLMarkupsNode::Measurements

protected

List of measurements stored for the markup.

Definition at line 1038 of file vtkMRMLMarkupsNode.h.

◆ PropertiesLabelText

std::string vtkMRMLMarkupsNode::PropertiesLabelText

protected

Definition at line 1040 of file vtkMRMLMarkupsNode.h.

◆ RequiredNumberOfControlPoints

int vtkMRMLMarkupsNode::RequiredNumberOfControlPoints {0}

protected

Used for limiting number of control points that may be placed. This is a soft limit at which automatic placement stops.

Definition at line 986 of file vtkMRMLMarkupsNode.h.

◆ TextList

vtkSmartPointer<vtkStringArray> vtkMRMLMarkupsNode::TextList

protected

Definition at line 935 of file vtkMRMLMarkupsNode.h.

◆ TransformedCurvePolyLocator

vtkSmartPointer<vtkPointLocator> vtkMRMLMarkupsNode::TransformedCurvePolyLocator

protected

Point locator that allows quick finding of interpolated point in the world coordinate system (in transformed CurvePoly).

Definition at line 1014 of file vtkMRMLMarkupsNode.h.

◆ TypeDisplayName

std::string vtkMRMLMarkupsNode::TypeDisplayName

protected

Store markup type GUI display name. Translated to the application language.

Definition at line 1043 of file vtkMRMLMarkupsNode.h.

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

Libs/MRML/Core/vtkMRMLMarkupsNode.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ControlPointsListType

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkMRMLMarkupsNode() [1/2]

◆ ~vtkMRMLMarkupsNode()

◆ vtkMRMLMarkupsNode() [2/2]

Member Function Documentation

◆ AddControlPoint() [1/4]

◆ AddControlPoint() [2/4]

◆ AddControlPoint() [3/4]

◆ AddControlPoint() [4/4]

◆ AddControlPointWorld() [1/3]

◆ AddControlPointWorld() [2/3]

◆ AddControlPointWorld() [3/3]

◆ AddMeasurement()

◆ AddNControlPoints() [1/2]

◆ AddNControlPoints() [2/2]

◆ ApplyTransform() [1/2]

◆ ApplyTransform() [2/2]

◆ CanApplyNonLinearTransforms()

◆ ClearValueForAllMeasurements()

◆ ControlPointExists()

◆ ConvertOrientationMatrixToWXYZ()

◆ ConvertOrientationWXYZToMatrix()

◆ CreateDefaultDisplayNodes()

◆ CreateDefaultStorageNode()

◆ EndModify()

◆ GenerateControlPointLabel()

◆ GenerateUniqueControlPointID()

◆ GetAddIcon()

◆ GetBounds()

◆ GetCenterOfRotation() [1/2]

◆ GetCenterOfRotation() [2/2]

◆ GetCenterOfRotationVector()

◆ GetCenterOfRotationWorld()

◆ GetClassName()

◆ GetClosestControlPointIndexToPositionWorld()

◆ GetControlPointIndexByDescription()

◆ GetControlPointIndexByID()

◆ GetControlPointIndexByLabel()

◆ GetControlPointIndexFromInterpolatedPointIndex()

◆ GetControlPointLabelFormat()

◆ GetControlPointLabels()

◆ GetControlPointPlacementComplete()

◆ GetControlPointPlacementStartIndex()

◆ GetControlPointPositionsWorld()

◆ GetControlPoints()

◆ GetCurve()

◆ GetCurveClosed()

◆ GetCurveCoordinateSystemGeneratorWorld()

◆ GetCurveGenerator()

◆ GetCurvePoints()

◆ GetCurvePointsWorld()

◆ GetCurveWorld()

◆ GetCurveWorldConnection()

◆ GetDefaultNodeNamePrefix()

◆ GetFixedNumberOfControlPoints()

◆ GetIcon()

◆ GetInteractionHandleToWorldMatrix()

◆ GetLastUsedControlPointNumber()

◆ GetLocked()

◆ GetMarkupLabelFormat()

◆ GetMarkupPoint()

◆ GetMarkupPointVector()

◆ GetMarkupsDisplayNode()

◆ GetMarkupType()

◆ GetMaximumNumberOfControlPoints()