Slicer  5.3
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes
vtkMRMLTransformableNode Class Referenceabstract

MRML node for representing a node with a transform. More...

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

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

Public Types

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

virtual void ApplyTransform (vtkAbstractTransform *transform)
 
virtual void ApplyTransformMatrix (vtkMatrix4x4 *transformMatrix)
 
virtual bool CanApplyNonLinearTransforms () const
 
vtkMRMLNodeCreateNodeInstance () override=0
 MRMLNode methods. More...
 
virtual const char * GetClassName ()
 
const char * GetNodeTagName () override=0
 
Get node XML tag name (like Volume, Model) More...
 
vtkMRMLTransformNodeGetParentTransformNode ()
 
Associated transform MRML node More...
 
const char * GetTransformNodeID ()
 Get referenced transform node id. More...
 
bool HardenTransform ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *, unsigned long, void *) override
 
alternative method to propagate events generated in Transform nodes More...
 
void ReadXMLAttributes (const char **atts) override
 
Read node attributes from XML file More...
 
bool SetAndObserveTransformNodeID (const char *transformNodeID)
 
virtual void TransformPointFromWorld (const double inWorld[3], double outLocal[3])
 
virtual void TransformPointFromWorld (const vtkVector3d &inWorld, vtkVector3d &outLocal)
 
virtual void TransformPointToWorld (const double inLocal[3], double outWorld[3])
 
virtual void TransformPointToWorld (const vtkVector3d &inLocal, vtkVector3d &outWorld)
 
void WriteXML (ostream &of, int indent) override
 
Write this node's information to a MRML file in XML format. More...
 
- Public Member Functions inherited from vtkMRMLStorableNode
void AddAndObserveStorageNodeID (const char *storageNodeID)
 
virtual bool AddDefaultStorageNode (const char *filename=nullptr)
 
void Copy (vtkMRMLNode *node) override
 Copy node contents from another node of the same type. Reimplemented to copy default sequence storage node class. More...
 
virtual vtkMRMLStorageNodeCreateDefaultSequenceStorageNode ()
 
virtual vtkMRMLStorageNodeCreateDefaultStorageNode ()
 
virtual std::string GetDefaultSequenceStorageNodeClassName ()
 
virtual std::string GetDefaultStorageNodeClassName (const char *filename=nullptr)
 
virtual bool GetModifiedSinceRead ()
 
vtkMRMLStorageNodeGetNthStorageNode (int n)
 
Get associated display MRML node More...
 
const char * GetNthStorageNodeID (int n)
 
int GetNumberOfStorageNodes ()
 
const char * GetSlicerDataType ()
 
vtkMRMLStorageNodeGetStorageNode ()
 
const char * GetStorageNodeID ()
 
virtual vtkTagTableGetUserTagTable ()
 Methods for user-specified metadata. More...
 
bool HasStorageNodeID (const char *storageNodeID)
 
Return true if storageNodeID is in the storage node ID list. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)
 
void SetAndObserveStorageNodeID (const char *storageNodeID)
 
String ID of the storage MRML node More...
 
virtual void SetDefaultSequenceStorageNodeClassName (std::string)
 
void SetSlicerDataType (const char *type)
 
virtual void StorableModified ()
 
void UpdateScene (vtkMRMLScene *scene) override
 
Finds the storage node and read the data More...
 
 vtkMRMLCopyContentMacro (vtkMRMLStorableNode)
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeAddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Convenience method that adds a referencedNodeID at the end of the list. More...
 
void AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr)
 Add a referenceRole. More...
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
virtual void 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 ()
 
int GetCustomModifiedEventPending (int eventId)
 
virtual char * GetDescription ()
 
virtual int GetDisableModifiedEvent ()
 Turn on/off generating InvokeEvent for set macros. More...
 
virtual int GetHideFromEditors ()
 Describes if the node is hidden. More...
 
virtual char * GetID ()
 ID use by other nodes to reference this node in XML. More...
 
virtual int GetInMRMLCallbackFlag ()
 Flags to avoid event loops. More...
 
virtual int GetModifiedEventPending ()
 
virtual char * GetName ()
 
vtkMRMLNodeGetNodeReference (const char *referenceRole)
 
const char * GetNodeReferenceID (const char *referenceRole)
 Utility function that returns the first node id for a specific referenceRole. More...
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs)
 Return a list of the referenced node IDs. More...
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes)
 Return a list of the referenced nodes. More...
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole. More...
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role. More...
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceRoles ()
 
int GetNumberOfNodeReferences (const char *referenceRole)
 Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...
 
virtual int GetSaveWithScene ()
 Save node with MRML scene. More...
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
virtual const char * GetTypeDisplayName ()
 
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)
 
vtkMRMLNodeSetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe the Nth node ID for a specific reference role. More...
 
void SetAttribute (const char *name, const char *value)
 Set a name value pair attribute. More...
 
virtual void SetDescription (const char *)
 Text description of this node, to be set by the user. More...
 
void SetDisableModifiedEvent (int onOff)
 
virtual void SetHideFromEditors (int)
 
void SetInMRMLCallbackFlag (int flag)
 
virtual void SetName (const char *)
 Name of this node, to be set by the user. More...
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
 Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More...
 
virtual void SetSaveWithScene (int)
 
virtual void SetScene (vtkMRMLScene *scene)
 This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene. More...
 
virtual void SetSceneReferences ()
 Update the references of the node to the scene. More...
 
virtual void SetSelectable (int)
 
virtual void SetSelected (int)
 
void SetSingletonOff ()
 
void SetSingletonOn ()
 
virtual void SetSingletonTag (const char *)
 Tag that make this node a singleton in the scene. More...
 
virtual void SetUndoEnabled (bool)
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events. More...
 
virtual void UndoEnabledOff ()
 
virtual void UndoEnabledOn ()
 
virtual void UpdateReferenceID (const char *oldID, const char *newID)
 Update the stored reference to another node in the scene. More...
 
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 vtkMRMLTransformableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLStorableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLStorableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

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

Static Protected Attributes

static const char * TransformNodeReferenceMRMLAttributeName
 
static const char * TransformNodeReferenceRole
 
- Static Protected Attributes inherited from vtkMRMLStorableNode
static const char * StorageNodeReferenceMRMLAttributeName
 
static const char * StorageNodeReferenceRole
 

Additional Inherited Members

- Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string > AttributesType
 
typedef std::map< std::string, vtkSmartPointer< vtkIntArray > > NodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
- Protected Attributes inherited from vtkMRMLStorableNode
std::string DefaultSequenceStorageNodeClassName
 
std::string SlicerDataType
 
vtkTimeStamp StorableModifiedTime
 
vtkTagTableUserTagTable
 
- 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...
 
vtkObserverManagerMRMLObserverManager
 
char * Name {nullptr}
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene {true}
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable {1}
 
int Selected {0}
 
bool UndoEnabled {false}
 

Detailed Description

MRML node for representing a node with a transform.

A superclass for other nodes that can have a transform to parent node like volume, model and transformation nodes.

Definition at line 31 of file vtkMRMLTransformableNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 34 of file vtkMRMLTransformableNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

TransformModifiedEvent is send when the parent transform is modidied.

Enumerator
TransformModifiedEvent 

Definition at line 72 of file vtkMRMLTransformableNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLTransformableNode() [1/2]

vtkMRMLTransformableNode::vtkMRMLTransformableNode ( )
protected

◆ ~vtkMRMLTransformableNode()

vtkMRMLTransformableNode::~vtkMRMLTransformableNode ( )
overrideprotected

◆ vtkMRMLTransformableNode() [2/2]

vtkMRMLTransformableNode::vtkMRMLTransformableNode ( const vtkMRMLTransformableNode )
protected

Member Function Documentation

◆ ApplyTransform()

virtual void vtkMRMLTransformableNode::ApplyTransform ( vtkAbstractTransform *  transform)
virtual

◆ ApplyTransformMatrix()

virtual void vtkMRMLTransformableNode::ApplyTransformMatrix ( vtkMatrix4x4 *  transformMatrix)
virtual

Convenience function to allow transforming a node by specifying a transformation matrix.

See also
ApplyTransformMatrix, ApplyTransform

Reimplemented in vtkMRMLTransformNode, vtkMRMLVolumeNode, vtkMRMLSegmentationNode, and vtkMRMLAnnotationROINode.

◆ CanApplyNonLinearTransforms()

virtual bool vtkMRMLTransformableNode::CanApplyNonLinearTransforms ( ) const
virtual

Returns true if the transformable node can apply non-linear transforms. A transformable node is always expected to apply linear transforms.

See also
ApplyTransformMatrix, ApplyTransform

Reimplemented in vtkMRMLMarkupsNode, vtkMRMLTransformNode, vtkMRMLModelNode, vtkMRMLVolumeNode, vtkMRMLROINode, vtkMRMLSegmentationNode, and vtkMRMLAnnotationNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLTransformableNode::CreateNodeInstance ( )
overridepure virtual

◆ GetClassName()

virtual const char* vtkMRMLTransformableNode::GetClassName ( )
virtual

◆ GetNodeTagName()

const char* vtkMRMLTransformableNode::GetNodeTagName ( )
overridepure virtual

◆ GetParentTransformNode()

vtkMRMLTransformNode* vtkMRMLTransformableNode::GetParentTransformNode ( )


Associated transform MRML node

◆ GetTransformNodeID()

const char* vtkMRMLTransformableNode::GetTransformNodeID ( )

Get referenced transform node id.

◆ GetTransformNodeReferenceMRMLAttributeName()

virtual const char* vtkMRMLTransformableNode::GetTransformNodeReferenceMRMLAttributeName ( )
protectedvirtual

◆ GetTransformNodeReferenceRole()

virtual const char* vtkMRMLTransformableNode::GetTransformNodeReferenceRole ( )
protectedvirtual

◆ HardenTransform()

bool vtkMRMLTransformableNode::HardenTransform ( )

Apply the associated transform to the transformable node. Return true on success, false otherwise.

◆ IsA()

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

◆ IsTypeOf()

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

◆ OnNodeReferenceAdded()

void vtkMRMLTransformableNode::OnNodeReferenceAdded ( vtkMRMLNodeReference reference)
overrideprotectedvirtual


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

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLMarkupsCurveNode, and vtkMRMLVolumeNode.

◆ OnNodeReferenceModified()

void vtkMRMLTransformableNode::OnNodeReferenceModified ( vtkMRMLNodeReference reference)
overrideprotectedvirtual


Called when a node reference ID is modified.

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLMarkupsCurveNode, and vtkMRMLVolumeNode.

◆ OnNodeReferenceRemoved()

void vtkMRMLTransformableNode::OnNodeReferenceRemoved ( vtkMRMLNodeReference reference)
overrideprotectedvirtual


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

Reimplemented from vtkMRMLNode.

Reimplemented in vtkMRMLMarkupsCurveNode.

◆ OnTransformNodeReferenceChanged()

virtual void vtkMRMLTransformableNode::OnTransformNodeReferenceChanged ( vtkMRMLTransformNode transformNode)
protectedvirtual

Called when transform node reference added/modified/removed.

Reimplemented in vtkMRMLMarkupsNode, vtkMRMLMarkupsPlaneNode, and vtkMRMLMarkupsROINode.

◆ operator=()

void vtkMRMLTransformableNode::operator= ( const vtkMRMLTransformableNode )
protected

◆ PrintSelf()

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

◆ ProcessMRMLEvents()

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

◆ ReadXMLAttributes()

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

◆ SafeDownCast()

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

◆ SetAndObserveTransformNodeID()

bool vtkMRMLTransformableNode::SetAndObserveTransformNodeID ( const char *  transformNodeID)

Set a reference to transform node Returns true on success. The method will fail if a child transform of a transform node is attempted to be set as parent to prevent circular reference. If current node or new parent transform node is not added to the scene yet then circular reference is not checked and it is the developer's responsibility no child transform is set as parent.

◆ TransformPointFromWorld() [1/2]

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

Utility function to convert a point position in world coordinate system to markup node's coordinate system

See also
TransformPointToWorld, SetAndObserveTransformNodeID

◆ TransformPointFromWorld() [2/2]

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

Utility function to convert a point position in world coordinate system to markup node's coordinate system

See also
TransformPointToWorld, SetAndObserveTransformNodeID

◆ TransformPointToWorld() [1/2]

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

Utility function to convert a point position in the node's coordinate system to world coordinate system. Note for transform nodes: the node coordinate system is transformed by all the parent transforms, but not by the transform that is stored in the current node. To get all the transform, including that is stored in the current transform node, vtkMRMLTransformNode::GetTransformBetweenNodes() method can be used.

See also
TransformPointFromWorld, SetAndObserveTransformNodeID

◆ TransformPointToWorld() [2/2]

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

Utility function to convert a point position in the node's coordinate system to world coordinate system.

See also
TransformPointToWorld, SetAndObserveTransformNodeID

◆ WriteXML()

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

Member Data Documentation

◆ TransformNodeReferenceMRMLAttributeName

const char* vtkMRMLTransformableNode::TransformNodeReferenceMRMLAttributeName
staticprotected

Definition at line 124 of file vtkMRMLTransformableNode.h.

◆ TransformNodeReferenceRole

const char* vtkMRMLTransformableNode::TransformNodeReferenceRole
staticprotected

Definition at line 123 of file vtkMRMLTransformableNode.h.


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