Slicer  4.13
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 | Protected Attributes
vtkMRMLMarkupsPlaneNode Class Reference

MRML node to represent a plane markup Plane Markups nodes contain three control points. Visualization parameters are set in the vtkMRMLMarkupsDisplayNode class. More...

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

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

Public Types

enum  { SizeModeAuto, SizeModeAbsolute, SizeMode_Last }
 
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

vtkMRMLNodeCreateNodeInstance () override
 MRMLNode methods. More...
 
virtual double GetAutoSizeScalingFactor ()
 
void GetAxes (double x[3], double y[3], double z[3])
 
void GetAxesWorld (double x[3], double y[3], double z[3])
 
virtual const char * GetClassName ()
 
double GetClosestPointOnPlaneWorld (const double posWorld[3], double closestPosWorld[3], bool infinitePlane=true)
 
const char * GetIcon () override
 
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Model) More...
 
void GetNormal (double normal[3])
 
void GetNormalWorld (double normal[3])
 
void GetOrigin (double origin[3])
 
void GetOriginWorld (double origin[3])
 
void GetPlaneBounds (double bounds[6])
 
virtual void GetPlaneToLocalMatrix (vtkMatrix4x4 *planeToLocalMatrix)
 
virtual vtkMatrix4x4 * GetPlaneToPlaneOffsetMatrix ()
 
virtual void GetPlaneToWorldMatrix (vtkMatrix4x4 *planeToWorldMatrix)
 
virtual int GetSizeMode ()
 
const char * GetSizeModeAsString (int sizeMode)
 
int GetSizeModeFromString (const char *sizeMode)
 
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...
 
virtual void SetAutoSizeScalingFactor (double)
 
void SetAxes (const double x[3], const double y[3], const double z[3])
 
void SetAxesWorld (const double x[3], const double y[3], const double z[3])
 
void SetNormal (const double normal[3])
 
void SetNormalWorld (const double normal[3])
 
void SetOrigin (const double origin[3])
 
void SetOriginWorld (const double origin[3])
 
virtual void SetPlaneBounds (double [6])
 
virtual void SetPlaneBounds (double, double, double, double, double, double)
 
virtual void SetSizeMode (int)
 
 vtkMRMLCopyContentMacro (vtkMRMLMarkupsPlaneNode)
 
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 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...
 
vtkMRMLStorageNodeCreateDefaultStorageNode () override
 Create default storage node or nullptr if does not have one. 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 ()
 
vtkCurveGeneratorGetCurveGenerator ()
 
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)
 
vtkMRMLMarkupsDisplayNodeGetMarkupsDisplayNode ()
 Return a cast display node, returns null if none. More...
 
virtual int GetMaximumNumberOfControlPoints ()
 
bool GetModifiedSinceRead () override
 
ControlPointGetNthControlPoint (int n)
 Return a pointer to the Nth control point stored in this node, null if n is out of bounds. More...
 
std::string GetNthControlPointAssociatedNodeID (int n=0)
 Get/Set the associated node id for the Nth control point. More...
 
ControlPointGetNthControlPointByID (const char *controlPointID)
 Get the Nth control point based on it's ID. More...
 
std::string GetNthControlPointDescription (int n=0)
 
std::string GetNthControlPointID (int n)
 Get the id for the Nth control point. More...
 
int GetNthControlPointIndexByID (const char *controlPointID)
 Get the Nth control point index based on it's ID. More...
 
std::string GetNthControlPointLabel (int n=0)
 
bool GetNthControlPointLocked (int n=0)
 
double * GetNthControlPointNormal (int n)
 Get normal direction (orientation of z axis) in local coordinate system. More...
 
void GetNthControlPointNormalWorld (int n, double normalWorld[3])
 Get normal direction (orientation of z axis) in world coordinate system. More...
 
void GetNthControlPointOrientation (int n, double orientationWXYZ[4])
 Get the WXYZ orientation for the Nth control point. More...
 
double * GetNthControlPointOrientationMatrix (int n)
 Get orientation as 9 values: x, y, and z axis directions, respectively. More...
 
vtkVector4d GetNthControlPointOrientationVector (int pointIndex)
 
void GetNthControlPointPosition (int pointIndex, double point[3])
 
double * GetNthControlPointPosition (int pointIndex)
 
int GetNthControlPointPositionStatus (int pointIndex)
 Get control point position status (PositionUndefined, PositionPreview, PositionDefined) More...
 
vtkVector3d GetNthControlPointPositionVector (int pointIndex)
 
int GetNthControlPointPositionWorld (int pointIndex, double worldxyz[3])
 
bool GetNthControlPointSelected (int n=0)
 
bool GetNthControlPointVisibility (int n=0)
 
std::string GetNthMarkupAssociatedNodeID (int n=0)
 
std::string GetNthMarkupID (int n=0)
 
std::string GetNthMarkupLabel (int n=0)
 
bool GetNthMarkupLocked (int n=0)
 
int GetNumberOfControlPoints ()
 Return the number of control points that are stored in this node. More...
 
int GetNumberOfDefinedControlPoints (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 ()
 
vtkMRMLUnitNodeGetUnitNode (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...
 
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...
 
virtual void UpdateAssignedAttribute ()
 
 vtkMRMLCopyContentMacro (vtkMRMLMarkupsNode)
 
void WriteCLI (std::vector< std::string > &commandLine, std::string prefix, int coordinateSystem=0, int multipleFlag=1) override
 
int GetNumberOfMeasurements ()
 
int GetNumberOfEnabledMeasurements ()
 
vtkMRMLMeasurementGetNthMeasurement (int id)
 
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)
 
vtkMRMLDisplayNodeGetDisplayNode ()
 
const char * GetDisplayNodeID ()
 
virtual const char * GetDisplayNodeReferenceRole ()
 
virtual int GetDisplayVisibility ()
 
vtkMRMLDisplayNodeGetNthDisplayNode (int n)
 
const char * GetNthDisplayNodeID (int n)
 
int GetNumberOfDisplayNodes ()
 
bool HasDisplayNodeID (const char *displayNodeID)
 
Return true if displayNodeID is in the display node ID list. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void RemoveAllDisplayNodeIDs ()
 
Remove all display node IDs and associated display nodes. More...
 
void RemoveNthDisplayNodeID (int n)
 
void SetAndObserveDisplayNodeID (const char *displayNodeID)
 
void SetAndObserveNthDisplayNodeID (int n, const char *displayNodeID)
 
virtual void SetDisplayClassVisibility (const char *nodeClass, int visible)
 
virtual void SetDisplayVisibility (int visible)
 
void SetSelectable (int) override
 
virtual void WriteCLI (std::vector< std::string > &vtkNotUsed(commandLine), std::string vtkNotUsed(prefix), int vtkNotUsed(coordinateSystemFlag)=0, int vtkNotUsed(multipleFlag)=1)
 
- Public Member Functions inherited from vtkMRMLTransformableNode
virtual void ApplyTransformMatrix (vtkMatrix4x4 *transformMatrix)
 
vtkMRMLTransformNodeGetParentTransformNode ()
 
Associated transform MRML node More...
 
const char * GetTransformNodeID ()
 Get referenced transform node id. More...
 
bool HardenTransform ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
bool SetAndObserveTransformNodeID (const char *transformNodeID)
 
virtual void TransformPointFromWorld (const double inWorld[3], double outLocal[3])
 
virtual void TransformPointFromWorld (const vtkVector3d &inWorld, vtkVector3d &outLocal)
 
virtual void TransformPointToWorld (const double inLocal[3], double outWorld[3])
 
virtual void TransformPointToWorld (const vtkVector3d &inLocal, vtkVector3d &outWorld)
 
- Public Member Functions inherited from vtkMRMLStorableNode
void AddAndObserveStorageNodeID (const char *storageNodeID)
 
virtual bool AddDefaultStorageNode (const char *filename=nullptr)
 
virtual vtkMRMLStorageNodeCreateDefaultSequenceStorageNode ()
 
virtual std::string GetDefaultStorageNodeClassName (const char *filename=nullptr)
 
vtkMRMLStorageNodeGetNthStorageNode (int n)
 
Get associated display MRML node More...
 
const char * GetNthStorageNodeID (int n)
 
int GetNumberOfStorageNodes ()
 
const char * GetSlicerDataType ()
 
vtkMRMLStorageNodeGetStorageNode ()
 
const char * GetStorageNodeID ()
 
virtual vtkTagTableGetUserTagTable ()
 Methods for user-specified metadata. More...
 
bool HasStorageNodeID (const char *storageNodeID)
 
Return true if storageNodeID is in the storage node ID list. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)
 
void SetAndObserveStorageNodeID (const char *storageNodeID)
 
String ID of the storage MRML node More...
 
void SetSlicerDataType (const char *type)
 
virtual void StorableModified ()
 
void UpdateScene (vtkMRMLScene *scene) override
 
Finds the storage node and read the data More...
 
 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 ()
 
virtual char * GetDescription ()
 
virtual int GetDisableModifiedEvent ()
 Turn on/off generating InvokeEvent for set macros. More...
 
virtual int GetHideFromEditors ()
 Describes if the node is hidden. More...
 
virtual char * GetID ()
 ID use by other nodes to reference this node in XML. More...
 
virtual int GetInMRMLCallbackFlag ()
 Flags to avoid event loops. More...
 
virtual int GetModifiedEventPending ()
 
virtual char * GetName ()
 
vtkMRMLNodeGetNodeReference (const char *referenceRole)
 
const char * GetNodeReferenceID (const char *referenceRole)
 Utility function that returns the first node id for a specific referenceRole. More...
 
void GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs)
 Return a list of the referenced node IDs. More...
 
void GetNodeReferenceRoles (std::vector< std::string > &roles)
 
void GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes)
 Return a list of the referenced nodes. More...
 
vtkMRMLNodeGetNthNodeReference (const char *referenceRole, int n)
 Get referenced MRML node for a specific referenceRole. More...
 
const char * GetNthNodeReferenceID (const char *referenceRole, int n)
 Return the string of the Nth node ID for a specific reference role. More...
 
const char * GetNthNodeReferenceRole (int n)
 
int GetNumberOfNodeReferenceRoles ()
 
int GetNumberOfNodeReferences (const char *referenceRole)
 Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...
 
virtual int GetSaveWithScene ()
 Save node with MRML scene. More...
 
virtual vtkMRMLSceneGetScene ()
 Get the scene this node has been added to. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
virtual bool GetUndoEnabled ()
 
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 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 vtkMRMLMarkupsPlaneNodeNew ()
 
static vtkMRMLMarkupsPlaneNodeSafeDownCast (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 vtkMRMLMarkupsNodeNew ()
 
static vtkMRMLMarkupsNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLDisplayableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLDisplayableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLTransformableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLTransformableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLStorableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLStorableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

void CalculateAxesFromPoints (const double point0[3], const double point1[3], const double point2[3], double x[3], double y[3], double z[3])
 Calculates the x y and z axis of the plane from the 3 input points. More...
 
void CreatePlane ()
 
void operator= (const vtkMRMLMarkupsPlaneNode &)
 
void UpdateInteractionHandleToWorldMatrix () override
 Calculates the handle to world matrix based on the current control points. More...
 
 vtkMRMLMarkupsPlaneNode ()
 
 vtkMRMLMarkupsPlaneNode (const vtkMRMLMarkupsPlaneNode &)
 
 ~vtkMRMLMarkupsPlaneNode () override
 
- Protected Member Functions inherited from vtkMRMLMarkupsNode
std::string GenerateControlPointLabel (int controlPointIndex)
 
std::string GenerateUniqueControlPointID ()
 
ControlPointGetNthControlPointCustomLog (int n, const char *failedMethodName)
 
void OnTransformNodeReferenceChanged (vtkMRMLTransformNode *transformNode) override
 Called when transform node reference added/modified/removed. More...
 
void operator= (const vtkMRMLMarkupsNode &)
 
bool SetControlPointLabelsWorld (vtkStringArray *labels, vtkPoints *points, std::string separator="")
 
void SetNthControlPointID (int n, std::string id)
 
virtual void UpdateCurvePolyFromControlPoints ()
 
void UpdateMeasurements ()
 Calls UpdateMeasurementsInternal() More...
 
virtual void UpdateMeasurementsInternal ()
 
 vtkMRMLMarkupsNode ()
 
 vtkMRMLMarkupsNode (const vtkMRMLMarkupsNode &)
 
virtual void WriteMeasurementsToDescription ()
 
 ~vtkMRMLMarkupsNode () override
 
- Protected Member Functions inherited from vtkMRMLDisplayableNode
virtual const char * GetDisplayNodeReferenceMRMLAttributeName ()
 
void OnNodeReferenceAdded (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is added (list size increased). More...
 
void OnNodeReferenceModified (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is modified. More...
 
void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) override
 
Called after a node reference ID is removed (list size decreased). More...
 
void operator= (const vtkMRMLDisplayableNode &)
 
 vtkMRMLDisplayableNode ()
 
 vtkMRMLDisplayableNode (const vtkMRMLDisplayableNode &)
 
 ~vtkMRMLDisplayableNode () override
 
- Protected Member Functions inherited from vtkMRMLTransformableNode
virtual const char * GetTransformNodeReferenceMRMLAttributeName ()
 
virtual const char * GetTransformNodeReferenceRole ()
 
void OnNodeReferenceAdded (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is added (list size increased). More...
 
void OnNodeReferenceModified (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is modified. More...
 
void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) override
 
Called after a node reference ID is removed (list size decreased). More...
 
void operator= (const vtkMRMLTransformableNode &)
 
 vtkMRMLTransformableNode ()
 
 vtkMRMLTransformableNode (const vtkMRMLTransformableNode &)
 
 ~vtkMRMLTransformableNode () override
 
- Protected Member Functions inherited from vtkMRMLStorableNode
virtual const char * GetStorageNodeReferenceMRMLAttributeName ()
 
virtual const char * GetStorageNodeReferenceRole ()
 
virtual vtkTimeStamp GetStoredTime ()
 
void operator= (const vtkMRMLStorableNode &)
 
 vtkMRMLStorableNode ()
 
 vtkMRMLStorableNode (const vtkMRMLStorableNode &)
 
 ~vtkMRMLStorableNode () override
 
- Protected Member Functions inherited from vtkMRMLNode
virtual const char * GetMRMLAttributeNameFromReferenceRole (const char *refRole)
 Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise. More...
 
virtual const char * GetReferenceRoleFromMRMLAttributeName (const char *attName)
 Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise. More...
 
virtual char * GetTempURLString ()
 
void GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents)
 
virtual void InvalidateNodeReferences ()
 
virtual bool IsReferenceRoleGeneric (const char *refRole)
 Return true if the reference role is generic (ends with '/') or false otherwise. More...
 
void operator= (const vtkMRMLNode &)
 
void ParseReferencesAttribute (const char *attValue, std::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...
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore)
 
virtual void UpdateNodeReferences (const char *referenceRole=nullptr)
 
virtual void UpdateNthNodeReference (const char *referenceRole, int n)
 
 vtkMRMLNode ()
 
 vtkMRMLNode (const vtkMRMLNode &)
 
 ~vtkMRMLNode () override
 critical to have a virtual destructor! More...
 

Protected Attributes

double AutoSizeScalingFactor
 
double PlaneBounds [6]
 
vtkSmartPointer< vtkMatrix4x4 > PlaneToPlaneOffsetMatrix
 
int SizeMode
 
- Protected Attributes inherited from vtkMRMLMarkupsNode
vtkVector3d CenterPos
 
ControlPointsListType ControlPoints
 Vector of control points. More...
 
bool CurveClosed
 
vtkSmartPointer< vtkFrenetSerretFrame > CurveCoordinateSystemGeneratorWorld
 
vtkSmartPointer< vtkCurveGeneratorCurveGenerator
 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
 Flag set from SetControlPointPositionsWorld that pauses update of measurements until the update is complete. More...
 
int LastUsedControlPointNumber
 
int Locked
 Locks all the points and GUI. More...
 
std::string MarkupLabelFormat
 
int MaximumNumberOfControlPoints
 Used for limiting number of markups that may be placed. More...
 
vtkCollection * Measurements
 List of measurements stored for the markup. More...
 
std::string PropertiesLabelText
 
int RequiredNumberOfControlPoints
 
vtkSmartPointer< vtkStringArray > TextList
 
vtkSmartPointer< vtkPointLocator > TransformedCurvePolyLocator
 
- Protected Attributes inherited from vtkMRMLStorableNode
std::string SlicerDataType
 
vtkTimeStamp StorableModifiedTime
 
vtkTagTableUserTagTable
 
- Protected Attributes inherited from vtkMRMLNode
int AddToScene {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}
 

Additional Inherited Members

- Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string > AttributesType
 
typedef std::map< std::string, vtkSmartPointer< vtkIntArray > > NodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
- Static Protected Attributes inherited from vtkMRMLDisplayableNode
static const char * DisplayNodeReferenceMRMLAttributeName
 
static const char * DisplayNodeReferenceRole
 
- Static Protected Attributes inherited from vtkMRMLTransformableNode
static const char * TransformNodeReferenceMRMLAttributeName
 
static const char * TransformNodeReferenceRole
 
- Static Protected Attributes inherited from vtkMRMLStorableNode
static const char * StorageNodeReferenceMRMLAttributeName
 
static const char * StorageNodeReferenceRole
 

Detailed Description

MRML node to represent a plane markup Plane Markups nodes contain three 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:

Definition at line 47 of file vtkMRMLMarkupsPlaneNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 51 of file vtkMRMLMarkupsPlaneNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SizeModeAuto 
SizeModeAbsolute 
SizeMode_Last 

Definition at line 61 of file vtkMRMLMarkupsPlaneNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLMarkupsPlaneNode() [1/2]

vtkMRMLMarkupsPlaneNode::vtkMRMLMarkupsPlaneNode ( )
protected

◆ ~vtkMRMLMarkupsPlaneNode()

vtkMRMLMarkupsPlaneNode::~vtkMRMLMarkupsPlaneNode ( )
overrideprotected

◆ vtkMRMLMarkupsPlaneNode() [2/2]

vtkMRMLMarkupsPlaneNode::vtkMRMLMarkupsPlaneNode ( const vtkMRMLMarkupsPlaneNode )
protected

Member Function Documentation

◆ CalculateAxesFromPoints()

void vtkMRMLMarkupsPlaneNode::CalculateAxesFromPoints ( const double  point0[3],
const double  point1[3],
const double  point2[3],
double  x[3],
double  y[3],
double  z[3] 
)
protected

Calculates the x y and z axis of the plane from the 3 input points.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLMarkupsPlaneNode::CreateNodeInstance ( )
overridevirtual

MRMLNode methods.

Reimplemented from vtkMRMLMarkupsNode.

◆ CreatePlane()

void vtkMRMLMarkupsPlaneNode::CreatePlane ( )
protected

Helper method for ensuring that the plane has enough points and that the points/vectors are not coincident. Used when calling SetNormal(), SetVectors() to ensure that the plane is valid before transforming to the new orientation.

◆ GetAutoSizeScalingFactor()

virtual double vtkMRMLMarkupsPlaneNode::GetAutoSizeScalingFactor ( )
virtual

The plane size multiplier used to calculate the size of the plane. This is only used when the size mode is auto. Default is 1.0.

◆ GetAxes()

void vtkMRMLMarkupsPlaneNode::GetAxes ( double  x[3],
double  y[3],
double  z[3] 
)

The direction vectors defined by the markup points. Calculated as follows and then transformed by the offset matrix: X: Vector from 1st to 0th point. Y: Cross product of the Z vector and X vectors. Z: Cross product of the X vector and the vector from the 2nd to 0th point.

◆ GetAxesWorld()

void vtkMRMLMarkupsPlaneNode::GetAxesWorld ( double  x[3],
double  y[3],
double  z[3] 
)

◆ GetClassName()

virtual const char* vtkMRMLMarkupsPlaneNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLMarkupsNode.

◆ GetClosestPointOnPlaneWorld()

double vtkMRMLMarkupsPlaneNode::GetClosestPointOnPlaneWorld ( const double  posWorld[3],
double  closestPosWorld[3],
bool  infinitePlane = true 
)

Get the closest position on the plane in world coordinates. Returns the signed distance from the input point to the plane. Positive distance is in the direction of the plane normal, and negative distance is in the opposite direction.

Parameters
posWorldinput position
closestPosWorldoutput found closest position
infinitePlaneif false, the closest position will be restricted to the plane bounds
Returns
Signed distance from the point to the plane. Positive distance is in the direction of the plane normal

◆ GetIcon()

const char* vtkMRMLMarkupsPlaneNode::GetIcon ( )
inlineoverridevirtual

Reimplemented from vtkMRMLMarkupsNode.

Definition at line 55 of file vtkMRMLMarkupsPlaneNode.h.

◆ GetNodeTagName()

const char* vtkMRMLMarkupsPlaneNode::GetNodeTagName ( )
inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Reimplemented from vtkMRMLMarkupsNode.

Definition at line 70 of file vtkMRMLMarkupsPlaneNode.h.

◆ GetNormal()

void vtkMRMLMarkupsPlaneNode::GetNormal ( double  normal[3])

The normal vector for the plane. Calculated as the vector perpendicular to the plane containing the 3 markup points, and transformed by the PlaneToPlaneOffsetMatrix.

◆ GetNormalWorld()

void vtkMRMLMarkupsPlaneNode::GetNormalWorld ( double  normal[3])

◆ GetOrigin()

void vtkMRMLMarkupsPlaneNode::GetOrigin ( double  origin[3])

The origin of the plane. Calculated as the location of the 0th markup point, and translated by the PlaneToPlaneOffsetMatrix.

◆ GetOriginWorld()

void vtkMRMLMarkupsPlaneNode::GetOriginWorld ( double  origin[3])

◆ GetPlaneBounds()

void vtkMRMLMarkupsPlaneNode::GetPlaneBounds ( double  bounds[6])

The bounds of the plane in the plane coordinate system. When the size mode is absolute, SetPlaneBounds can be used to specify the size of the plane. This is only used when the size mode is absolute.

◆ GetPlaneToLocalMatrix()

virtual void vtkMRMLMarkupsPlaneNode::GetPlaneToLocalMatrix ( vtkMatrix4x4 *  planeToLocalMatrix)
virtual

◆ GetPlaneToPlaneOffsetMatrix()

virtual vtkMatrix4x4* vtkMRMLMarkupsPlaneNode::GetPlaneToPlaneOffsetMatrix ( )
virtual

4x4 matrix detailing the offset (rotation/translation) of the plane from the plane defined by the markup points. Default is the identity matrix.

◆ GetPlaneToWorldMatrix()

virtual void vtkMRMLMarkupsPlaneNode::GetPlaneToWorldMatrix ( vtkMatrix4x4 *  planeToWorldMatrix)
virtual

◆ GetSizeMode()

virtual int vtkMRMLMarkupsPlaneNode::GetSizeMode ( )
virtual

◆ GetSizeModeAsString()

const char* vtkMRMLMarkupsPlaneNode::GetSizeModeAsString ( int  sizeMode)

◆ GetSizeModeFromString()

int vtkMRMLMarkupsPlaneNode::GetSizeModeFromString ( const char *  sizeMode)

◆ IsA()

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

Reimplemented from vtkMRMLMarkupsNode.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLMarkupsPlaneNode* vtkMRMLMarkupsPlaneNode::New ( )
static

◆ operator=()

void vtkMRMLMarkupsPlaneNode::operator= ( const vtkMRMLMarkupsPlaneNode )
protected

◆ PrintSelf()

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

Print out the node information to the output stream.

◆ ReadXMLAttributes()

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

Read node attributes from XML file.

Reimplemented from vtkMRMLMarkupsNode.

◆ SafeDownCast()

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

◆ SetAutoSizeScalingFactor()

virtual void vtkMRMLMarkupsPlaneNode::SetAutoSizeScalingFactor ( double  )
virtual

◆ SetAxes()

void vtkMRMLMarkupsPlaneNode::SetAxes ( const double  x[3],
const double  y[3],
const double  z[3] 
)

◆ SetAxesWorld()

void vtkMRMLMarkupsPlaneNode::SetAxesWorld ( const double  x[3],
const double  y[3],
const double  z[3] 
)

◆ SetNormal()

void vtkMRMLMarkupsPlaneNode::SetNormal ( const double  normal[3])

◆ SetNormalWorld()

void vtkMRMLMarkupsPlaneNode::SetNormalWorld ( const double  normal[3])

◆ SetOrigin()

void vtkMRMLMarkupsPlaneNode::SetOrigin ( const double  origin[3])

◆ SetOriginWorld()

void vtkMRMLMarkupsPlaneNode::SetOriginWorld ( const double  origin[3])

◆ SetPlaneBounds() [1/2]

virtual void vtkMRMLMarkupsPlaneNode::SetPlaneBounds ( double  [6])
virtual

◆ SetPlaneBounds() [2/2]

virtual void vtkMRMLMarkupsPlaneNode::SetPlaneBounds ( double  ,
double  ,
double  ,
double  ,
double  ,
double   
)
virtual

◆ SetSizeMode()

virtual void vtkMRMLMarkupsPlaneNode::SetSizeMode ( int  )
virtual

Method for calculating the size of the plane along the direction vectors. With size mode auto, the size of the plane is automatically calculated so that it ecompasses all of the points. Size mode absolute will never be recalculated. Default is SizeModeAuto.

◆ UpdateInteractionHandleToWorldMatrix()

void vtkMRMLMarkupsPlaneNode::UpdateInteractionHandleToWorldMatrix ( )
overrideprotectedvirtual

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

Reimplemented from vtkMRMLMarkupsNode.

◆ vtkMRMLCopyContentMacro()

vtkMRMLMarkupsPlaneNode::vtkMRMLCopyContentMacro ( vtkMRMLMarkupsPlaneNode  )

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

See also
vtkMRMLNode::CopyContent

◆ WriteXML()

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

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

Reimplemented from vtkMRMLMarkupsNode.

Member Data Documentation

◆ AutoSizeScalingFactor

double vtkMRMLMarkupsPlaneNode::AutoSizeScalingFactor
protected

Definition at line 151 of file vtkMRMLMarkupsPlaneNode.h.

◆ PlaneBounds

double vtkMRMLMarkupsPlaneNode::PlaneBounds[6]
protected

Definition at line 152 of file vtkMRMLMarkupsPlaneNode.h.

◆ PlaneToPlaneOffsetMatrix

vtkSmartPointer<vtkMatrix4x4> vtkMRMLMarkupsPlaneNode::PlaneToPlaneOffsetMatrix
protected

Definition at line 153 of file vtkMRMLMarkupsPlaneNode.h.

◆ SizeMode

int vtkMRMLMarkupsPlaneNode::SizeMode
protected

Definition at line 150 of file vtkMRMLMarkupsPlaneNode.h.


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