MRML node to represent a curve markup Curve Markups nodes contain N control points. Visualization parameters are set in the vtkMRMLMarkupsDisplayNode class. More...

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

Inheritance diagram for vtkMRMLMarkupsCurveNode:

[legend]

Collaboration diagram for vtkMRMLMarkupsCurveNode:

[legend]

Public Types
typedef vtkMRMLMarkupsNode	Superclass

Public Types inherited from vtkMRMLMarkupsNode
enum	{ LockModifiedEvent = 19000, LabelFormatModifiedEvent, PointAddedEvent, PointRemovedEvent, PointPositionDefinedEvent, PointPositionUndefinedEvent, PointModifiedEvent, PointStartInteractionEvent, PointEndInteractionEvent, CenterPointModifiedEvent }

enum	{ PositionUndefined, PositionPreview, PositionDefined, PositionStatus_Last }

typedef std::vector< ControlPoint * >	ControlPointsListType

typedef vtkMRMLDisplayableNode	Superclass

Public Types inherited from vtkMRMLDisplayableNode
enum	{ DisplayModifiedEvent = 17000 }

typedef vtkMRMLTransformableNode	Superclass

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

typedef vtkMRMLStorableNode	Superclass

Public Types inherited from vtkMRMLStorableNode
typedef vtkMRMLNode	Superclass

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

typedef vtkObject	Superclass

Public Member Functions
vtkMRMLNode *	CreateNodeInstance () override
	MRMLNode methods. More...

virtual const char *	GetClassName ()

vtkIdType	GetClosestCurvePointIndexToPositionWorld (const double posWorld[3])
	Get the index of the closest curve point to the world coordinates. More...

vtkIdType	GetClosestPointPositionAlongCurveWorld (const double posWorld[3], double closestPosWorld[3])

bool	GetCurveDirectionAtPointIndexWorld (vtkIdType curvePointIndex, double directionVectorWorld[3])

double	GetCurveLengthBetweenStartEndPointsWorld (vtkIdType startCurvePointIndex, vtkIdType endCurvePointIndex)

double	GetCurveLengthWorld (vtkIdType startCurvePointIndex=0, vtkIdType numberOfCurvePoints=-1)

vtkIdType	GetCurvePointIndexAlongCurveWorld (vtkIdType startCurvePointId, double distanceFromStartPoint)

vtkIdType	GetCurvePointIndexFromControlPointIndex (int controlPointIndex)

vtkPoints *	GetCurvePointsWorld ()
	Get curve points positions in world coordinate system. More...

bool	GetCurvePointToWorldTransformAtPointIndex (vtkIdType curvePointIndex, vtkMatrix4x4 *curvePointToWorld)

int	GetCurveType ()
	Type of curve to generate. More...

const char *	GetCurveTypeAsString (int id)

int	GetCurveTypeFromString (const char *name)

vtkIdType	GetFarthestCurvePointIndexToPositionWorld (const double posWorld[3])

const char *	GetIcon () override

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

bool	GetPointsOnPlaneWorld (vtkPlane plane, vtkPoints intersectionPoints)

bool	GetPositionAlongCurveWorld (double foundCurvePosition[3], vtkIdType startCurvePointId, double distanceFromStartPoint)

bool	GetSampledCurvePointsBetweenStartEndPointsWorld (vtkPoints *sampledPoints, double samplingDistance, vtkIdType startCurvePointIndex, vtkIdType endCurvePointIndex)

vtkMRMLModelNode *	GetShortestDistanceSurfaceNode ()

const char *	GetShortestDistanceSurfaceNodeReferenceMRMLAttributeName ()

const char *	GetShortestDistanceSurfaceNodeReferenceRole ()
	Node reference role for the surface that is used in the shortest surface distance curve type. More...

int	GetSurfaceCostFunctionType ()

const char *	GetSurfaceDistanceWeightingFunction ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override
	Print out the node information to the output stream. More...

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

bool	ResampleCurveSurface (double controlPointDistance, vtkMRMLModelNode *node, double maximumSearchRadius=.25)

void	ResampleCurveWorld (double controlPointDistance)

void	SetAndObserveShortestDistanceSurfaceNode (vtkMRMLModelNode *modelNode)

bool	SetControlPointLabels (vtkStringArray labels, vtkPoints points)
	Provides access to protected vtkMRMLMarkupsNode::SetControlPointLabelsWorld. More...

void	SetCurveType (int type)

void	SetCurveTypeToCardinalSpline ()

void	SetCurveTypeToKochanekSpline ()

void	SetCurveTypeToLinear ()

void	SetCurveTypeToPolynomial ()

void	SetCurveTypeToShortestDistanceOnSurface (vtkMRMLModelNode *modelNode=nullptr)

void	SetSurfaceCostFunctionType (int surfaceCostFunctionType)

void	SetSurfaceDistanceWeightingFunction (const char *function)

virtual void	UpdateAssignedAttribute () override
	Update scalar range and update markups pipeline when the active scalar array is changed. More...

	vtkMRMLCopyContentMacro (vtkMRMLMarkupsCurveNode)

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


int	GetNumberOfPointsPerInterpolatingSegment ()

void	SetNumberOfPointsPerInterpolatingSegment (int pointsPerSegment)

Public Member Functions inherited from vtkMRMLMarkupsNode
int	AddControlPoint (vtkVector3d point, std::string label=std::string())
	Add a new control point, returning the point index, -1 on failure. More...

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

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

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

void	ApplyTransform (vtkAbstractTransform *transform) override

bool	CanApplyNonLinearTransforms () const override

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

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

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

vtkMRMLNode *	CreateNodeInstance () override
	MRMLNode methods. More...

void	GetBounds (double bounds[6]) override

void	GetCenterPosition (double point[3])

vtkVector3d	GetCenterPositionVector ()

int	GetCenterPositionWorld (double worldxyz[3])

int	GetClosestControlPointIndexToPositionWorld (double pos[3])
	Get the index of the closest control point to the world coordinates. More...

int	GetControlPointIndexFromInterpolatedPointIndex (vtkIdType interpolatedPointIndex)

void	GetControlPointLabels (vtkStringArray *labels)

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

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

vtkPolyData *	GetCurve ()

virtual bool	GetCurveClosed ()

vtkCurveGenerator *	GetCurveGenerator ()

vtkPoints *	GetCurvePoints ()

vtkPoints *	GetCurvePointsWorld ()

vtkPolyData *	GetCurveWorld ()

vtkAlgorithmOutput *	GetCurveWorldConnection ()

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

virtual int	GetLocked ()
	Get the Locked property on the markupNode/list of control points. More...

std::string	GetMarkupLabelFormat ()

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

vtkVector3d	GetMarkupPointVector (int markupIndex, int)

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

virtual int	GetMaximumNumberOfControlPoints ()

bool	GetModifiedSinceRead () override

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

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

std::string	GetNthControlPointAssociatedNodeID (int n=0)
	Get/Set the associated node id for the Nth control point. More...

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

std::string	GetNthControlPointDescription (int n=0)

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

int	GetNthControlPointIndexByID (const char *controlPointID)
	Get the Nth control point index based on it's ID. More...

int	GetNthControlPointIndexByPositionStatus (int pointIndex, int positionStatus)

std::string	GetNthControlPointLabel (int n=0)

bool	GetNthControlPointLocked (int n=0)

double *	GetNthControlPointNormal (int n)
	Get normal direction (orientation of z axis) in local coordinate system. More...

void	GetNthControlPointNormalWorld (int n, double normalWorld[3])
	Get normal direction (orientation of z axis) in world coordinate system. More...

void	GetNthControlPointOrientation (int n, double orientationWXYZ[4])
	Get the WXYZ orientation for the Nth control point. More...

double *	GetNthControlPointOrientationMatrix (int n)
	Get orientation as 9 values: x, y, and z axis directions, respectively. More...

vtkVector4d	GetNthControlPointOrientationVector (int pointIndex)

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

double *	GetNthControlPointPosition (int pointIndex)

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

vtkVector3d	GetNthControlPointPositionVector (int pointIndex)

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

bool	GetNthControlPointSelected (int n=0)

bool	GetNthControlPointVisibility (int n=0)

std::string	GetNthMarkupAssociatedNodeID (int n=0)

std::string	GetNthMarkupID (int n=0)

std::string	GetNthMarkupLabel (int n=0)

bool	GetNthMarkupLocked (int n=0)

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

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

int	GetNumberOfMarkups ()

int	GetNumberOfPointsInNthMarkup (int)

virtual std::string	GetPropertiesLabelText ()

void	GetRASBounds (double bounds[6]) override

virtual int	GetRequiredNumberOfControlPoints ()

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

bool	InsertControlPoint (ControlPoint *controlPoint, int targetIndex)

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

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

virtual void	LockedOff ()

virtual void	LockedOn ()

bool	MarkupExists (int n)
	Deprecated. Use ControlPointExists instead. More...

void	PrintSelf (ostream &os, vtkIndent indent) override

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

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

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

void	RemoveAllMarkups ()

void	RemoveMarkup (int pointIndex)

void	RemoveNthControlPoint (int pointIndex)
	Remove Nth Control Point. More...

std::string	ReplaceListNameInMarkupLabelFormat ()

bool	ResetNthControlPointID (int n)

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

void	SetCenterPositionFromArray (const double pos[3])

void	SetCenterPositionFromPointer (const double *pos)

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

void	SetControlPointPositionsWorld (vtkPoints *points)

void	SetLocked (int locked)

void	SetMarkupLabelFormat (std::string format)

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

void	SetNthControlPointDescription (int n, std::string description)
	Set the Description on the Nth control point. More...

void	SetNthControlPointLabel (int n, std::string label)
	Set the Label on the Nth control point. More...

void	SetNthControlPointLocked (int n, bool flag)

void	SetNthControlPointOrientation (int n, double w, double x, double y, double z)
	Set the orientation for the Nth control point from passed parameters. More...

void	SetNthControlPointOrientationFromArray (int n, const double orientationWXYZ[4])
	Set the orientation for the Nth control point from a double array WXYZ. More...

void	SetNthControlPointOrientationFromPointer (int n, const double *orientationWXYZ)
	Set the orientation for the Nth control point from a pointer to a double array WXYZ. More...

void	SetNthControlPointOrientationMatrix (int n, double orientationMatrix[9])
	Set orientation as 9 values: x, y, and z axis directions, respectively. More...

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

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

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

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

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

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

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

void	SetNthControlPointSelected (int n, bool flag)

void	SetNthControlPointVisibility (int n, bool flag)

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

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

void	SetNthMarkupLocked (int n, bool flag)

void	SwapControlPoints (int m1, int m2)
	Swap the position of two control points. More...

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

void	UpdateAllMeasurements ()

	vtkMRMLCopyContentMacro (vtkMRMLMarkupsNode)

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

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

int	GetNumberOfMeasurements ()

int	GetNumberOfEnabledMeasurements ()

vtkMRMLMeasurement *	GetNthMeasurement (int id)

vtkMRMLMeasurement *	GetMeasurement (const char *name)

void	AddMeasurement (vtkMRMLMeasurement *measurement)

void	RemoveNthMeasurement (int id)

void	ClearValueForAllMeasurements ()

void	SetNthMeasurement (int id, vtkMRMLMeasurement *measurement)

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	RemoveAllMeasurements ()

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

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

virtual void	CreateDefaultSequenceDisplayNodes ()

virtual int	GetDisplayClassVisibility (const char *nodeClass)

vtkMRMLDisplayNode *	GetDisplayNode ()

const char *	GetDisplayNodeID ()

virtual const char *	GetDisplayNodeReferenceRole ()

virtual int	GetDisplayVisibility ()

vtkMRMLDisplayNode *	GetNthDisplayNode (int n)

const char *	GetNthDisplayNodeID (int n)

int	GetNumberOfDisplayNodes ()

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

void	PrintSelf (ostream &os, vtkIndent indent) override

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

void	RemoveNthDisplayNodeID (int n)

void	SetAndObserveDisplayNodeID (const char *displayNodeID)

void	SetAndObserveNthDisplayNodeID (int n, const char *displayNodeID)

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

virtual void	SetDisplayVisibility (int visible)

void	SetSelectable (int) override

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

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

vtkMRMLTransformNode *	GetParentTransformNode ()
	Associated transform MRML node More...

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

bool	HardenTransform ()

void	PrintSelf (ostream &os, vtkIndent indent) override

bool	SetAndObserveTransformNodeID (const char *transformNodeID)

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

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

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

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

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

virtual bool	AddDefaultStorageNode (const char *filename=nullptr)

virtual vtkMRMLStorageNode *	CreateDefaultSequenceStorageNode ()

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

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

const char *	GetNthStorageNodeID (int n)

int	GetNumberOfStorageNodes ()

const char *	GetSlicerDataType ()

vtkMRMLStorageNode *	GetStorageNode ()

const char *	GetStorageNodeID ()

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

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

void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)

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

void	SetSlicerDataType (const char *type)

virtual void	StorableModified ()

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

	vtkMRMLCopyContentMacro (vtkMRMLStorableNode)

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

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

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

virtual void	AddToSceneOff ()

virtual void	AddToSceneOn ()

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

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

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

void	DisableModifiedEventOff ()

void	DisableModifiedEventOn ()

virtual int	EndModify (int previousDisableModifiedEventState)
	End modifying the node. More...

virtual int	GetAddToScene ()
	node added to MRML scene. More...

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

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

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

virtual vtkIntArray *	GetContentModifiedEvents ()

virtual char *	GetDescription ()

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

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

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

virtual int	GetInMRMLCallbackFlag ()
	Flags to avoid event loops. More...

virtual int	GetModifiedEventPending ()

virtual char *	GetName ()

vtkMRMLNode *	GetNodeReference (const char *referenceRole)

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

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

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

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

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

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

const char *	GetNthNodeReferenceRole (int n)

int	GetNumberOfNodeReferenceRoles ()

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

virtual int	GetSaveWithScene ()
	Save node with MRML scene. More...

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

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

virtual int	GetSelected ()
	Get/Set for Selected. More...

virtual char *	GetSingletonTag ()

virtual bool	GetUndoEnabled ()

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

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

virtual void	HideFromEditorsOff ()

virtual void	HideFromEditorsOn ()

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

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

bool	IsSingleton ()

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

virtual void	OnNodeAddedToScene ()

void	PrintSelf (ostream &os, vtkIndent indent) override

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

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

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

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

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

virtual void	SaveWithSceneOff ()

virtual void	SaveWithSceneOn ()

virtual void	SelectableOff ()

virtual void	SelectableOn ()

virtual void	SelectedOff ()

virtual void	SelectedOn ()

virtual void	SetAddToScene (int)

void	SetAddToSceneNoModify (int value)

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

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

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

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

void	SetDisableModifiedEvent (int onOff)

virtual void	SetHideFromEditors (int)

void	SetInMRMLCallbackFlag (int flag)

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

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

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

virtual void	SetSaveWithScene (int)

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

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

virtual void	SetSelected (int)

void	SetSingletonOff ()

void	SetSingletonOn ()

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

virtual void	SetUndoEnabled (bool)

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

virtual void	UndoEnabledOff ()

virtual void	UndoEnabledOn ()

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

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

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

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

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

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

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

Static Public Member Functions
static bool	ConstrainPointsToSurface (vtkPoints originalPoints, vtkPoints normalVectors, vtkPolyData surfacePolydata, vtkPoints surfacePoints, double maximumSearchRadius=.25)

static double	GetCurveLength (vtkPoints *curvePoints, bool closedCurve, vtkIdType startCurvePointIndex=0, vtkIdType numberOfCurvePoints=-1)

static bool	GetPositionAndClosestPointIndexAlongCurve (double foundCurvePosition[3], vtkIdType &foundClosestPointIndex, vtkIdType startCurvePointId, double distanceFromStartPoint, vtkPoints *curvePoints, bool closedCurve)
	Get point position along curve. Position is found along the curve and not snapped to closest curve point. More...

static const char *	GetSurfaceCostFunctionTypeAsString (int surfaceCostFunctionType)

static int	GetSurfaceCostFunctionTypeFromString (const char *name)

static int	IsTypeOf (const char *type)

static vtkMRMLMarkupsCurveNode *	New ()

static bool	ResamplePoints (vtkPoints originalPoints, vtkPoints interpolatedPoints, double samplingDistance, bool closedCurve)

static vtkMRMLMarkupsCurveNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLMarkupsNode
static void	ConvertOrientationMatrixToWXYZ (const double orientationMatrix[9], double orientationWXYZ[4])

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

static const char *	GetPositionStatusAsString (int id)

static int	GetPositionStatusFromString (const char *name)

static int	IsTypeOf (const char *type)

static vtkMRMLMarkupsNode *	New ()

static vtkMRMLMarkupsNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLDisplayableNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLTransformableNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLStorableNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLNode *	SafeDownCast (vtkObject *o)

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

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

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

virtual void	OnSurfaceModelNodeChanged ()

virtual void	OnSurfaceModelTransformChanged ()

void	operator= (const vtkMRMLMarkupsCurveNode &)

void	ProcessMRMLEvents (vtkObject caller, unsigned long event, void callData) override
	alternative method to propagate events generated in Display nodes More...

void	UpdateMeasurementsInternal () override

virtual void	UpdateSurfaceScalarVariables ()

	vtkMRMLMarkupsCurveNode ()

	vtkMRMLMarkupsCurveNode (const vtkMRMLMarkupsCurveNode &)

	~vtkMRMLMarkupsCurveNode () override

Protected Member Functions inherited from vtkMRMLMarkupsNode
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. More...

void	operator= (const vtkMRMLMarkupsNode &)

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

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

virtual void	UpdateCurvePolyFromControlPoints ()

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

	vtkMRMLMarkupsNode ()

	vtkMRMLMarkupsNode (const vtkMRMLMarkupsNode &)

virtual void	WriteMeasurementsToDescription ()

	~vtkMRMLMarkupsNode () override

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

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	operator= (const vtkMRMLTransformableNode &)

	vtkMRMLTransformableNode ()

	vtkMRMLTransformableNode (const vtkMRMLTransformableNode &)

	~vtkMRMLTransformableNode () override

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

virtual const char *	GetStorageNodeReferenceRole ()

virtual vtkTimeStamp	GetStoredTime ()

void	operator= (const vtkMRMLStorableNode &)

	vtkMRMLStorableNode ()

	vtkMRMLStorableNode (const vtkMRMLStorableNode &)

	~vtkMRMLStorableNode () override

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

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

virtual char *	GetTempURLString ()

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

virtual void	InvalidateNodeReferences ()

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

void	operator= (const vtkMRMLNode &)

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

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

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

virtual void	UpdateNodeReferences (const char *referenceRole=nullptr)

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

	vtkMRMLNode ()

	vtkMRMLNode (const vtkMRMLNode &)

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

Static Protected Member Functions
static void	OnCurvatureMeasurementModified (vtkObject caller, unsigned long eid, void clientData, void *callData)
	Callback function observing curvature measurement modified events to propagate enabled state. More...

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

Protected Attributes
vtkSmartPointer< vtkCleanPolyData >	CleanFilter

vtkCallbackCommand *	CurvatureMeasurementModifiedCallbackCommand
	Command handling curvature measurement modified events to propagate enabled state. More...

vtkSmartPointer< vtkCurveMeasurementsCalculator >	CurveMeasurementsCalculator

vtkSmartPointer< vtkAssignAttribute >	ScalarDisplayAssignAttribute

const char *	ShortestDistanceSurfaceActiveScalar

vtkSmartPointer< vtkArrayCalculator >	SurfaceScalarCalculator

vtkSmartPointer< vtkPassThroughFilter >	SurfaceScalarPassThroughFilter

vtkSmartPointer< vtkTransformPolyDataFilter >	SurfaceToLocalTransformer

vtkSmartPointer< vtkTriangleFilter >	TriangleFilter

Protected Attributes inherited from vtkMRMLMarkupsNode
vtkVector3d	CenterPos

ControlPointsListType	ControlPoints
	Vector of control points. More...

bool	CurveClosed {false}

vtkSmartPointer< vtkFrenetSerretFrame >	CurveCoordinateSystemGeneratorWorld

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

vtkSmartPointer< vtkPolyData >	CurveInputPoly

vtkSmartPointer< vtkGeneralTransform >	CurvePolyToWorldTransform

vtkSmartPointer< vtkTransformPolyDataFilter >	CurvePolyToWorldTransformer

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

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

int	LastUsedControlPointNumber {0}

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

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

int	MaximumNumberOfControlPoints {0}

vtkCollection *	Measurements
	List of measurements stored for the markup. More...

std::string	PropertiesLabelText

int	RequiredNumberOfControlPoints {0}

vtkSmartPointer< vtkStringArray >	TextList

vtkSmartPointer< vtkPointLocator >	TransformedCurvePolyLocator

Protected Attributes inherited from vtkMRMLStorableNode
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 More...

vtkCallbackCommand *	MRMLCallbackCommand
	Holders for MRML callbacks. More...

vtkObserverManager *	MRMLObserverManager

char *	Name {nullptr}

NodeReferenceEventsType	NodeReferenceEvents

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

NodeReferencesType	NodeReferences

int	SaveWithScene {true}

vtkWeakPointer< vtkMRMLScene >	Scene

int	Selectable {1}

int	Selected {0}

bool	UndoEnabled {false}

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

typedef std::map< std::string, vtkSmartPointer< vtkIntArray > >	NodeReferenceEventsType

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

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

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

MRML node to represent a curve markup Curve Markups nodes contain N control points. Visualization parameters are set in the vtkMRMLMarkupsDisplayNode class.

Markups is intended to be used for manual marking/editing of point positions.

Coordinate systems used:

Local: Current node's coordinate system where the position of the control and curve points are defined. Local coordinates can be converted to world by concatenating all parent transforms on the current node.
Surface: Model node's coordinate system where the polydata used for ShortestDistanceOnSurface pathfinding is defined. Surface coordinates can be converted to world by concatenating all parent transforms on the surface node.
World: Patient coordinate system (RAS)

Markups measurement pipeline:

Definition at line 88 of file vtkMRMLMarkupsCurveNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLMarkupsNode vtkMRMLMarkupsCurveNode::Superclass

Definition at line 92 of file vtkMRMLMarkupsCurveNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLMarkupsCurveNode() [1/2]

vtkMRMLMarkupsCurveNode::vtkMRMLMarkupsCurveNode ( )

protected

◆ ~vtkMRMLMarkupsCurveNode()

vtkMRMLMarkupsCurveNode::~vtkMRMLMarkupsCurveNode ( )

overrideprotected

◆ vtkMRMLMarkupsCurveNode() [2/2]

vtkMRMLMarkupsCurveNode::vtkMRMLMarkupsCurveNode ( const vtkMRMLMarkupsCurveNode & )

protected

Member Function Documentation

◆ ConstrainPointsToSurface()

static bool vtkMRMLMarkupsCurveNode::ConstrainPointsToSurface	(	vtkPoints *	originalPoints,
		vtkPoints *	normalVectors,
		vtkPolyData *	surfacePolydata,
		vtkPoints *	surfacePoints,
		double	maximumSearchRadius = `.25`
	)

static

Constrain points to a specified model surface Projection to surface is constrained by maximumSearchRadius, specified as a percentage of the model's bounding box diagonal in world coordinate system. maximumSearchRadius is valid in the range between 0 and 1. returns true if successful, false in case of error

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLMarkupsCurveNode::CreateNodeInstance ( )

overridevirtual

MRMLNode methods.

Implements vtkMRMLDisplayableNode.

◆ GetClassName()

virtual const char* vtkMRMLMarkupsCurveNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLMarkupsNode.

Reimplemented in vtkMRMLMarkupsClosedCurveNode.

◆ GetClosestCurvePointIndexToPositionWorld()

vtkIdType vtkMRMLMarkupsCurveNode::GetClosestCurvePointIndexToPositionWorld ( const double posWorld[3] )

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

◆ GetClosestPointPositionAlongCurveWorld()

vtkIdType vtkMRMLMarkupsCurveNode::GetClosestPointPositionAlongCurveWorld	(	const double	posWorld[3],
		double	closestPosWorld[3]
	)

Get position of the closest point along the curve in world coordinates. The found position may be between two curve points. Returns index of the found line segment. -1 if failed.

Parameters

posWorld	input position
closestPosWorld	output found closest position

◆ GetCurveDirectionAtPointIndexWorld()

bool vtkMRMLMarkupsCurveNode::GetCurveDirectionAtPointIndexWorld	(	vtkIdType	curvePointIndex,
		double	directionVectorWorld[3]
	)

Get direction vector at specified curve point index, in World coordinate system.

Returns: true on success.

◆ GetCurveLength()

static double vtkMRMLMarkupsCurveNode::GetCurveLength	(	vtkPoints *	curvePoints,
		bool	closedCurve,
		vtkIdType	startCurvePointIndex = `0`,
		vtkIdType	numberOfCurvePoints = `-1`
	)

static

Utility function to get curve length from a point list.

See also: GetCurveLengthWorld

◆ GetCurveLengthBetweenStartEndPointsWorld()

double vtkMRMLMarkupsCurveNode::GetCurveLengthBetweenStartEndPointsWorld	(	vtkIdType	startCurvePointIndex,
		vtkIdType	endCurvePointIndex
	)

Get length of a section of the curve between startPointIndex and endPointIndex. If endPointIndex < startPointIndex then length outside of the section is computed.

Parameters

startCurvePointIndex	length computation starts from this curve point index
endCurvePointIndex	length computation starts from this curve point index

Returns: sum of distances between the curve points, returns 0 in case of an error

◆ GetCurveLengthWorld()

double vtkMRMLMarkupsCurveNode::GetCurveLengthWorld	(	vtkIdType	startCurvePointIndex = `0`,
		vtkIdType	numberOfCurvePoints = `-1`
	)

Get length of the curve or a section of the curve.

Parameters

startCurvePointIndex	length computation starts from this curve point index
numberOfCurvePoints	if specified then distances up to the first n points are computed. If <0 then all the points are used.

Returns: sum of distances between the curve points, returns 0 in case of an error

◆ GetCurvePointIndexAlongCurveWorld()

vtkIdType vtkMRMLMarkupsCurveNode::GetCurvePointIndexAlongCurveWorld	(	vtkIdType	startCurvePointId,
		double	distanceFromStartPoint
	)

Get position of a curve point along the curve relative to the specified start point index.

Parameters

startCurvePointId	index of the curve point to start the distance measurement from
distanceFromStartPoint	distance from the start point

Returns: found point index, -1 in case of an error

◆ GetCurvePointIndexFromControlPointIndex()

vtkIdType vtkMRMLMarkupsCurveNode::GetCurvePointIndexFromControlPointIndex ( int controlPointIndex )

Get curve point index corresponding to a control point. It is useful for calling methods that require curve point index as input.

◆ GetCurvePointsWorld()

vtkPoints* vtkMRMLMarkupsCurveNode::GetCurvePointsWorld ( )

Get curve points positions in world coordinate system.

◆ GetCurvePointToWorldTransformAtPointIndex()

bool vtkMRMLMarkupsCurveNode::GetCurvePointToWorldTransformAtPointIndex	(	vtkIdType	curvePointIndex,
		vtkMatrix4x4 *	curvePointToWorld
	)

Get transformation from CurvePoint to World coordinate system at the specified curve point index. CurvePoint coordinate system:

Origin: position of the curve point.
X axis: curve normal direction.
Y axis: binormal direction (tangent x normal).
Z axis: curve tangent direction.
Returns
true on success.

◆ GetCurveType()

int vtkMRMLMarkupsCurveNode::GetCurveType ( )

Type of curve to generate.

◆ GetCurveTypeAsString()

const char* vtkMRMLMarkupsCurveNode::GetCurveTypeAsString ( int id )

◆ GetCurveTypeFromString()

int vtkMRMLMarkupsCurveNode::GetCurveTypeFromString ( const char * name )

◆ GetFarthestCurvePointIndexToPositionWorld()

vtkIdType vtkMRMLMarkupsCurveNode::GetFarthestCurvePointIndexToPositionWorld ( const double posWorld[3] )

Get index of the farthest curve point from the specified reference point. Distance is Euclidean distance, not distance along the curve.

Parameters

posWorld Reference point position in world coordinate system

Returns: index of the farthest curve point from refPoint, -1 in case of error

◆ GetIcon()

const char* vtkMRMLMarkupsCurveNode::GetIcon ( )

inlineoverridevirtual

Reimplemented from vtkMRMLMarkupsNode.

Definition at line 96 of file vtkMRMLMarkupsCurveNode.h.

◆ GetNodeTagName()

const char* vtkMRMLMarkupsCurveNode::GetNodeTagName ( )

inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLDisplayableNode.

Definition at line 104 of file vtkMRMLMarkupsCurveNode.h.

◆ GetNumberOfPointsPerInterpolatingSegment()

int vtkMRMLMarkupsCurveNode::GetNumberOfPointsPerInterpolatingSegment ( )

Get/set how many curve points are inserted between control points. Higher values are recommended if distance between control points is large.

◆ GetPointsOnPlaneWorld()

bool vtkMRMLMarkupsCurveNode::GetPointsOnPlaneWorld	(	vtkPlane *	plane,
		vtkPoints *	intersectionPoints
	)

◆ GetPositionAlongCurveWorld()

bool vtkMRMLMarkupsCurveNode::GetPositionAlongCurveWorld	(	double	foundCurvePosition[3],
		vtkIdType	startCurvePointId,
		double	distanceFromStartPoint
	)

Get position of a point along the curve relative to the specified start point index. The returned position can be between curve points (to match the requested distance as accurately as possible).

Parameters

startCurvePointId	index of the curve point to start the distance measurement from
distanceFromStartPoint	distance from the start point

Returns: true if a point found exactly at the requested distance

◆ GetPositionAndClosestPointIndexAlongCurve()

static bool vtkMRMLMarkupsCurveNode::GetPositionAndClosestPointIndexAlongCurve	(	double	foundCurvePosition[3],
		vtkIdType &	foundClosestPointIndex,
		vtkIdType	startCurvePointId,
		double	distanceFromStartPoint,
		vtkPoints *	curvePoints,
		bool	closedCurve
	)

static

Get point position along curve. Position is found along the curve and not snapped to closest curve point.

◆ GetSampledCurvePointsBetweenStartEndPointsWorld()

bool vtkMRMLMarkupsCurveNode::GetSampledCurvePointsBetweenStartEndPointsWorld	(	vtkPoints *	sampledPoints,
		double	samplingDistance,
		vtkIdType	startCurvePointIndex,
		vtkIdType	endCurvePointIndex
	)

Samples points along the curve at equal distances. If endPointIndex < startPointIndex then after the last point, the curve is assumed to continue at the first point.

◆ GetShortestDistanceSurfaceNode()

vtkMRMLModelNode* vtkMRMLMarkupsCurveNode::GetShortestDistanceSurfaceNode ( )

◆ GetShortestDistanceSurfaceNodeReferenceMRMLAttributeName()

const char* vtkMRMLMarkupsCurveNode::GetShortestDistanceSurfaceNodeReferenceMRMLAttributeName ( )

inline

Definition at line 229 of file vtkMRMLMarkupsCurveNode.h.

◆ GetShortestDistanceSurfaceNodeReferenceRole()

const char* vtkMRMLMarkupsCurveNode::GetShortestDistanceSurfaceNodeReferenceRole ( )

inline

Node reference role for the surface that is used in the shortest surface distance curve type.

Definition at line 228 of file vtkMRMLMarkupsCurveNode.h.

◆ GetSurfaceCostFunctionType()

int vtkMRMLMarkupsCurveNode::GetSurfaceCostFunctionType ( )

The method that should be used to combine the distance with the scalar value. Uses the COST_FUNCTION_X enums from vtkSlicerDijkstraGraphGeodesicPath.

◆ GetSurfaceCostFunctionTypeAsString()

static const char* vtkMRMLMarkupsCurveNode::GetSurfaceCostFunctionTypeAsString ( int surfaceCostFunctionType )

static

◆ GetSurfaceCostFunctionTypeFromString()

static int vtkMRMLMarkupsCurveNode::GetSurfaceCostFunctionTypeFromString ( const char * name )

static

◆ GetSurfaceDistanceWeightingFunction()

const char* vtkMRMLMarkupsCurveNode::GetSurfaceDistanceWeightingFunction ( )

The scalar weight function that is used for modifying the weight on each vertex. The the currently active point scalar array is available as the "activeScalar" variable.

◆ IsA()

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

virtual

Reimplemented from vtkMRMLMarkupsNode.

Reimplemented in vtkMRMLMarkupsClosedCurveNode.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLMarkupsCurveNode* vtkMRMLMarkupsCurveNode::New ( )

static

◆ OnCurvatureMeasurementModified()

static void vtkMRMLMarkupsCurveNode::OnCurvatureMeasurementModified	(	vtkObject *	caller,
		unsigned long	eid,
		void *	clientData,
		void *	callData
	)

staticprotected

Callback function observing curvature measurement modified events to propagate enabled state.

◆ OnNodeReferenceAdded()

void vtkMRMLMarkupsCurveNode::OnNodeReferenceAdded ( vtkMRMLNodeReference * reference )

overrideprotectedvirtual

Called when a node reference ID is added (list size increased).

Reimplemented from vtkMRMLDisplayableNode.

◆ OnNodeReferenceModified()

void vtkMRMLMarkupsCurveNode::OnNodeReferenceModified ( vtkMRMLNodeReference * reference )

overrideprotectedvirtual

Called when a node reference ID is modified.

Reimplemented from vtkMRMLDisplayableNode.

◆ OnNodeReferenceRemoved()

void vtkMRMLMarkupsCurveNode::OnNodeReferenceRemoved ( vtkMRMLNodeReference * reference )

overrideprotectedvirtual

Called after a node reference ID is removed (list size decreased).

Reimplemented from vtkMRMLDisplayableNode.

◆ OnSurfaceModelNodeChanged()

virtual void vtkMRMLMarkupsCurveNode::OnSurfaceModelNodeChanged ( )

protectedvirtual

◆ OnSurfaceModelTransformChanged()

virtual void vtkMRMLMarkupsCurveNode::OnSurfaceModelTransformChanged ( )

protectedvirtual

◆ operator=()

void vtkMRMLMarkupsCurveNode::operator= ( const vtkMRMLMarkupsCurveNode & )

protected

◆ PrintSelf()

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

override

Print out the node information to the output stream.

◆ ProcessMRMLEvents()

void vtkMRMLMarkupsCurveNode::ProcessMRMLEvents	(	vtkObject *	,
		unsigned long	long,
		void *
	)

overrideprotectedvirtual

alternative method to propagate events generated in Display nodes

Deprecated:: GetDisplayNodes Obsolete utility function that provides an unsafe API. Please use GetNumberOfDisplayNodes() and GetNthDisplayNode() instead const std::vector<vtkMRMLDisplayNode*>& GetDisplayNodes();

See also: GetNumberOfDisplayNodes, GetNthDisplayNode

Reimplemented from vtkMRMLDisplayableNode.

◆ ReadXMLAttributes()

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

overridevirtual

Read node attributes from XML file.

Reimplemented from vtkMRMLDisplayableNode.

◆ ResampleCurveSurface()

bool vtkMRMLMarkupsCurveNode::ResampleCurveSurface	(	double	controlPointDistance,
		vtkMRMLModelNode *	node,
		double	maximumSearchRadius = `.25`
	)

Resample a curve with points constrained to surface Projection to surface is constrained by maximumSearchRadius, specified as a percentage of the model's bounding box diagonal in world coordinate system. Valid in the range between 0 and 1. maximumSearchRadius is valid in the range between 0 and 1. returns true if successful, false in case of error

◆ ResampleCurveWorld()

void vtkMRMLMarkupsCurveNode::ResampleCurveWorld ( double controlPointDistance )

◆ ResamplePoints()

static bool vtkMRMLMarkupsCurveNode::ResamplePoints	(	vtkPoints *	originalPoints,
		vtkPoints *	interpolatedPoints,
		double	samplingDistance,
		bool	closedCurve
	)

static

◆ SafeDownCast()

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

static

◆ SetAndObserveShortestDistanceSurfaceNode()

void vtkMRMLMarkupsCurveNode::SetAndObserveShortestDistanceSurfaceNode ( vtkMRMLModelNode * modelNode )

The model node that is used as the surface mesh for finding the shortest distance path on the surface mesh. Used by the ShortestDistanceOnSurface curve type.

◆ SetControlPointLabels()

bool vtkMRMLMarkupsCurveNode::SetControlPointLabels	(	vtkStringArray *	labels,
		vtkPoints *	points
	)

Provides access to protected vtkMRMLMarkupsNode::SetControlPointLabelsWorld.

◆ SetCurveType()

void vtkMRMLMarkupsCurveNode::SetCurveType ( int type )

◆ SetCurveTypeToCardinalSpline()

void vtkMRMLMarkupsCurveNode::SetCurveTypeToCardinalSpline ( )

◆ SetCurveTypeToKochanekSpline()

void vtkMRMLMarkupsCurveNode::SetCurveTypeToKochanekSpline ( )

◆ SetCurveTypeToLinear()

void vtkMRMLMarkupsCurveNode::SetCurveTypeToLinear ( )

◆ SetCurveTypeToPolynomial()

void vtkMRMLMarkupsCurveNode::SetCurveTypeToPolynomial ( )

◆ SetCurveTypeToShortestDistanceOnSurface()

void vtkMRMLMarkupsCurveNode::SetCurveTypeToShortestDistanceOnSurface ( vtkMRMLModelNode * modelNode = nullptr )

◆ SetNumberOfPointsPerInterpolatingSegment()

void vtkMRMLMarkupsCurveNode::SetNumberOfPointsPerInterpolatingSegment ( int pointsPerSegment )

◆ SetSurfaceCostFunctionType()

void vtkMRMLMarkupsCurveNode::SetSurfaceCostFunctionType ( int surfaceCostFunctionType )

◆ SetSurfaceDistanceWeightingFunction()

void vtkMRMLMarkupsCurveNode::SetSurfaceDistanceWeightingFunction ( const char * function )

◆ UpdateAssignedAttribute()

virtual void vtkMRMLMarkupsCurveNode::UpdateAssignedAttribute ( )

overridevirtual

Update scalar range and update markups pipeline when the active scalar array is changed.

Reimplemented from vtkMRMLMarkupsNode.

◆ UpdateMeasurementsInternal()

void vtkMRMLMarkupsCurveNode::UpdateMeasurementsInternal ( )

overrideprotectedvirtual

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

Reimplemented from vtkMRMLMarkupsNode.

◆ UpdateSurfaceScalarVariables()

virtual void vtkMRMLMarkupsCurveNode::UpdateSurfaceScalarVariables ( )

protectedvirtual

◆ vtkMRMLCopyContentMacro()

vtkMRMLMarkupsCurveNode::vtkMRMLCopyContentMacro ( vtkMRMLMarkupsCurveNode )

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

See also: vtkMRMLNode::CopyContent

◆ WriteXML()

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

overridevirtual

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

Reimplemented from vtkMRMLDisplayableNode.

Member Data Documentation

◆ CleanFilter

vtkSmartPointer<vtkCleanPolyData> vtkMRMLMarkupsCurveNode::CleanFilter

protected

Definition at line 259 of file vtkMRMLMarkupsCurveNode.h.

◆ CurvatureMeasurementModifiedCallbackCommand

vtkCallbackCommand* vtkMRMLMarkupsCurveNode::CurvatureMeasurementModifiedCallbackCommand

protected

Command handling curvature measurement modified events to propagate enabled state.

Definition at line 273 of file vtkMRMLMarkupsCurveNode.h.

◆ CurveMeasurementsCalculator

vtkSmartPointer<vtkCurveMeasurementsCalculator> vtkMRMLMarkupsCurveNode::CurveMeasurementsCalculator

protected

Definition at line 264 of file vtkMRMLMarkupsCurveNode.h.

◆ ScalarDisplayAssignAttribute

vtkSmartPointer<vtkAssignAttribute> vtkMRMLMarkupsCurveNode::ScalarDisplayAssignAttribute

protected

Filter that changes the active scalar of the input mesh using the ActiveScalarName and ActiveAttributeLocation properties. This can be useful to specify what field array is the color array that needs to be used by the VTK mappers.

Definition at line 270 of file vtkMRMLMarkupsCurveNode.h.

◆ ShortestDistanceSurfaceActiveScalar

const char* vtkMRMLMarkupsCurveNode::ShortestDistanceSurfaceActiveScalar

protected

Definition at line 265 of file vtkMRMLMarkupsCurveNode.h.

◆ SurfaceScalarCalculator

vtkSmartPointer<vtkArrayCalculator> vtkMRMLMarkupsCurveNode::SurfaceScalarCalculator

protected

Definition at line 262 of file vtkMRMLMarkupsCurveNode.h.

◆ SurfaceScalarPassThroughFilter

vtkSmartPointer<vtkPassThroughFilter> vtkMRMLMarkupsCurveNode::SurfaceScalarPassThroughFilter

protected

Definition at line 263 of file vtkMRMLMarkupsCurveNode.h.

◆ SurfaceToLocalTransformer

vtkSmartPointer<vtkTransformPolyDataFilter> vtkMRMLMarkupsCurveNode::SurfaceToLocalTransformer

protected

Definition at line 261 of file vtkMRMLMarkupsCurveNode.h.

◆ TriangleFilter

vtkSmartPointer<vtkTriangleFilter> vtkMRMLMarkupsCurveNode::TriangleFilter

protected

Definition at line 260 of file vtkMRMLMarkupsCurveNode.h.

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

Modules/Loadable/Markups/MRML/vtkMRMLMarkupsCurveNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkMRMLMarkupsCurveNode() [1/2]

◆ ~vtkMRMLMarkupsCurveNode()

◆ vtkMRMLMarkupsCurveNode() [2/2]

Member Function Documentation

◆ ConstrainPointsToSurface()

◆ CreateNodeInstance()

◆ GetClassName()

◆ GetClosestCurvePointIndexToPositionWorld()

◆ GetClosestPointPositionAlongCurveWorld()

◆ GetCurveDirectionAtPointIndexWorld()

◆ GetCurveLength()

◆ GetCurveLengthBetweenStartEndPointsWorld()

◆ GetCurveLengthWorld()

◆ GetCurvePointIndexAlongCurveWorld()

◆ GetCurvePointIndexFromControlPointIndex()

◆ GetCurvePointsWorld()

◆ GetCurvePointToWorldTransformAtPointIndex()

◆ GetCurveType()

◆ GetCurveTypeAsString()

◆ GetCurveTypeFromString()

◆ GetFarthestCurvePointIndexToPositionWorld()

◆ GetIcon()

◆ GetNodeTagName()

◆ GetNumberOfPointsPerInterpolatingSegment()

◆ GetPointsOnPlaneWorld()

◆ GetPositionAlongCurveWorld()

◆ GetPositionAndClosestPointIndexAlongCurve()

◆ GetSampledCurvePointsBetweenStartEndPointsWorld()

◆ GetShortestDistanceSurfaceNode()

◆ GetShortestDistanceSurfaceNodeReferenceMRMLAttributeName()

◆ GetShortestDistanceSurfaceNodeReferenceRole()

◆ GetSurfaceCostFunctionType()

◆ GetSurfaceCostFunctionTypeAsString()

◆ GetSurfaceCostFunctionTypeFromString()

◆ GetSurfaceDistanceWeightingFunction()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ OnCurvatureMeasurementModified()

◆ OnNodeReferenceAdded()

◆ OnNodeReferenceModified()

◆ OnNodeReferenceRemoved()

◆ OnSurfaceModelNodeChanged()

◆ OnSurfaceModelTransformChanged()

◆ operator=()

◆ PrintSelf()

◆ ProcessMRMLEvents()

◆ ReadXMLAttributes()

◆ ResampleCurveSurface()

◆ ResampleCurveWorld()

◆ ResamplePoints()

◆ SafeDownCast()

◆ SetAndObserveShortestDistanceSurfaceNode()

◆ SetControlPointLabels()

◆ SetCurveType()

◆ SetCurveTypeToCardinalSpline()

◆ SetCurveTypeToKochanekSpline()

◆ SetCurveTypeToLinear()

◆ SetCurveTypeToPolynomial()

◆ SetCurveTypeToShortestDistanceOnSurface()

◆ SetNumberOfPointsPerInterpolatingSegment()

◆ SetSurfaceCostFunctionType()

◆ SetSurfaceDistanceWeightingFunction()

◆ UpdateAssignedAttribute()

◆ UpdateMeasurementsInternal()

◆ UpdateSurfaceScalarVariables()

◆ vtkMRMLCopyContentMacro()

◆ WriteXML()

Member Data Documentation