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

Inheritance diagram for vtkMRMLAnnotationRulerNode:

[legend]

Collaboration diagram for vtkMRMLAnnotationRulerNode:

[legend]

Public Types
enum	{ RulerNodeAddedEvent = 20010, ValueModifiedEvent }

typedef vtkMRMLAnnotationLinesNode	Superclass

Public Types inherited from vtkMRMLAnnotationLinesNode
enum	{ LINE_SELECTED = vtkMRMLAnnotationControlPointsNode::NUM_CP_ATTRIBUTE_TYPES, LINE_VISIBLE, NUM_LINE_ATTRIBUTE_TYPES }

typedef vtkMRMLAnnotationControlPointsNode	Superclass

Public Types inherited from vtkMRMLAnnotationControlPointsNode
enum	{ CP_SELECTED = vtkMRMLAnnotationNode::NUM_TEXT_ATTRIBUTE_TYPES, CP_VISIBLE, NUM_CP_ATTRIBUTE_TYPES }

enum	{ ControlPointModifiedEvent = 19010 }

enum	NumberingSchemes { SchemeMin = 0, UseID = SchemeMin, UseIndex, UsePrevious, SchemeMax = UsePrevious }
	flags to determine how the next fiducial added to the list is labelled More...

typedef vtkMRMLAnnotationNode	Superclass

Public Types inherited from vtkMRMLAnnotationNode
enum	{ TEXT_SELECTED = 0, TEXT_VISIBLE, NUM_TEXT_ATTRIBUTE_TYPES, LockModifiedEvent }

typedef vtkMRMLModelNode	Superclass

Public Types inherited from vtkMRMLModelNode
enum	{ MeshModifiedEvent = 17001, PolyDataModifiedEvent = 17001 }

enum	MeshTypeHint { PolyDataMeshType = 0, UnstructuredGridMeshType }

typedef vtkMRMLDisplayableNode	Superclass

Public Types inherited from vtkMRMLDisplayableNode
enum	{ DisplayModifiedEvent = 17000 }

typedef vtkMRMLTransformableNode	Superclass

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

typedef vtkMRMLStorableNode	Superclass

Public Types inherited from vtkMRMLStorableNode
typedef vtkMRMLNode	Superclass

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

typedef vtkObject	Superclass

Public Member Functions
void	ApplyTransform (vtkAbstractTransform *transform) override

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

vtkMRMLStorageNode *	CreateDefaultStorageNode () override

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

virtual const char *	GetClassName ()

virtual char *	GetDistanceAnnotationFormat ()

double	GetDistanceAnnotationScale ()

double *	GetDistanceAnnotationTextColour ()

int	GetDistanceAnnotationVisibility ()

double	GetDistanceMeasurement ()
	Calculate the distance between world coordinates of the two end points. More...

const char *	GetIcon () override

double *	GetLineColour ()

virtual char *	GetModelID1 ()
	get/set the id of the model the first and second end of the ruler is constrained upon More...

virtual char *	GetModelID2 ()

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

double *	GetPointColour ()

void	GetPosition1 (double position[3])

double *	GetPosition1 ()

void	GetPosition2 (double position[3])

double *	GetPosition2 ()

void	GetPositionWorldCoordinates1 (double position[4])

void	GetPositionWorldCoordinates2 (double position[4])

virtual int	IsA (const char *type)

void	PrintAnnotationInfo (ostream &os, vtkIndent indent, int titleFlag=1) 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	SetDistanceAnnotationFormat (const char *)

void	SetDistanceAnnotationScale (double init)

void	SetDistanceAnnotationTextColour (double initColor[3])

void	SetDistanceAnnotationVisibility (int flag)

void	SetLineColour (double newColor[3])

virtual void	SetModelID1 (const char *)

virtual void	SetModelID2 (const char *)

void	SetPointColour (double initColor[3])

int	SetPosition1 (double newControl[3])

int	SetPosition1 (double nC1, double nC2, double nC3)

int	SetPosition2 (double newControl[3])

int	SetPosition2 (double nC1, double nC2, double nC3)

int	SetPositionWorldCoordinates1 (double newControl[4])

int	SetPositionWorldCoordinates2 (double newControl[4])

int	SetRuler (vtkIdType line1Id, int sel, int vis)

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

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

Public Member Functions inherited from vtkMRMLAnnotationLinesNode
int	AddLine (int ctrlPtIdStart, int ctrlPtIdEnd, int selectedFlag, int visibleFlag)

void	CreateAnnotationLineDisplayNode ()

void	DeleteLine (int id)

vtkMRMLAnnotationLineDisplayNode *	GetAnnotationLineDisplayNode ()

const char *	GetAttributeTypesEnumAsString (int val) override

int	GetEndPointsId (vtkIdType lineID, vtkIdType ctrlPtID[2])

int	GetNumberOfLines ()

void	Initialize (vtkMRMLScene *mrmlScene) override

void	ResetAnnotations () override

int	SetControlPoint (int id, double newControl[3], int selectedFlag, int visibleFlag)

int	SetControlPointWorldCoordinates (int id, double newControl[3], int selectedFlag, int visibleFlag)

int	SetLine (int id, int ctrlPtIdStart, int ctrlPtIdEnd, int selectedFlag, int visibleFlag)

	vtkMRMLCopyContentDefaultMacro (vtkMRMLAnnotationLinesNode)

Public Member Functions inherited from vtkMRMLAnnotationControlPointsNode
int	AddControlPoint (double newControl[3], int selectedFlag, int visibleFlag)

void	CreateAnnotationPointDisplayNode ()

void	DeleteControlPoint (int id)

vtkMRMLAnnotationPointDisplayNode *	GetAnnotationPointDisplayNode ()

double *	GetControlPointCoordinates (vtkIdType id)

void	GetControlPointWorldCoordinates (vtkIdType id, double *point)

virtual int	GetNumberingScheme ()

const char *	GetNumberingSchemeAsString ()
	Return a string representing the numbering scheme, set it from a string. More...

const char *	GetNumberingSchemeAsString (int g)

int	GetNumberOfControlPoints ()

int	InvokePendingModifiedEvent () override

void	Modified () override

int	SetControlPoint (int id, double newControl[3], int selectedFlag, int visibleFlag)

int	SetControlPoint (int id, double newControl[3])

int	SetControlPointWorldCoordinates (int id, double newControl[3], int selectedFlag, int visibleFlag)

int	SetControlPointWorldCoordinates (int id, double newControl[3])

virtual void	SetNumberingScheme (int numberingScheme)
	Flag determining how to number the next added fiducial. More...

void	SetNumberingSchemeFromString (const char *schemeString)

	vtkMRMLCopyContentDefaultMacro (vtkMRMLAnnotationControlPointsNode)

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

Public Member Functions inherited from vtkMRMLAnnotationNode
int	AddText (const char *newText, int selectedFlag, int visibleFlag)

bool	CanApplyNonLinearTransforms () const override

void	ClearBackup ()

void	CreateAnnotationTextDisplayNode ()

void	CreateBackup ()
	Creates a backup of the current MRML state of this node and keeps a reference. More...

int	DeleteAttribute (vtkIdType idAttEntry, vtkIdType idAttType)

int	DeleteText (int id)

int	GetAnnotationAttribute (vtkIdType id, int att)

vtkDataArray *	GetAnnotationAttributes (int att)

vtkMRMLAnnotationTextDisplayNode *	GetAnnotationTextDisplayNode ()

vtkMRMLAnnotationNode *	GetBackup ()
	Returns the associated backup of this node. More...

std::string	GetDefaultStorageNodeClassName (const char *filename) override

virtual int	GetLocked ()

int	GetNumberOfTexts ()

virtual char *	GetReferenceNodeID ()

vtkStdString	GetText (int id)

double	GetTextScale ()
	Get the text scale of the associated text. More...

void	PrintSelf (ostream &os, vtkIndent indent) override

void	RestoreBackup ()
	Restore an attached backup of this node. More...

void	RestoreView ()
	Restores a previously saved view. More...

void	SaveView ()
	Saves the current view. More...

void	SetAnnotationAttribute (vtkIdType id, int att, double value)

void	SetLocked (int init)

virtual void	SetReferenceNodeID (const char *)

void	SetText (int id, const char *newText, int selectedFlag, int visibleFlag)

void	SetTextScale (double textScale)
	Set the text scale of the associated text. More...

	vtkMRMLCopyContentMacro (vtkMRMLAnnotationNode)

Public Member Functions inherited from vtkMRMLModelNode
void	AddCellScalars (vtkDataArray *array)

void	AddPointScalars (vtkDataArray *array)
	Utility function that adds an array to the mesh's point data. /. More...

void	AddScalars (vtkDataArray *array, int location)

int	CompositeScalars (const char backgroundName, const char overlayName, float overlayMin, float overlayMax, int showOverlayPositive, int showOverlayNegative, int reverseOverlay)

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

const char *	GetActiveCellScalarName (int type)

const char *	GetActivePointScalarName (int type)

void	GetBounds (double bounds[6]) override

virtual vtkPointSet *	GetMesh ()

virtual vtkAlgorithmOutput *	GetMeshConnection ()

virtual MeshTypeHint	GetMeshType ()

vtkMRMLModelDisplayNode *	GetModelDisplayNode ()
	Get associated model display MRML node. More...

bool	GetModifiedSinceRead () override

virtual vtkPolyData *	GetPolyData ()

virtual vtkAlgorithmOutput *	GetPolyDataConnection ()

void	GetRASBounds (double bounds[6]) override

virtual vtkUnstructuredGrid *	GetUnstructuredGrid ()

virtual vtkAlgorithmOutput *	GetUnstructuredGridConnection ()

bool	HasCellScalarName (const char *scalarName)

bool	HasPointScalarName (const char *scalarName)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	RemoveScalars (const char *scalarName)
	Remove an array from the mesh's point/cell data. More...

int	SetActiveCellScalars (const char *scalarName, int attributeType)

int	SetActivePointScalars (const char *scalarName, int attributeType)

virtual void	SetAndObserveMesh (vtkPointSet *Mesh)

virtual void	SetAndObservePolyData (vtkPolyData *polyData)

virtual void	SetPolyDataConnection (vtkAlgorithmOutput *inputPort)

virtual void	SetUnstructuredGridConnection (vtkAlgorithmOutput *inputPort)

virtual void	TransformBoundsToRAS (double inputBounds_Local[6], double outputBounds_RAS[6])

	vtkMRMLCopyContentMacro (vtkMRMLModelNode)

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

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

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

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

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 int	IsTypeOf (const char *type)

static vtkMRMLAnnotationRulerNode *	New ()

static vtkMRMLAnnotationRulerNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLAnnotationLinesNode *	New ()

static vtkMRMLAnnotationLinesNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLAnnotationControlPointsNode *	New ()

static vtkMRMLAnnotationControlPointsNode *	SafeDownCast (vtkObject *o)

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

static vtkMRMLAnnotationNode *	New ()

static vtkMRMLAnnotationNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLModelNode
static int	GetAttributeTypeFromString (const char *typeName)

static int	IsTypeOf (const char *type)

static vtkMRMLModelNode *	New ()

static vtkMRMLModelNode *	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
int	AddControlPoint (double newControl[3], int selectedFlag, int visibleFlag)

void	operator= (const vtkMRMLAnnotationRulerNode &)

int	SetControlPoint (int id, double newControl[3])

	vtkMRMLAnnotationRulerNode ()

	vtkMRMLAnnotationRulerNode (const vtkMRMLAnnotationRulerNode &)

	~vtkMRMLAnnotationRulerNode () override

Protected Member Functions inherited from vtkMRMLAnnotationLinesNode
void	CreatePolyData ()

void	operator= (const vtkMRMLAnnotationLinesNode &)

void	ResetLines ()

void	ResetLinesAttributesAll ()

	vtkMRMLAnnotationLinesNode ()

	vtkMRMLAnnotationLinesNode (const vtkMRMLAnnotationLinesNode &)

	~vtkMRMLAnnotationLinesNode () override

Protected Member Functions inherited from vtkMRMLAnnotationControlPointsNode
void	CreatePolyData ()

void	operator= (const vtkMRMLAnnotationControlPointsNode &)

void	ResetControlPoints ()

void	ResetControlPointsAttributesAll ()

	vtkMRMLAnnotationControlPointsNode ()

	vtkMRMLAnnotationControlPointsNode (const vtkMRMLAnnotationControlPointsNode &)

	~vtkMRMLAnnotationControlPointsNode () override=default

Protected Member Functions inherited from vtkMRMLAnnotationNode
void	CreatePolyData ()

vtkCellArray *	GetLines ()

vtkPoints *	GetPoints ()

void	operator= (const vtkMRMLAnnotationNode &)

void	ResetAttributes (int id)

void	ResetTextAttributesAll ()

void	SetAttributeSize (vtkIdType id, vtkIdType n)

	vtkMRMLAnnotationNode ()

	vtkMRMLAnnotationNode (const vtkMRMLAnnotationNode &)

	~vtkMRMLAnnotationNode () override

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

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

void	operator= (const vtkMRMLModelNode &)

virtual void	SetMeshConnection (vtkAlgorithmOutput *inputPort)
	Called by SetPolyDataConnection and SetUnstructuredGridConnection. More...

virtual void	SetMeshToDisplayNode (vtkMRMLModelDisplayNode *modelDisplayNode)

void	SetMeshToDisplayNodes ()

virtual void	UpdateDisplayNodeMesh (vtkMRMLDisplayNode *dnode)

	vtkMRMLModelNode ()

	vtkMRMLModelNode (const vtkMRMLModelNode &)

	~vtkMRMLModelNode () override

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

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

void	operator= (const vtkMRMLDisplayableNode &)

	vtkMRMLDisplayableNode ()

	vtkMRMLDisplayableNode (const vtkMRMLDisplayableNode &)

	~vtkMRMLDisplayableNode () override

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

virtual const char *	GetTransformNodeReferenceRole ()

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

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

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

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

void	operator= (const vtkMRMLTransformableNode &)

	vtkMRMLTransformableNode ()

	vtkMRMLTransformableNode (const vtkMRMLTransformableNode &)

	~vtkMRMLTransformableNode () override

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

virtual const char *	GetStorageNodeReferenceRole ()

virtual vtkTimeStamp	GetStoredTime ()

void	operator= (const vtkMRMLStorableNode &)

	vtkMRMLStorableNode ()

	vtkMRMLStorableNode (const vtkMRMLStorableNode &)

	~vtkMRMLStorableNode () override

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

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

virtual char *	GetTempURLString ()

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

virtual void	InvalidateNodeReferences ()

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

void	operator= (const vtkMRMLNode &)

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

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

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

Protected Attributes
char *	DistanceAnnotationFormat

char *	ModelID1

char *	ModelID2

Protected Attributes inherited from vtkMRMLAnnotationLinesNode
bool	InitializeLinesFlag

Protected Attributes inherited from vtkMRMLAnnotationControlPointsNode
int	NumberingScheme
	How the next annotation will be numbered in it's Text field. More...

Protected Attributes inherited from vtkMRMLAnnotationNode
int	Locked

vtkMRMLAnnotationNode *	m_Backup

vtkSmartPointer< vtkMRMLCameraNode >	m_CameraNode

vtkSmartPointer< vtkMRMLSliceNode >	m_GreenSliceNode

vtkSmartPointer< vtkMRMLSliceNode >	m_RedSliceNode

vtkSmartPointer< vtkMRMLSliceNode >	m_YellowSliceNode

char *	ReferenceNodeID

vtkStringArray *	TextList

Protected Attributes inherited from vtkMRMLModelNode
vtkEventForwarderCommand *	DataEventForwarder

vtkAlgorithmOutput *	MeshConnection
	Data. More...

MeshTypeHint	MeshType

Protected Attributes inherited from vtkMRMLStorableNode
std::string	SlicerDataType

vtkTimeStamp	StorableModifiedTime

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 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 12 of file vtkMRMLAnnotationRulerNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLAnnotationLinesNode vtkMRMLAnnotationRulerNode::Superclass

Definition at line 16 of file vtkMRMLAnnotationRulerNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
RulerNodeAddedEvent
ValueModifiedEvent

Definition at line 179 of file vtkMRMLAnnotationRulerNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLAnnotationRulerNode() [1/2]

vtkMRMLAnnotationRulerNode::vtkMRMLAnnotationRulerNode ( )

protected

◆ ~vtkMRMLAnnotationRulerNode()

vtkMRMLAnnotationRulerNode::~vtkMRMLAnnotationRulerNode ( )

overrideprotected

◆ vtkMRMLAnnotationRulerNode() [2/2]

vtkMRMLAnnotationRulerNode::vtkMRMLAnnotationRulerNode ( const vtkMRMLAnnotationRulerNode & )

protected

Member Function Documentation

◆ AddControlPoint()

int vtkMRMLAnnotationRulerNode::AddControlPoint	(	double	newControl[3],
		int	selectedFlag,
		int	visibleFlag
	)

protected

◆ ApplyTransform()

void vtkMRMLAnnotationRulerNode::ApplyTransform ( vtkAbstractTransform * transform )

overridevirtual

Transforms the node with the provided non-linear transform.

See also: SetAndObserveTransformNodeID, ApplyTransformMatrix, CanApplyNonLinearTransforms

Reimplemented from vtkMRMLModelNode.

◆ Copy()

void vtkMRMLAnnotationRulerNode::Copy ( vtkMRMLNode * node )

overridevirtual

Copy the node's attributes to this object

Reimplemented from vtkMRMLDisplayableNode.

◆ CreateDefaultStorageNode()

vtkMRMLStorageNode* vtkMRMLAnnotationRulerNode::CreateDefaultStorageNode ( )

overridevirtual

Create a storage node for this node type. If it returns nullptr then it means the node can be stored in the scene (in XML), without using a storage node. Null by default. This must be overwritten by subclasses that use storage nodes.

Reimplemented from vtkMRMLAnnotationLinesNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLAnnotationRulerNode::CreateNodeInstance ( )

overridevirtual

MRMLNode methods.

Reimplemented from vtkMRMLAnnotationLinesNode.

◆ GetClassName()

virtual const char* vtkMRMLAnnotationRulerNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLAnnotationLinesNode.

◆ GetDistanceAnnotationFormat()

virtual char* vtkMRMLAnnotationRulerNode::GetDistanceAnnotationFormat ( )

virtual

◆ GetDistanceAnnotationScale()

double vtkMRMLAnnotationRulerNode::GetDistanceAnnotationScale ( )

◆ GetDistanceAnnotationTextColour()

double* vtkMRMLAnnotationRulerNode::GetDistanceAnnotationTextColour ( )

◆ GetDistanceAnnotationVisibility()

int vtkMRMLAnnotationRulerNode::GetDistanceAnnotationVisibility ( )

◆ GetDistanceMeasurement()

double vtkMRMLAnnotationRulerNode::GetDistanceMeasurement ( )

Calculate the distance between world coordinates of the two end points.

◆ GetIcon()

const char* vtkMRMLAnnotationRulerNode::GetIcon ( )

inlineoverridevirtual

Reimplemented from vtkMRMLAnnotationNode.

Definition at line 30 of file vtkMRMLAnnotationRulerNode.h.

◆ GetLineColour()

double* vtkMRMLAnnotationRulerNode::GetLineColour ( )

◆ GetModelID1()

virtual char* vtkMRMLAnnotationRulerNode::GetModelID1 ( )

virtual

get/set the id of the model the first and second end of the ruler is constrained upon

◆ GetModelID2()

virtual char* vtkMRMLAnnotationRulerNode::GetModelID2 ( )

virtual

◆ GetNodeTagName()

const char* vtkMRMLAnnotationRulerNode::GetNodeTagName ( )

inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Reimplemented from vtkMRMLAnnotationLinesNode.

Definition at line 28 of file vtkMRMLAnnotationRulerNode.h.

◆ GetPointColour()

double* vtkMRMLAnnotationRulerNode::GetPointColour ( )

◆ GetPosition1() [1/2]

void vtkMRMLAnnotationRulerNode::GetPosition1 ( double position[3] )

◆ GetPosition1() [2/2]

double* vtkMRMLAnnotationRulerNode::GetPosition1 ( )

inline

Definition at line 69 of file vtkMRMLAnnotationRulerNode.h.

◆ GetPosition2() [1/2]

void vtkMRMLAnnotationRulerNode::GetPosition2 ( double position[3] )

◆ GetPosition2() [2/2]

double* vtkMRMLAnnotationRulerNode::GetPosition2 ( )

inline

Definition at line 104 of file vtkMRMLAnnotationRulerNode.h.

◆ GetPositionWorldCoordinates1()

void vtkMRMLAnnotationRulerNode::GetPositionWorldCoordinates1 ( double position[4] )

inline

Definition at line 59 of file vtkMRMLAnnotationRulerNode.h.

◆ GetPositionWorldCoordinates2()

void vtkMRMLAnnotationRulerNode::GetPositionWorldCoordinates2 ( double position[4] )

inline

Definition at line 97 of file vtkMRMLAnnotationRulerNode.h.

◆ IsA()

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

virtual

Reimplemented from vtkMRMLAnnotationLinesNode.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLAnnotationRulerNode* vtkMRMLAnnotationRulerNode::New ( )

static

◆ operator=()

void vtkMRMLAnnotationRulerNode::operator= ( const vtkMRMLAnnotationRulerNode & )

protected

◆ PrintAnnotationInfo()

void vtkMRMLAnnotationRulerNode::PrintAnnotationInfo	(	ostream &	os,
		vtkIndent	indent,
		int	titleFlag = `1`
	)

overridevirtual

Reimplemented from vtkMRMLAnnotationLinesNode.

◆ ProcessMRMLEvents()

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

overridevirtual

alternative method to propagate events generated in Display nodes

Reimplemented from vtkMRMLAnnotationLinesNode.

◆ ReadXMLAttributes()

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

overridevirtual

Read node attributes from XML file

Reimplemented from vtkMRMLAnnotationLinesNode.

◆ SafeDownCast()

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

static

◆ SetControlPoint()

int vtkMRMLAnnotationRulerNode::SetControlPoint	(	int	id,
		double	newControl[3]
	)

protected

◆ SetDistanceAnnotationFormat()

virtual void vtkMRMLAnnotationRulerNode::SetDistanceAnnotationFormat ( const char * )

virtual

◆ SetDistanceAnnotationScale()

void vtkMRMLAnnotationRulerNode::SetDistanceAnnotationScale ( double init )

◆ SetDistanceAnnotationTextColour()

void vtkMRMLAnnotationRulerNode::SetDistanceAnnotationTextColour ( double initColor[3] )

◆ SetDistanceAnnotationVisibility()

void vtkMRMLAnnotationRulerNode::SetDistanceAnnotationVisibility ( int flag )

◆ SetLineColour()

void vtkMRMLAnnotationRulerNode::SetLineColour ( double newColor[3] )

◆ SetModelID1()

virtual void vtkMRMLAnnotationRulerNode::SetModelID1 ( const char * )

virtual

◆ SetModelID2()

virtual void vtkMRMLAnnotationRulerNode::SetModelID2 ( const char * )

virtual

◆ SetPointColour()

void vtkMRMLAnnotationRulerNode::SetPointColour ( double initColor[3] )

◆ SetPosition1() [1/2]

int vtkMRMLAnnotationRulerNode::SetPosition1 ( double newControl[3] )

inline

Definition at line 74 of file vtkMRMLAnnotationRulerNode.h.

◆ SetPosition1() [2/2]

int vtkMRMLAnnotationRulerNode::SetPosition1	(	double	nC1,
		double	nC2,
		double	nC3
	)

inline

Definition at line 86 of file vtkMRMLAnnotationRulerNode.h.

◆ SetPosition2() [1/2]

int vtkMRMLAnnotationRulerNode::SetPosition2 ( double newControl[3] )

inline

Definition at line 109 of file vtkMRMLAnnotationRulerNode.h.

◆ SetPosition2() [2/2]

int vtkMRMLAnnotationRulerNode::SetPosition2	(	double	nC1,
		double	nC2,
		double	nC3
	)

inline

Definition at line 121 of file vtkMRMLAnnotationRulerNode.h.

◆ SetPositionWorldCoordinates1()

int vtkMRMLAnnotationRulerNode::SetPositionWorldCoordinates1 ( double newControl[4] )

inline

Definition at line 79 of file vtkMRMLAnnotationRulerNode.h.

◆ SetPositionWorldCoordinates2()

int vtkMRMLAnnotationRulerNode::SetPositionWorldCoordinates2 ( double newControl[4] )

inline

Definition at line 114 of file vtkMRMLAnnotationRulerNode.h.

◆ SetRuler()

int vtkMRMLAnnotationRulerNode::SetRuler	(	vtkIdType	line1Id,
		int	sel,
		int	vis
	)

◆ UpdateScene()

void vtkMRMLAnnotationRulerNode::UpdateScene ( vtkMRMLScene * scene )

overridevirtual

Finds the storage node and read the data

Reimplemented from vtkMRMLAnnotationLinesNode.

◆ WriteXML()

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

overridevirtual

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

Reimplemented from vtkMRMLAnnotationLinesNode.

Member Data Documentation

◆ DistanceAnnotationFormat

char* vtkMRMLAnnotationRulerNode::DistanceAnnotationFormat

protected

Definition at line 194 of file vtkMRMLAnnotationRulerNode.h.

◆ ModelID1

char* vtkMRMLAnnotationRulerNode::ModelID1

protected

the model ids for the models that the ends of the ruler are constrained to

Definition at line 202 of file vtkMRMLAnnotationRulerNode.h.

◆ ModelID2

char* vtkMRMLAnnotationRulerNode::ModelID2

protected

Definition at line 203 of file vtkMRMLAnnotationRulerNode.h.

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

Modules/Loadable/Annotations/MRML/vtkMRMLAnnotationRulerNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkMRMLAnnotationRulerNode() [1/2]

◆ ~vtkMRMLAnnotationRulerNode()

◆ vtkMRMLAnnotationRulerNode() [2/2]

Member Function Documentation

◆ AddControlPoint()

◆ ApplyTransform()

◆ Copy()

◆ CreateDefaultStorageNode()

◆ CreateNodeInstance()

◆ GetClassName()

◆ GetDistanceAnnotationFormat()

◆ GetDistanceAnnotationScale()

◆ GetDistanceAnnotationTextColour()

◆ GetDistanceAnnotationVisibility()

◆ GetDistanceMeasurement()

◆ GetIcon()

◆ GetLineColour()

◆ GetModelID1()

◆ GetModelID2()

◆ GetNodeTagName()

◆ GetPointColour()

◆ GetPosition1() [1/2]

◆ GetPosition1() [2/2]

◆ GetPosition2() [1/2]

◆ GetPosition2() [2/2]

◆ GetPositionWorldCoordinates1()

◆ GetPositionWorldCoordinates2()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ operator=()

◆ PrintAnnotationInfo()

◆ ProcessMRMLEvents()

◆ ReadXMLAttributes()

◆ SafeDownCast()

◆ SetControlPoint()

◆ SetDistanceAnnotationFormat()

◆ SetDistanceAnnotationScale()

◆ SetDistanceAnnotationTextColour()

◆ SetDistanceAnnotationVisibility()

◆ SetLineColour()

◆ SetModelID1()

◆ SetModelID2()

◆ SetPointColour()

◆ SetPosition1() [1/2]

◆ SetPosition1() [2/2]

◆ SetPosition2() [1/2]

◆ SetPosition2() [2/2]

◆ SetPositionWorldCoordinates1()

◆ SetPositionWorldCoordinates2()

◆ SetRuler()

◆ UpdateScene()

◆ WriteXML()

Member Data Documentation

◆ DistanceAnnotationFormat

◆ ModelID1

◆ ModelID2