Slicer  5.1
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
vtkMRMLMarkupsPlaneDisplayNode Class Reference

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

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

Public Types

enum  { ComponentPlane = vtkMRMLMarkupsDisplayNode::Component_Last, ComponentPlane_Last }
 
enum  {
  HandleLEdge, HandleREdge, HandlePEdge, HandleAEdge,
  HandleLPCorner, HandleRPCorner, HandleLACorner, HandleRACorner,
  HandlePlane_Last
}
 Indexes of the scale handles. More...
 
typedef vtkMRMLMarkupsDisplayNode Superclass
 
- Public Types inherited from vtkMRMLMarkupsDisplayNode
enum  ComponentType {
  ComponentNone = 0, ComponentControlPoint, ComponentCenterPoint, ComponentLine,
  ComponentPlane, ComponentRotationHandle, ComponentTranslationHandle, ComponentScaleHandle,
  Component_Last
}
 
typedef vtkMRMLDisplayNode Superclass
 
enum  SnapModes { SnapModeUnconstrained, SnapModeToVisibleSurface, SnapMode_Last }
 Define how points are placed and moved in views. More...
 
enum  GlyphShapes {
  GlyphTypeInvalid = 0, StarBurst2D, Cross2D, CrossDot2D,
  ThickCross2D, Dash2D, Sphere3D, Vertex2D,
  Circle2D, Triangle2D, Square2D, Diamond2D,
  Arrow2D, ThickArrow2D, HookedArrow2D, GlyphType_Last
}
 
enum  {
  ResetToDefaultsEvent = 19001, JumpToPointEvent, ActionEvent, CustomActionEvent1,
  CustomActionEvent2, CustomActionEvent3, CustomActionEvent4, CustomActionEvent5,
  CustomActionEvent6
}
 
enum  CurveLineSizeModes { UseLineThickness = 0, UseLineDiameter, CurveLineSizeMode_Last }
 
- Public Types inherited from vtkMRMLDisplayNode
enum  { MenuEvent = 16100 }
 
enum  InterpolationType { FlatInterpolation = 0, GouraudInterpolation, PhongInterpolation, PBRInterpolation }
 
enum  RepresentationType { PointsRepresentation = 0, WireframeRepresentation, SurfaceRepresentation }
 
enum  ScalarRangeFlagType {
  UseManualScalarRange = 0, UseDataScalarRange, UseColorNodeScalarRange, UseDataTypeScalarRange,
  UseDirectMapping, NUM_SCALAR_RANGE_FLAGS
}
 
enum  ShowModeType { ShowDefault = 0, ShowIgnore, ShowMode_Last }
 Enumerated values for ShowMode. More...
 
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
 Create instance of the default node. Like New only virtual. More...
 
virtual const char * GetClassName ()
 
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Markups) More...
 
virtual int IsA (const char *type)
 
 vtkMRMLCopyContentDefaultMacro (vtkMRMLMarkupsPlaneDisplayNode)
 
virtual void SetNormalVisibility (bool)
 Get/Set the visibility of the plane normal arrow. More...
 
virtual bool GetNormalVisibility ()
 
virtual void NormalVisibilityOn ()
 
virtual void NormalVisibilityOff ()
 
virtual void SetNormalOpacity (double)
 Get/Set the opacity of the plane normal arrow. More...
 
virtual double GetNormalOpacity ()
 
- Public Member Functions inherited from vtkMRMLMarkupsDisplayNode
int GetActiveComponentIndex (std::string context=vtkMRMLMarkupsDisplayNode::GetDefaultContextName())
 
std::vector< std::string > GetActiveComponentInteractionContexts ()
 
int GetActiveComponentType (std::string context=vtkMRMLMarkupsDisplayNode::GetDefaultContextName())
 
int GetActiveControlPoint (std::string context=vtkMRMLMarkupsDisplayNode::GetDefaultContextName())
 
void GetActiveControlPoints (std::vector< int > &controlPointIndices)
 
virtual vtkDataArray * GetActiveScalarArray () override
 Return the current active scalar array (based on active scalar name and location) More...
 
virtual bool GetCanDisplayScaleHandles ()
 Get flag indicating if the markups node can display scale handles. More...
 
vtkMRMLMarkupsNodeGetMarkupsNode ()
 Convenience function for getting the displayable markups node. More...
 
virtual vtkDataSet * GetScalarDataSet () override
 
virtual double GetTextScale ()
 Set the text scale of the associated text. More...
 
bool HasActiveComponent ()
 Query if there is an active component for any interaction context. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *, unsigned long, void *) override
 Alternative method to propagate events generated in Display nodes. More...
 
void ReadXMLAttributes (const char **atts) override
 Read node attributes from XML (MRML) file. More...
 
void SetActiveComponent (int componentType, int componentIndex, std::string context=vtkMRMLMarkupsDisplayNode::GetDefaultContextName())
 Set active component type and index for interaction context (empty by default, meaning mouse) More...
 
void SetActiveControlPoint (int controlPointIndex)
 Set active component index to the provided value and component type to ComponentControlPoint. More...
 
virtual void SetScalarVisibility (int visibility) override
 
virtual void SetTextScale (double)
 
int UpdateActiveControlPointWorld (int controlPointIndex, vtkMRMLInteractionEventData *eventData, double accurateWorldOrientationMatrix[9], const char *viewNodeID, const char *associatedNodeID, int positionStatus)
 
virtual void UpdateAssignedAttribute () override
 Update scalar range and update markups pipeline when the active scalar array is changed. More...
 
void UpdateScene (vtkMRMLScene *scene) override
 Finds the storage node and read the data. More...
 
 vtkMRMLCopyContentMacro (vtkMRMLMarkupsDisplayNode)
 
void WriteXML (ostream &of, int indent) override
 Write this node's information to a MRML file in XML format. More...
 
virtual void SetPointLabelsVisibility (bool)
 
virtual bool GetPointLabelsVisibility ()
 
virtual void PointLabelsVisibilityOn ()
 
virtual void PointLabelsVisibilityOff ()
 
virtual void SetPropertiesLabelVisibility (bool)
 
virtual bool GetPropertiesLabelVisibility ()
 
virtual void PropertiesLabelVisibilityOn ()
 
virtual void PropertiesLabelVisibilityOff ()
 
virtual void SetInteractionHandleScale (double)
 
virtual double GetInteractionHandleScale ()
 
virtual void SetRotationHandleComponentVisibility (bool, bool, bool, bool)
 
virtual void SetRotationHandleComponentVisibility (bool [4])
 
virtual bool * GetRotationHandleComponentVisibility ()
 
virtual void GetRotationHandleComponentVisibility (bool &, bool &, bool &, bool &)
 
virtual void GetRotationHandleComponentVisibility (bool [4])
 
virtual void SetScaleHandleComponentVisibility (bool, bool, bool, bool)
 
virtual void SetScaleHandleComponentVisibility (bool [4])
 
virtual bool * GetScaleHandleComponentVisibility ()
 
virtual void GetScaleHandleComponentVisibility (bool &, bool &, bool &, bool &)
 
virtual void GetScaleHandleComponentVisibility (bool [4])
 
virtual void SetTranslationHandleComponentVisibility (bool, bool, bool, bool)
 
virtual void SetTranslationHandleComponentVisibility (bool [4])
 
virtual bool * GetTranslationHandleComponentVisibility ()
 
virtual void GetTranslationHandleComponentVisibility (bool &, bool &, bool &, bool &)
 
virtual void GetTranslationHandleComponentVisibility (bool [4])
 
virtual void SetFillVisibility (bool)
 
virtual bool GetFillVisibility ()
 
virtual void FillVisibilityOn ()
 
virtual void FillVisibilityOff ()
 
virtual void SetOutlineVisibility (bool)
 
virtual bool GetOutlineVisibility ()
 
virtual void OutlineVisibilityOn ()
 
virtual void OutlineVisibilityOff ()
 
virtual void SetFillOpacity (double)
 
virtual double GetFillOpacity ()
 
virtual void FillOpacityOn ()
 
virtual void FillOpacityOff ()
 
virtual void SetOutlineOpacity (double)
 
virtual double GetOutlineOpacity ()
 
virtual void OutlineOpacityOn ()
 
virtual void OutlineOpacityOff ()
 
virtual void SetGlyphType (int)
 The glyph type used to display this fiducial. More...
 
virtual int GetGlyphType ()
 
int GlyphTypeIs3D (int glyphType)
 Returns 1 if the type is a 3d one, 0 else. More...
 
int GlyphTypeIs3D ()
 
const char * GetGlyphTypeAsString ()
 Return a string representing the glyph type, set it from a string. More...
 
void SetGlyphTypeFromString (const char *glyphString)
 
virtual void SetSnapMode (int)
 
virtual int GetSnapMode ()
 
virtual void SetGlyphScale (double)
 
virtual double GetGlyphScale ()
 
virtual void SetGlyphSize (double)
 
virtual double GetGlyphSize ()
 
virtual void SetUseGlyphScale (bool)
 
virtual bool GetUseGlyphScale ()
 
virtual void UseGlyphScaleOn ()
 
virtual void UseGlyphScaleOff ()
 
virtual void SetSliceProjection (bool)
 
virtual bool GetSliceProjection ()
 
virtual void SliceProjectionOn ()
 
virtual void SliceProjectionOff ()
 
virtual void SetSliceProjectionUseFiducialColor (bool)
 
virtual bool GetSliceProjectionUseFiducialColor ()
 
virtual void SliceProjectionUseFiducialColorOn ()
 
virtual void SliceProjectionUseFiducialColorOff ()
 
virtual void SetSliceProjectionOutlinedBehindSlicePlane (bool)
 
virtual bool GetSliceProjectionOutlinedBehindSlicePlane ()
 
virtual void SliceProjectionOutlinedBehindSlicePlaneOn ()
 
virtual void SliceProjectionOutlinedBehindSlicePlaneOff ()
 
virtual void SetSliceProjectionColor (double, double, double)
 
virtual void SetSliceProjectionColor (double [3])
 
virtual double * GetSliceProjectionColor ()
 
virtual void GetSliceProjectionColor (double &, double &, double &)
 
virtual void GetSliceProjectionColor (double [3])
 
virtual void SetSliceProjectionOpacity (double)
 
virtual double GetSliceProjectionOpacity ()
 
virtual void SetCurveLineSizeMode (int)
 
virtual int GetCurveLineSizeMode ()
 
const char * GetCurveLineSizeModeAsString ()
 
void SetCurveLineSizeModeFromString (const char *modeString)
 
virtual double GetLineThickness ()
 
virtual void SetLineThickness (double)
 
virtual double GetLineDiameter ()
 
virtual void SetLineDiameter (double)
 
virtual double GetLineColorFadingStart ()
 
virtual void SetLineColorFadingStart (double)
 
virtual double GetLineColorFadingEnd ()
 
virtual void SetLineColorFadingEnd (double)
 
virtual void SetLineColorFadingSaturation (double)
 
virtual double GetLineColorFadingSaturation ()
 
virtual void SetLineColorFadingHueOffset (double)
 
virtual double GetLineColorFadingHueOffset ()
 
virtual void SetLineColorNodeID (const char *lineColorNodeID)
 
const char * GetLineColorNodeID ()
 Get the line color node ID used for the projection on the line actors on the 2D viewers. More...
 
vtkMRMLProceduralColorNodeGetLineColorNode ()
 Get the line color node used for the projection on the line actors on the 2D viewers. More...
 
virtual const char * GetLineColorNodeReferenceRole ()
 
virtual bool GetOccludedVisibility ()
 
virtual void SetOccludedVisibility (bool)
 
virtual void OccludedVisibilityOn ()
 
virtual void OccludedVisibilityOff ()
 
virtual double GetOccludedOpacity ()
 
virtual void SetOccludedOpacity (double)
 
virtual vtkTextProperty * GetTextProperty ()
 
virtual void SetActiveColor (double, double, double)
 Set the active color of the markup. This color is used when the mouse pointer hovers over a markup. More...
 
virtual void SetActiveColor (double [3])
 
virtual double * GetActiveColor ()
 Get the active color of the markup. This color is used when the mouse pointer hovers over a markup. More...
 
virtual void GetActiveColor (double &, double &, double &)
 
virtual void GetActiveColor (double [3])
 
virtual bool GetHandlesInteractive ()
 The visibility and interactability of the interaction handles. More...
 
virtual void SetHandlesInteractive (bool)
 
virtual void HandlesInteractiveOn ()
 
virtual void HandlesInteractiveOff ()
 
virtual bool GetTranslationHandleVisibility ()
 
virtual void SetTranslationHandleVisibility (bool)
 
virtual void TranslationHandleVisibilityOn ()
 
virtual void TranslationHandleVisibilityOff ()
 
virtual bool GetRotationHandleVisibility ()
 
virtual void SetRotationHandleVisibility (bool)
 
virtual void RotationHandleVisibilityOn ()
 
virtual void RotationHandleVisibilityOff ()
 
virtual bool GetScaleHandleVisibility ()
 
virtual void SetScaleHandleVisibility (bool)
 
virtual void ScaleHandleVisibilityOn ()
 
virtual void ScaleHandleVisibilityOff ()
 
void SetHandleVisibility (int handleType, bool visibility)
 
bool GetHandleVisibility (int handleType)
 
- Public Member Functions inherited from vtkMRMLDisplayNode
void AddViewNodeID (const char *viewNodeID)
 
void AutoScalarRangeOff ()
 
void AutoScalarRangeOn ()
 
virtual void ClippingOff ()
 
virtual void ClippingOn ()
 
virtual void EdgeVisibilityOff ()
 
virtual void EdgeVisibilityOn ()
 
virtual void FolderDisplayOverrideAllowedOff ()
 
virtual void FolderDisplayOverrideAllowedOn ()
 
virtual int GetActiveAttributeLocation ()
 
const char * GetActiveAttributeLocationAsString ()
 
virtual char * GetActiveScalarName ()
 
virtual double GetAmbient ()
 
int GetAutoScalarRange ()
 
virtual int GetClipping ()
 
virtual void GetColor (double [3])
 
virtual void GetColor (double &, double &, double &)
 
virtual double * GetColor ()
 
virtual vtkMRMLColorNodeGetColorNode ()
 
virtual char * GetColorNodeID ()
 
virtual double GetDiffuse ()
 
virtual vtkMRMLDisplayableNodeGetDisplayableNode ()
 
virtual double * GetEdgeColor ()
 
virtual void GetEdgeColor (double &, double &, double &)
 
virtual void GetEdgeColor (double [3])
 
virtual int GetEdgeVisibility ()
 
virtual bool GetFolderDisplayOverrideAllowed ()
 
virtual int GetInterpolateTexture ()
 
virtual int GetInterpolation ()
 
virtual int GetLighting ()
 
virtual double GetLineWidth ()
 
const char * GetNthViewNodeID (unsigned int index)
 
int GetNumberOfViewNodeIDs () const
 
virtual double GetOpacity ()
 
virtual double GetPointSize ()
 
virtual double GetPower ()
 
virtual int GetRepresentation ()
 
virtual double * GetScalarRange ()
 
virtual void GetScalarRange (double &, double &)
 
virtual void GetScalarRange (double [2])
 
virtual int GetScalarRangeFlag ()
 
const char * GetScalarRangeFlagAsString ()
 
virtual int GetScalarVisibility ()
 
virtual double GetSelectedAmbient ()
 
virtual double * GetSelectedColor ()
 
virtual void GetSelectedColor (double &, double &, double &)
 
virtual void GetSelectedColor (double [3])
 
virtual double GetSelectedSpecular ()
 
virtual int GetShading ()
 
virtual double GetSliceIntersectionOpacity ()
 
virtual int GetSliceIntersectionThickness ()
 
int GetSliceIntersectionVisibility ()
 
virtual double GetSpecular ()
 
virtual int GetTensorVisibility ()
 
virtual vtkAlgorithmOutput * GetTextureImageDataConnection ()
 
virtual int GetVectorVisibility ()
 
std::vector< std::string > GetViewNodeIDs () const
 
virtual int GetVisibility ()
 
virtual bool GetVisibility (const char *viewNodeID)
 
virtual int GetVisibility2D ()
 
virtual int GetVisibility3D ()
 
virtual void InterpolateTextureOff ()
 
virtual void InterpolateTextureOn ()
 
bool IsDisplayableInView (const char *viewNodeID) const
 
bool IsViewNodeIDPresent (const char *viewNodeID) const
 
virtual void LightingOff ()
 
virtual void LightingOn ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void RemoveAllViewNodeIDs ()
 
void RemoveViewNodeID (char *viewNodeID)
 
virtual void ScalarVisibilityOff ()
 
virtual void ScalarVisibilityOn ()
 
virtual void SetActiveAttributeLocation (int)
 
void SetActiveAttributeLocationFromString (const char *str)
 
virtual void SetActiveScalar (const char *scalarName, int location)
 
virtual void SetActiveScalarName (const char *)
 
virtual void SetAmbient (double)
 
virtual void SetAndObserveColorNodeID (const char *ColorNodeID)
 
void SetAndObserveColorNodeID (const std::string &ColorNodeID)
 
void SetAutoScalarRange (int b)
 
virtual void SetClipping (int)
 
virtual void SetColor (double, double, double)
 
virtual void SetColor (double [3])
 
virtual void SetDiffuse (double)
 
void SetDisplayableOnlyInView (const char *viewNodeID)
 
virtual void SetEdgeColor (double, double, double)
 
virtual void SetEdgeColor (double [3])
 
virtual void SetEdgeVisibility (int)
 
virtual void SetFolderDisplayOverrideAllowed (bool)
 
virtual void SetInterpolateTexture (int)
 
virtual void SetInterpolation (int)
 
virtual void SetLighting (int)
 
virtual void SetLineWidth (double)
 
virtual void SetOpacity (double)
 
virtual void SetPointSize (double)
 
virtual void SetPower (double)
 
virtual void SetRepresentation (int)
 
virtual void SetScalarRange (double, double)
 
void SetScalarRange (double [2])
 
virtual void SetScalarRangeFlag (int flag)
 
void SetScalarRangeFlagFromString (const char *str)
 
void SetSceneReferences () override
 Mark the color and views nodes as references. More...
 
virtual void SetSelectedAmbient (double)
 
virtual void SetSelectedColor (double, double, double)
 
virtual void SetSelectedColor (double [3])
 
virtual void SetSelectedSpecular (double)
 
virtual void SetShading (int)
 
virtual void SetSliceIntersectionOpacity (double)
 
virtual void SetSliceIntersectionThickness (int)
 
void SetSliceIntersectionVisibility (int on)
 
virtual void SetSpecular (double)
 
virtual void SetTensorVisibility (int)
 
virtual void SetTextureImageDataConnection (vtkAlgorithmOutput *ImageDataConnection)
 
virtual void SetVectorVisibility (int)
 
void SetViewNodeIDs (const std::vector< std::string > &viewNodeIDs)
 
virtual void SetVisibility (int)
 
virtual void SetVisibility2D (int)
 
virtual void SetVisibility3D (int)
 
void SliceIntersectionVisibilityOff ()
 
void SliceIntersectionVisibilityOn ()
 
virtual void TensorVisibilityOff ()
 
virtual void TensorVisibilityOn ()
 
void UpdateReferenceID (const char *oldID, const char *newID) override
 Update the stored reference to another node in the scene. More...
 
void UpdateReferences () override
 
virtual void UpdateScalarRange ()
 
virtual void VectorVisibilityOff ()
 
virtual void VectorVisibilityOn ()
 
virtual void Visibility2DOff ()
 
virtual void Visibility2DOn ()
 
virtual void Visibility3DOff ()
 
virtual void Visibility3DOn ()
 
virtual void VisibilityOff ()
 
virtual void VisibilityOn ()
 
 vtkMRMLCopyContentMacro (vtkMRMLDisplayNode)
 
virtual void SetMetallic (double)
 
virtual double GetMetallic ()
 
virtual void SetRoughness (double)
 
virtual double GetRoughness ()
 
virtual void SetFrontfaceCulling (int)
 
virtual int GetFrontfaceCulling ()
 
virtual void FrontfaceCullingOn ()
 
virtual void FrontfaceCullingOff ()
 
virtual void SetBackfaceCulling (int)
 
virtual int GetBackfaceCulling ()
 
virtual void BackfaceCullingOn ()
 
virtual void BackfaceCullingOff ()
 
virtual void SetShowMode (int)
 
virtual int GetShowMode ()
 
bool IsShowModeDefault ()
 
- 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 Copy (vtkMRMLNode *node)
 Copy node contents from another node of the same type. Does not copy node ID and Scene. Performs deep copy - an independent copy is created from all data, including bulk data. More...
 
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 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 ()
 
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 vtkMRMLMarkupsPlaneDisplayNodeNew ()
 
static vtkMRMLMarkupsPlaneDisplayNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLMarkupsDisplayNode
static const std::string GetDefaultContextName ()
 Get name of the default interaction context (typically the mouse) More...
 
static int IsTypeOf (const char *type)
 
static vtkMRMLMarkupsDisplayNodeNew ()
 
static vtkMRMLMarkupsDisplayNodeSafeDownCast (vtkObject *o)
 
static int GetMinimumGlyphType ()
 Return the min/max glyph types, for iterating over them in tcl. More...
 
static int GetMaximumGlyphType ()
 
static const char * GetGlyphTypeAsString (int g)
 
static int GetGlyphTypeFromString (const char *)
 
static const char * GetSnapModeAsString (int g)
 
static int GetSnapModeFromString (const char *)
 
static const char * GetCurveLineSizeModeAsString (int mode)
 
static int GetCurveLineSizeModeFromString (const char *)
 
- Static Public Member Functions inherited from vtkMRMLDisplayNode
static const char * GetAttributeLocationAsString (int id)
 Converts attribute location (point or cell data) to string. More...
 
static int GetAttributeLocationFromString (const char *name)
 Gets attribute location (point or cell data) from string. More...
 
static const char * GetScalarRangeFlagTypeAsString (int flag)
 
static int GetScalarRangeFlagTypeFromString (const char *name)
 Gets scalar range flag type from string. More...
 
static std::string GetTextPropertyAsString (vtkTextProperty *property)
 
static int IsTypeOf (const char *type)
 
static vtkMRMLDisplayNodeSafeDownCast (vtkObject *o)
 
static void UpdateTextPropertyFromString (std::string inputString, vtkTextProperty *property)
 
static const char * GetShowModeAsString (int flag)
 
static int GetShowModeFromString (const char *name)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

void operator= (const vtkMRMLMarkupsPlaneDisplayNode &)
 
 vtkMRMLMarkupsPlaneDisplayNode ()
 
 vtkMRMLMarkupsPlaneDisplayNode (const vtkMRMLMarkupsPlaneDisplayNode &)
 
 ~vtkMRMLMarkupsPlaneDisplayNode () override
 
- Protected Member Functions inherited from vtkMRMLMarkupsDisplayNode
virtual const char * GetLineColorNodeReferenceMRMLAttributeName ()
 
std::string GetTextPropertyAsString ()
 
void operator= (const vtkMRMLMarkupsDisplayNode &)
 
void SetTextPropertyFromString (std::string textPropertyString)
 
 vtkMRMLMarkupsDisplayNode ()
 
 vtkMRMLMarkupsDisplayNode (const vtkMRMLMarkupsDisplayNode &)
 
 ~vtkMRMLMarkupsDisplayNode () override
 
- Protected Member Functions inherited from vtkMRMLDisplayNode
void operator= (const vtkMRMLDisplayNode &)
 
virtual void SetColorNodeInternal (vtkMRMLColorNode *newColorNode)
 
 vtkMRMLDisplayNode ()
 
 vtkMRMLDisplayNode (const vtkMRMLDisplayNode &)
 
 ~vtkMRMLDisplayNode () 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...
 
virtual void OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
 
virtual void OnNodeReferenceModified (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is modified. More...
 
virtual void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
 Called when a referenced node pointer is removed (set to nullptr). 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...
 

Protected Attributes

double NormalOpacity { 1.0 }
 
bool NormalVisibility { true }
 
- Protected Attributes inherited from vtkMRMLMarkupsDisplayNode
double ActiveColor [3]
 
std::map< std::string, ComponentInfoActiveComponents
 
bool CanDisplayScaleHandles
 
int CurveLineSizeMode
 
double FillOpacity
 
bool FillVisibility
 
double GlyphScale
 
double GlyphSize
 
int GlyphType
 
bool HandlesInteractive
 
double InteractionHandleScale
 
double LineColorFadingEnd
 
double LineColorFadingHueOffset
 
double LineColorFadingSaturation
 
double LineColorFadingStart
 
double LineDiameter
 
double LineThickness
 
double OccludedOpacity
 
bool OccludedVisibility
 
double OutlineOpacity
 
bool OutlineVisibility
 
bool PointLabelsVisibility
 
bool PropertiesLabelVisibility
 
bool RotationHandleComponentVisibility [4]
 
bool RotationHandleVisibility
 
bool ScaleHandleComponentVisibility [4]
 
bool ScaleHandleVisibility
 
bool SliceProjection
 
double SliceProjectionColor [3]
 
double SliceProjectionOpacity
 
bool SliceProjectionOutlinedBehindSlicePlane
 
bool SliceProjectionUseFiducialColor
 
int SnapMode
 
vtkTextProperty * TextProperty
 
double TextScale
 
bool TranslationHandleComponentVisibility [4]
 
bool TranslationHandleVisibility
 
bool UseGlyphScale
 
- Protected Attributes inherited from vtkMRMLDisplayNode
int ActiveAttributeLocation
 
char * ActiveScalarName
 
double Ambient
 
int BackfaceCulling
 
int Clipping
 
double Color [3]
 
vtkMRMLColorNodeColorNode
 
char * ColorNodeID
 
double Diffuse
 
double EdgeColor [3]
 
int EdgeVisibility
 
bool FolderDisplayOverrideAllowed
 
int FrontfaceCulling
 
int InterpolateTexture
 
int Interpolation
 
vtkWeakPointer< vtkMRMLDisplayableNodeLastFoundDisplayableNode
 Cached value of last found displayable node (it is expensive to determine it) More...
 
int Lighting
 
double LineWidth
 
double Metallic
 
double Opacity
 
double PointSize
 
double Power
 
int Representation
 
double Roughness
 
double ScalarRange [2]
 
int ScalarRangeFlag
 
int ScalarVisibility
 
double SelectedAmbient
 
double SelectedColor [3]
 
double SelectedSpecular
 
int Shading
 
int ShowMode
 
double SliceIntersectionOpacity
 
int SliceIntersectionThickness
 
double Specular
 
int TensorVisibility
 
vtkAlgorithmOutput * TextureImageDataConnection
 
int VectorVisibility
 
std::vector< std::string > ViewNodeIDs
 
int Visibility
 
int Visibility2D
 
int Visibility3D
 
- 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 vtkMRMLDisplayNode
static void GetColorFromString (const std::string &colorString, double color[4])
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
- Static Protected Attributes inherited from vtkMRMLMarkupsDisplayNode
static const char * LineColorNodeReferenceMRMLAttributeName
 
static const char * LineColorNodeReferenceRole
 

Detailed Description

Definition at line 33 of file vtkMRMLMarkupsPlaneDisplayNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkMRMLMarkupsPlaneDisplayNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
ComponentPlane 
ComponentPlane_Last 

Definition at line 52 of file vtkMRMLMarkupsPlaneDisplayNode.h.

◆ anonymous enum

anonymous enum

Indexes of the scale handles.

Enumerator
HandleLEdge 
HandleREdge 
HandlePEdge 
HandleAEdge 
HandleLPCorner 
HandleRPCorner 
HandleLACorner 
HandleRACorner 
HandlePlane_Last 

Definition at line 59 of file vtkMRMLMarkupsPlaneDisplayNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLMarkupsPlaneDisplayNode() [1/2]

vtkMRMLMarkupsPlaneDisplayNode::vtkMRMLMarkupsPlaneDisplayNode ( )
protected

◆ ~vtkMRMLMarkupsPlaneDisplayNode()

vtkMRMLMarkupsPlaneDisplayNode::~vtkMRMLMarkupsPlaneDisplayNode ( )
overrideprotected

◆ vtkMRMLMarkupsPlaneDisplayNode() [2/2]

vtkMRMLMarkupsPlaneDisplayNode::vtkMRMLMarkupsPlaneDisplayNode ( const vtkMRMLMarkupsPlaneDisplayNode )
protected

Member Function Documentation

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLMarkupsPlaneDisplayNode::CreateNodeInstance ( )
overridevirtual

Create instance of the default node. Like New only virtual.

Note
Subclasses should implement this method

Reimplemented from vtkMRMLMarkupsDisplayNode.

◆ GetClassName()

virtual const char* vtkMRMLMarkupsPlaneDisplayNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLMarkupsDisplayNode.

◆ GetNodeTagName()

const char* vtkMRMLMarkupsPlaneDisplayNode::GetNodeTagName ( )
inlineoverridevirtual

Get node XML tag name (like Volume, Markups)

Reimplemented from vtkMRMLMarkupsDisplayNode.

Definition at line 46 of file vtkMRMLMarkupsPlaneDisplayNode.h.

◆ GetNormalOpacity()

virtual double vtkMRMLMarkupsPlaneDisplayNode::GetNormalOpacity ( )
virtual

◆ GetNormalVisibility()

virtual bool vtkMRMLMarkupsPlaneDisplayNode::GetNormalVisibility ( )
virtual

◆ IsA()

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

Reimplemented from vtkMRMLMarkupsDisplayNode.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLMarkupsPlaneDisplayNode* vtkMRMLMarkupsPlaneDisplayNode::New ( )
static

◆ NormalVisibilityOff()

virtual void vtkMRMLMarkupsPlaneDisplayNode::NormalVisibilityOff ( )
virtual

◆ NormalVisibilityOn()

virtual void vtkMRMLMarkupsPlaneDisplayNode::NormalVisibilityOn ( )
virtual

◆ operator=()

void vtkMRMLMarkupsPlaneDisplayNode::operator= ( const vtkMRMLMarkupsPlaneDisplayNode )
protected

◆ SafeDownCast()

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

◆ SetNormalOpacity()

virtual void vtkMRMLMarkupsPlaneDisplayNode::SetNormalOpacity ( double  )
virtual

Get/Set the opacity of the plane normal arrow.

◆ SetNormalVisibility()

virtual void vtkMRMLMarkupsPlaneDisplayNode::SetNormalVisibility ( bool  )
virtual

Get/Set the visibility of the plane normal arrow.

◆ vtkMRMLCopyContentDefaultMacro()

vtkMRMLMarkupsPlaneDisplayNode::vtkMRMLCopyContentDefaultMacro ( vtkMRMLMarkupsPlaneDisplayNode  )

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

See also
vtkMRMLNode::CopyContent

Member Data Documentation

◆ NormalOpacity

double vtkMRMLMarkupsPlaneDisplayNode::NormalOpacity { 1.0 }
protected

Definition at line 90 of file vtkMRMLMarkupsPlaneDisplayNode.h.

◆ NormalVisibility

bool vtkMRMLMarkupsPlaneDisplayNode::NormalVisibility { true }
protected

Definition at line 89 of file vtkMRMLMarkupsPlaneDisplayNode.h.


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