Slicer  4.13
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions
vtkMRMLMarkupsDisplayNode Class Reference

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

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

Classes

struct  ComponentInfo
 

Public Types

enum  ComponentType {
  ComponentNone = 0, ComponentControlPoint, ComponentCenterPoint, ComponentLine,
  ComponentPlane, ComponentRotationHandle, ComponentTranslationHandle, ComponentScaleHandle,
  Component_Last
}
 
typedef vtkMRMLDisplayNode Superclass
 
- Public Types inherited from vtkMRMLDisplayNode
enum  { MenuEvent = 16100 }
 
enum  InterpolationType { FlatInterpolation = 0, GouraudInterpolation, PhongInterpolation }
 
enum  RepresentationType { PointsRepresentation = 0, WireframeRepresentation, SurfaceRepresentation }
 
enum  ScalarRangeFlagType {
  UseManualScalarRange = 0, UseDataScalarRange, UseColorNodeScalarRange, UseDataTypeScalarRange,
  UseDirectMapping, NUM_SCALAR_RANGE_FLAGS
}
 
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...
 
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 const char * GetClassName ()
 
vtkMRMLMarkupsNodeGetMarkupsNode ()
 Convenience function for getting the displayable markups node. More...
 
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Markups) More...
 
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...
 
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 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 SetTextScale (double)
 
int UpdateActiveControlPointWorld (int controlPointIndex, vtkMRMLInteractionEventData *eventData, double accurateWorldOrientationMatrix[9], const char *viewNodeID, const char *associatedNodeID, int positionStatus)
 
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 ()
 
- 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)
 
virtual void SetScalarVisibility (int)
 
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 SetFrontfaceCulling (int)
 
virtual int GetFrontfaceCulling ()
 
virtual void FrontfaceCullingOn ()
 
virtual void FrontfaceCullingOff ()
 
virtual void SetBackfaceCulling (int)
 
virtual int GetBackfaceCulling ()
 
virtual void BackfaceCullingOn ()
 
virtual void BackfaceCullingOff ()
 
- 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 ()
 
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 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 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 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 int IsTypeOf (const char *type)
 
static vtkMRMLDisplayNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 
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 }
 
enum  CurveLineSizeModes { UseLineThickness = 0, UseLineDiameter, CurveLineSizeMode_Last }
 
std::map< std::string, ComponentInfoActiveComponents
 
int SnapMode
 
bool PropertiesLabelVisibility
 
bool PointLabelsVisibility
 
bool FillVisibility
 
bool OutlineVisibility
 
double FillOpacity
 
double OutlineOpacity
 
double TextScale
 
int GlyphType
 
double GlyphScale
 
double GlyphSize
 
bool UseGlyphScale
 
bool SliceProjection
 
bool SliceProjectionUseFiducialColor
 
bool SliceProjectionOutlinedBehindSlicePlane
 
double SliceProjectionColor [3]
 
double SliceProjectionOpacity
 
int CurveLineSizeMode
 
double LineThickness
 
double LineDiameter
 
double LineColorFadingStart
 
double LineColorFadingEnd
 
double LineColorFadingSaturation
 
double LineColorFadingHueOffset
 
bool OccludedVisibility
 
double OccludedOpacity
 
vtkTextProperty * TextProperty
 
double ActiveColor [3]
 
bool HandlesInteractive
 
static const char * LineColorNodeReferenceRole
 
static const char * LineColorNodeReferenceMRMLAttributeName
 
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 *)
 
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 vtkDataSet * GetScalarDataSet () override
 
virtual vtkDataArray * GetActiveScalarArray () override
 Return the current active scalar array (based on active scalar name and location) More...
 
virtual void UpdateAssignedAttribute () override
 Update scalar range and update markups pipeline when the active scalar array is changed. More...
 
 vtkMRMLMarkupsDisplayNode ()
 
 ~vtkMRMLMarkupsDisplayNode () override
 
 vtkMRMLMarkupsDisplayNode (const vtkMRMLMarkupsDisplayNode &)
 
void operator= (const vtkMRMLMarkupsDisplayNode &)
 
void SetTextPropertyFromString (std::string textPropertyString)
 
std::string GetTextPropertyAsString ()
 
virtual const char * GetLineColorNodeReferenceMRMLAttributeName ()
 
static std::string GetTextPropertyAsString (vtkTextProperty *property)
 
static void UpdateTextPropertyFromString (std::string inputString, vtkTextProperty *property)
 
static void GetColorFromString (const std::string &colorString, double color[4])
 

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
 
- 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)
 
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 Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
- 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 Opacity
 
double PointSize
 
double Power
 
int Representation
 
double ScalarRange [2]
 
int ScalarRangeFlag
 
int ScalarVisibility
 
double SelectedAmbient
 
double SelectedColor [3]
 
double SelectedSpecular
 
int Shading
 
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}
 

Detailed Description

Definition at line 45 of file vtkMRMLMarkupsDisplayNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 49 of file vtkMRMLMarkupsDisplayNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
ResetToDefaultsEvent 
JumpToPointEvent 

request jump to a selected control point, request completed by markups logic, event data is vtkMRMLInteractionEventData

ActionEvent 

default action on the point is requested (mapped to double-click by default), event data is vtkMRMLInteractionEventData

Definition at line 278 of file vtkMRMLMarkupsDisplayNode.h.

◆ ComponentType

Enumerator
ComponentNone 
ComponentControlPoint 
ComponentCenterPoint 
ComponentLine 
ComponentPlane 
ComponentRotationHandle 
ComponentTranslationHandle 
ComponentScaleHandle 
Component_Last 

Definition at line 90 of file vtkMRMLMarkupsDisplayNode.h.

◆ CurveLineSizeModes

Way of determining line radius of markup curves. Default is relative thickness Current mode is stored in

See also
CurveLineSizeMode
Enumerator
UseLineThickness 
UseLineDiameter 
CurveLineSizeMode_Last 

Definition at line 320 of file vtkMRMLMarkupsDisplayNode.h.

◆ GlyphShapes

Which kind of glyph should be used to display this markup? Vertex2D is supposed to start at 1

Enumerator
GlyphTypeInvalid 
StarBurst2D 
Cross2D 
CrossDot2D 
ThickCross2D 
Dash2D 
Sphere3D 
Vertex2D 
Circle2D 
Triangle2D 
Square2D 
Diamond2D 
Arrow2D 
ThickArrow2D 
HookedArrow2D 
GlyphType_Last 

Definition at line 213 of file vtkMRMLMarkupsDisplayNode.h.

◆ SnapModes

Define how points are placed and moved in views.

Enumerator
SnapModeUnconstrained 
SnapModeToVisibleSurface 
SnapMode_Last 

Definition at line 203 of file vtkMRMLMarkupsDisplayNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLMarkupsDisplayNode() [1/2]

vtkMRMLMarkupsDisplayNode::vtkMRMLMarkupsDisplayNode ( )
protected

◆ ~vtkMRMLMarkupsDisplayNode()

vtkMRMLMarkupsDisplayNode::~vtkMRMLMarkupsDisplayNode ( )
overrideprotected

◆ vtkMRMLMarkupsDisplayNode() [2/2]

vtkMRMLMarkupsDisplayNode::vtkMRMLMarkupsDisplayNode ( const vtkMRMLMarkupsDisplayNode )
protected

Member Function Documentation

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLMarkupsDisplayNode::CreateNodeInstance ( )
overridevirtual

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

Note
Subclasses should implement this method

Implements vtkMRMLNode.

Reimplemented in vtkMRMLMarkupsFiducialDisplayNode, and vtkMRMLMarkupsROIDisplayNode.

◆ FillOpacityOff()

virtual void vtkMRMLMarkupsDisplayNode::FillOpacityOff ( )
virtual

◆ FillOpacityOn()

virtual void vtkMRMLMarkupsDisplayNode::FillOpacityOn ( )
virtual

◆ FillVisibilityOff()

virtual void vtkMRMLMarkupsDisplayNode::FillVisibilityOff ( )
virtual

◆ FillVisibilityOn()

virtual void vtkMRMLMarkupsDisplayNode::FillVisibilityOn ( )
virtual

◆ GetActiveColor() [1/3]

virtual double* vtkMRMLMarkupsDisplayNode::GetActiveColor ( )
virtual

Get the active color of the markup. This color is used when the mouse pointer hovers over a markup.

◆ GetActiveColor() [2/3]

virtual void vtkMRMLMarkupsDisplayNode::GetActiveColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetActiveColor() [3/3]

virtual void vtkMRMLMarkupsDisplayNode::GetActiveColor ( double  [3])
virtual

◆ GetActiveComponentIndex()

int vtkMRMLMarkupsDisplayNode::GetActiveComponentIndex ( std::string  context = vtkMRMLMarkupsDisplayNode::GetDefaultContextName())

Index of active component (that the mouse or other interaction context is hovered over). This property is computed on-the-fly and saved to file.

Parameters
contextName of the interaction context. By default it is empty string, meaning mouse

◆ GetActiveComponentInteractionContexts()

std::vector<std::string> vtkMRMLMarkupsDisplayNode::GetActiveComponentInteractionContexts ( )

Get list of interaction context names that have active components

Returns
List of interaction context names that have active components

◆ GetActiveComponentType()

int vtkMRMLMarkupsDisplayNode::GetActiveComponentType ( std::string  context = vtkMRMLMarkupsDisplayNode::GetDefaultContextName())

Active component (that the mouse or other interaction context is hovered over). This property is computed on-the-fly and saved to file.

Parameters
contextName of the interaction context. By default it is empty string, meaning mouse. Additional devices, such as virtual reality controllers can specify additional context names. This mechanism allows interacting with multiple markups at the same time (user can grab different markup points with each controller at the same time).

◆ GetActiveControlPoint()

int vtkMRMLMarkupsDisplayNode::GetActiveControlPoint ( std::string  context = vtkMRMLMarkupsDisplayNode::GetDefaultContextName())

Returns index of active control point for interaction context if active component type is ComponentControlPoint, -1 otherwise.

Parameters
contextName of the interaction context. By default it is empty string, meaning mouse

◆ GetActiveControlPoints()

void vtkMRMLMarkupsDisplayNode::GetActiveControlPoints ( std::vector< int > &  controlPointIndices)

Returns index of active control point for all interaction contexts if active component type is ComponentControlPoint.

◆ GetActiveScalarArray()

virtual vtkDataArray* vtkMRMLMarkupsDisplayNode::GetActiveScalarArray ( )
overridevirtual

Return the current active scalar array (based on active scalar name and location)

Reimplemented from vtkMRMLDisplayNode.

◆ GetClassName()

virtual const char* vtkMRMLMarkupsDisplayNode::GetClassName ( )
virtual

◆ GetColorFromString()

static void vtkMRMLMarkupsDisplayNode::GetColorFromString ( const std::string &  colorString,
double  color[4] 
)
staticprotected

◆ GetCurveLineSizeMode()

virtual int vtkMRMLMarkupsDisplayNode::GetCurveLineSizeMode ( )
virtual

◆ GetCurveLineSizeModeAsString() [1/2]

const char* vtkMRMLMarkupsDisplayNode::GetCurveLineSizeModeAsString ( )

◆ GetCurveLineSizeModeAsString() [2/2]

static const char* vtkMRMLMarkupsDisplayNode::GetCurveLineSizeModeAsString ( int  mode)
static

◆ GetCurveLineSizeModeFromString()

static int vtkMRMLMarkupsDisplayNode::GetCurveLineSizeModeFromString ( const char *  )
static

◆ GetDefaultContextName()

static const std::string vtkMRMLMarkupsDisplayNode::GetDefaultContextName ( )
inlinestatic

Get name of the default interaction context (typically the mouse)

Definition at line 81 of file vtkMRMLMarkupsDisplayNode.h.

◆ GetFillOpacity()

virtual double vtkMRMLMarkupsDisplayNode::GetFillOpacity ( )
virtual

◆ GetFillVisibility()

virtual bool vtkMRMLMarkupsDisplayNode::GetFillVisibility ( )
virtual

◆ GetGlyphScale()

virtual double vtkMRMLMarkupsDisplayNode::GetGlyphScale ( )
virtual

◆ GetGlyphSize()

virtual double vtkMRMLMarkupsDisplayNode::GetGlyphSize ( )
virtual

◆ GetGlyphType()

virtual int vtkMRMLMarkupsDisplayNode::GetGlyphType ( )
virtual

◆ GetGlyphTypeAsString() [1/2]

const char* vtkMRMLMarkupsDisplayNode::GetGlyphTypeAsString ( )

Return a string representing the glyph type, set it from a string.

◆ GetGlyphTypeAsString() [2/2]

static const char* vtkMRMLMarkupsDisplayNode::GetGlyphTypeAsString ( int  g)
static

◆ GetGlyphTypeFromString()

static int vtkMRMLMarkupsDisplayNode::GetGlyphTypeFromString ( const char *  )
static

◆ GetHandlesInteractive()

virtual bool vtkMRMLMarkupsDisplayNode::GetHandlesInteractive ( )
virtual

The visibility and interactability of the interaction handles.

◆ GetLineColorFadingEnd()

virtual double vtkMRMLMarkupsDisplayNode::GetLineColorFadingEnd ( )
virtual

Configure the line color fading appearance Default value = 10.0

◆ GetLineColorFadingHueOffset()

virtual double vtkMRMLMarkupsDisplayNode::GetLineColorFadingHueOffset ( )
virtual

◆ GetLineColorFadingSaturation()

virtual double vtkMRMLMarkupsDisplayNode::GetLineColorFadingSaturation ( )
virtual

◆ GetLineColorFadingStart()

virtual double vtkMRMLMarkupsDisplayNode::GetLineColorFadingStart ( )
virtual

Configure the line color fading appearance Default value = 1.0

◆ GetLineColorNode()

vtkMRMLProceduralColorNode* vtkMRMLMarkupsDisplayNode::GetLineColorNode ( )

Get the line color node used for the projection on the line actors on the 2D viewers.

◆ GetLineColorNodeID()

const char* vtkMRMLMarkupsDisplayNode::GetLineColorNodeID ( )

Get the line color node ID used for the projection on the line actors on the 2D viewers.

◆ GetLineColorNodeReferenceMRMLAttributeName()

virtual const char* vtkMRMLMarkupsDisplayNode::GetLineColorNodeReferenceMRMLAttributeName ( )
protectedvirtual

◆ GetLineColorNodeReferenceRole()

virtual const char* vtkMRMLMarkupsDisplayNode::GetLineColorNodeReferenceRole ( )
virtual

◆ GetLineDiameter()

virtual double vtkMRMLMarkupsDisplayNode::GetLineDiameter ( )
virtual

Configure line diameter Diameter is specified in absolute mm value This absolute value is used if

See also
CurveLineSizeMode is UseLineDiameter For relative control of diameter,
LineThickness should be used.

◆ GetLineThickness()

virtual double vtkMRMLMarkupsDisplayNode::GetLineThickness ( )
virtual

Configure line thickness Thickness is specified relative to markup point size (1.0 means line diameter is the same as diameter of point glyphs). This relative value is used if

See also
CurveLineSizeMode is UseLineThickness For absolute control of thickness,
LineDiameter should be used.

◆ GetMarkupsNode()

vtkMRMLMarkupsNode* vtkMRMLMarkupsDisplayNode::GetMarkupsNode ( )

Convenience function for getting the displayable markups node.

◆ GetMaximumGlyphType()

static int vtkMRMLMarkupsDisplayNode::GetMaximumGlyphType ( )
inlinestatic

Definition at line 234 of file vtkMRMLMarkupsDisplayNode.h.

◆ GetMinimumGlyphType()

static int vtkMRMLMarkupsDisplayNode::GetMinimumGlyphType ( )
inlinestatic

Return the min/max glyph types, for iterating over them in tcl.

Definition at line 233 of file vtkMRMLMarkupsDisplayNode.h.

◆ GetNodeTagName()

const char* vtkMRMLMarkupsDisplayNode::GetNodeTagName ( )
inlineoverridevirtual

Get node XML tag name (like Volume, Markups)

Implements vtkMRMLNode.

Reimplemented in vtkMRMLMarkupsFiducialDisplayNode, and vtkMRMLMarkupsROIDisplayNode.

Definition at line 69 of file vtkMRMLMarkupsDisplayNode.h.

◆ GetOccludedOpacity()

virtual double vtkMRMLMarkupsDisplayNode::GetOccludedOpacity ( )
virtual

Opacity of the occluded parts of the markup. 0.0 results in the markup being fully transparent, while 1.0 is fully opaque.

See also
SetOccludedVisibility, GetOccludedVisibility

◆ GetOccludedVisibility()

virtual bool vtkMRMLMarkupsDisplayNode::GetOccludedVisibility ( )
virtual

Displays the occluded regions of the markup on top of other objects. Opacity can be adjusted with OccludedOpacity

See also
SetOccludedOpacity, GetOccludedOpacity

◆ GetOutlineOpacity()

virtual double vtkMRMLMarkupsDisplayNode::GetOutlineOpacity ( )
virtual

◆ GetOutlineVisibility()

virtual bool vtkMRMLMarkupsDisplayNode::GetOutlineVisibility ( )
virtual

◆ GetPointLabelsVisibility()

virtual bool vtkMRMLMarkupsDisplayNode::GetPointLabelsVisibility ( )
virtual

◆ GetPropertiesLabelVisibility()

virtual bool vtkMRMLMarkupsDisplayNode::GetPropertiesLabelVisibility ( )
virtual

◆ GetScalarDataSet()

virtual vtkDataSet* vtkMRMLMarkupsDisplayNode::GetScalarDataSet ( )
overridevirtual

Get data set containing the scalar arrays for this node type. For markups it is the curve poly data

Reimplemented from vtkMRMLDisplayNode.

◆ GetSliceProjection()

virtual bool vtkMRMLMarkupsDisplayNode::GetSliceProjection ( )
virtual

◆ GetSliceProjectionColor() [1/3]

virtual double* vtkMRMLMarkupsDisplayNode::GetSliceProjectionColor ( )
virtual

◆ GetSliceProjectionColor() [2/3]

virtual void vtkMRMLMarkupsDisplayNode::GetSliceProjectionColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetSliceProjectionColor() [3/3]

virtual void vtkMRMLMarkupsDisplayNode::GetSliceProjectionColor ( double  [3])
virtual

◆ GetSliceProjectionOpacity()

virtual double vtkMRMLMarkupsDisplayNode::GetSliceProjectionOpacity ( )
virtual

◆ GetSliceProjectionOutlinedBehindSlicePlane()

virtual bool vtkMRMLMarkupsDisplayNode::GetSliceProjectionOutlinedBehindSlicePlane ( )
virtual

◆ GetSliceProjectionUseFiducialColor()

virtual bool vtkMRMLMarkupsDisplayNode::GetSliceProjectionUseFiducialColor ( )
virtual

◆ GetSnapMode()

virtual int vtkMRMLMarkupsDisplayNode::GetSnapMode ( )
virtual

◆ GetSnapModeAsString()

static const char* vtkMRMLMarkupsDisplayNode::GetSnapModeAsString ( int  g)
static

◆ GetSnapModeFromString()

static int vtkMRMLMarkupsDisplayNode::GetSnapModeFromString ( const char *  )
static

◆ GetTextProperty()

virtual vtkTextProperty* vtkMRMLMarkupsDisplayNode::GetTextProperty ( )
virtual

Text property object that controls the display properties of text actors in 2D and 3D. The text object property controls background color/opacity, frame size/color, font, etc. This function should always return a valid vtkTextProperty pointer.

◆ GetTextPropertyAsString() [1/2]

std::string vtkMRMLMarkupsDisplayNode::GetTextPropertyAsString ( )
protected

◆ GetTextPropertyAsString() [2/2]

static std::string vtkMRMLMarkupsDisplayNode::GetTextPropertyAsString ( vtkTextProperty *  property)
staticprotected

◆ GetTextScale()

virtual double vtkMRMLMarkupsDisplayNode::GetTextScale ( )
virtual

Set the text scale of the associated text.

◆ GetUseGlyphScale()

virtual bool vtkMRMLMarkupsDisplayNode::GetUseGlyphScale ( )
virtual

◆ GlyphTypeIs3D() [1/2]

int vtkMRMLMarkupsDisplayNode::GlyphTypeIs3D ( int  glyphType)

Returns 1 if the type is a 3d one, 0 else.

◆ GlyphTypeIs3D() [2/2]

int vtkMRMLMarkupsDisplayNode::GlyphTypeIs3D ( )
inline

Definition at line 241 of file vtkMRMLMarkupsDisplayNode.h.

◆ HandlesInteractiveOff()

virtual void vtkMRMLMarkupsDisplayNode::HandlesInteractiveOff ( )
virtual

◆ HandlesInteractiveOn()

virtual void vtkMRMLMarkupsDisplayNode::HandlesInteractiveOn ( )
virtual

◆ HasActiveComponent()

bool vtkMRMLMarkupsDisplayNode::HasActiveComponent ( )

Query if there is an active component for any interaction context.

◆ IsA()

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

◆ IsTypeOf()

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

◆ New()

static vtkMRMLMarkupsDisplayNode* vtkMRMLMarkupsDisplayNode::New ( )
static

◆ OccludedVisibilityOff()

virtual void vtkMRMLMarkupsDisplayNode::OccludedVisibilityOff ( )
virtual

◆ OccludedVisibilityOn()

virtual void vtkMRMLMarkupsDisplayNode::OccludedVisibilityOn ( )
virtual

◆ operator=()

void vtkMRMLMarkupsDisplayNode::operator= ( const vtkMRMLMarkupsDisplayNode )
protected

◆ OutlineOpacityOff()

virtual void vtkMRMLMarkupsDisplayNode::OutlineOpacityOff ( )
virtual

◆ OutlineOpacityOn()

virtual void vtkMRMLMarkupsDisplayNode::OutlineOpacityOn ( )
virtual

◆ OutlineVisibilityOff()

virtual void vtkMRMLMarkupsDisplayNode::OutlineVisibilityOff ( )
virtual

◆ OutlineVisibilityOn()

virtual void vtkMRMLMarkupsDisplayNode::OutlineVisibilityOn ( )
virtual

◆ PointLabelsVisibilityOff()

virtual void vtkMRMLMarkupsDisplayNode::PointLabelsVisibilityOff ( )
virtual

◆ PointLabelsVisibilityOn()

virtual void vtkMRMLMarkupsDisplayNode::PointLabelsVisibilityOn ( )
virtual

◆ PrintSelf()

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

◆ ProcessMRMLEvents()

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

Alternative method to propagate events generated in Display nodes.

Reimplemented from vtkMRMLDisplayNode.

◆ PropertiesLabelVisibilityOff()

virtual void vtkMRMLMarkupsDisplayNode::PropertiesLabelVisibilityOff ( )
virtual

◆ PropertiesLabelVisibilityOn()

virtual void vtkMRMLMarkupsDisplayNode::PropertiesLabelVisibilityOn ( )
virtual

◆ ReadXMLAttributes()

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

Read node attributes from XML (MRML) file.

Reimplemented from vtkMRMLDisplayNode.

◆ SafeDownCast()

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

◆ SetActiveColor() [1/2]

virtual void vtkMRMLMarkupsDisplayNode::SetActiveColor ( double  ,
double  ,
double   
)
virtual

Set the active color of the markup. This color is used when the mouse pointer hovers over a markup.

◆ SetActiveColor() [2/2]

virtual void vtkMRMLMarkupsDisplayNode::SetActiveColor ( double  [3])
virtual

◆ SetActiveComponent()

void vtkMRMLMarkupsDisplayNode::SetActiveComponent ( int  componentType,
int  componentIndex,
std::string  context = vtkMRMLMarkupsDisplayNode::GetDefaultContextName() 
)

Set active component type and index for interaction context (empty by default, meaning mouse)

◆ SetActiveControlPoint()

void vtkMRMLMarkupsDisplayNode::SetActiveControlPoint ( int  controlPointIndex)

Set active component index to the provided value and component type to ComponentControlPoint.

◆ SetCurveLineSizeMode()

virtual void vtkMRMLMarkupsDisplayNode::SetCurveLineSizeMode ( int  )
virtual

Configure mode of determining line radius of markup curves. Default is relative thickness. Available modes in

See also
CurveLineSizeModes

◆ SetCurveLineSizeModeFromString()

void vtkMRMLMarkupsDisplayNode::SetCurveLineSizeModeFromString ( const char *  modeString)

◆ SetFillOpacity()

virtual void vtkMRMLMarkupsDisplayNode::SetFillOpacity ( double  )
virtual

Control opacity of representation fill.

◆ SetFillVisibility()

virtual void vtkMRMLMarkupsDisplayNode::SetFillVisibility ( bool  )
virtual

Control visibility of representation fill.

◆ SetGlyphScale()

virtual void vtkMRMLMarkupsDisplayNode::SetGlyphScale ( double  )
virtual

Get/Set markup point size relative to the window size. This value is only used in slice views and only if SliceUseGlyphScale is set to true. Diameter of the point is defined as "scale" percentage of diagonal size of the window.

◆ SetGlyphSize()

virtual void vtkMRMLMarkupsDisplayNode::SetGlyphSize ( double  )
virtual

Get/Set absolute markup point size. This value is used in 3D views. This value is used in slice views if SliceUseGlyphScale is set to false. Diameter of the point is defined as "scale" percentage of diagonal size of the window.

◆ SetGlyphType()

virtual void vtkMRMLMarkupsDisplayNode::SetGlyphType ( int  )
virtual

The glyph type used to display this fiducial.

◆ SetGlyphTypeFromString()

void vtkMRMLMarkupsDisplayNode::SetGlyphTypeFromString ( const char *  glyphString)

◆ SetHandlesInteractive()

virtual void vtkMRMLMarkupsDisplayNode::SetHandlesInteractive ( bool  )
virtual

◆ SetLineColorFadingEnd()

virtual void vtkMRMLMarkupsDisplayNode::SetLineColorFadingEnd ( double  )
virtual

◆ SetLineColorFadingHueOffset()

virtual void vtkMRMLMarkupsDisplayNode::SetLineColorFadingHueOffset ( double  )
virtual

Configures the line color fading appearance Default value = 0.0

◆ SetLineColorFadingSaturation()

virtual void vtkMRMLMarkupsDisplayNode::SetLineColorFadingSaturation ( double  )
virtual

Configures the line color fading appearance Default value = 1.0

◆ SetLineColorFadingStart()

virtual void vtkMRMLMarkupsDisplayNode::SetLineColorFadingStart ( double  )
virtual

◆ SetLineColorNodeID()

virtual void vtkMRMLMarkupsDisplayNode::SetLineColorNodeID ( const char *  lineColorNodeID)
virtual

Set the line color node ID used for the projection on the line actors on the 2D viewers. Setting a line color node allows to define any arbitrary color mapping. Setting a line color node will overwrite the settings given by the color, opacity and LineColorFading variables of the displayNode.

◆ SetLineDiameter()

virtual void vtkMRMLMarkupsDisplayNode::SetLineDiameter ( double  )
virtual

◆ SetLineThickness()

virtual void vtkMRMLMarkupsDisplayNode::SetLineThickness ( double  )
virtual

◆ SetOccludedOpacity()

virtual void vtkMRMLMarkupsDisplayNode::SetOccludedOpacity ( double  )
virtual

◆ SetOccludedVisibility()

virtual void vtkMRMLMarkupsDisplayNode::SetOccludedVisibility ( bool  )
virtual

◆ SetOutlineOpacity()

virtual void vtkMRMLMarkupsDisplayNode::SetOutlineOpacity ( double  )
virtual

Control opacity of representation edges.

◆ SetOutlineVisibility()

virtual void vtkMRMLMarkupsDisplayNode::SetOutlineVisibility ( bool  )
virtual

Control visibility of representation outline.

◆ SetPointLabelsVisibility()

virtual void vtkMRMLMarkupsDisplayNode::SetPointLabelsVisibility ( bool  )
virtual

Control visibility of control point labels.

◆ SetPropertiesLabelVisibility()

virtual void vtkMRMLMarkupsDisplayNode::SetPropertiesLabelVisibility ( bool  )
virtual

Control visibility of information box.

◆ SetSliceProjection()

virtual void vtkMRMLMarkupsDisplayNode::SetSliceProjection ( bool  )
virtual

Set SliceProjection flag that controls if the projection of markups is visible or not in 2D viewers on slices on which it is normally not visible. Off by default

See also
SliceIntersectionVisibilty, SliceProjectionColor

◆ SetSliceProjectionColor() [1/2]

virtual void vtkMRMLMarkupsDisplayNode::SetSliceProjectionColor ( double  ,
double  ,
double   
)
virtual

Set color of the projection on the 2D viewers White (1.0, 1.0, 1.0) by default.

◆ SetSliceProjectionColor() [2/2]

virtual void vtkMRMLMarkupsDisplayNode::SetSliceProjectionColor ( double  [3])
virtual

◆ SetSliceProjectionOpacity()

virtual void vtkMRMLMarkupsDisplayNode::SetSliceProjectionOpacity ( double  )
virtual

Set opacity of projection on the 2D viewers 0.6 by default

◆ SetSliceProjectionOutlinedBehindSlicePlane()

virtual void vtkMRMLMarkupsDisplayNode::SetSliceProjectionOutlinedBehindSlicePlane ( bool  )
virtual

Set projection's view different if under/over/in the plane Off by default

◆ SetSliceProjectionUseFiducialColor()

virtual void vtkMRMLMarkupsDisplayNode::SetSliceProjectionUseFiducialColor ( bool  )
virtual

Set projection color to be the same as the fiducial color On by default

◆ SetSnapMode()

virtual void vtkMRMLMarkupsDisplayNode::SetSnapMode ( int  )
virtual

Specifies if position of control points are snapped to selected surfaces

See also
SnapModes

◆ SetTextPropertyFromString()

void vtkMRMLMarkupsDisplayNode::SetTextPropertyFromString ( std::string  textPropertyString)
protected

◆ SetTextScale()

virtual void vtkMRMLMarkupsDisplayNode::SetTextScale ( double  )
virtual

◆ SetUseGlyphScale()

virtual void vtkMRMLMarkupsDisplayNode::SetUseGlyphScale ( bool  )
virtual

This flag controls if GlyphScale relative or GlyphSize absolute size is used to determine size of point glyphs. On by default (GlyphScale is used for point sizing in 2D views).

See also
SetGlyphScale, SetGlyphSize

◆ SliceProjectionOff()

virtual void vtkMRMLMarkupsDisplayNode::SliceProjectionOff ( )
virtual

◆ SliceProjectionOn()

virtual void vtkMRMLMarkupsDisplayNode::SliceProjectionOn ( )
virtual

◆ SliceProjectionOutlinedBehindSlicePlaneOff()

virtual void vtkMRMLMarkupsDisplayNode::SliceProjectionOutlinedBehindSlicePlaneOff ( )
virtual

◆ SliceProjectionOutlinedBehindSlicePlaneOn()

virtual void vtkMRMLMarkupsDisplayNode::SliceProjectionOutlinedBehindSlicePlaneOn ( )
virtual

◆ SliceProjectionUseFiducialColorOff()

virtual void vtkMRMLMarkupsDisplayNode::SliceProjectionUseFiducialColorOff ( )
virtual

◆ SliceProjectionUseFiducialColorOn()

virtual void vtkMRMLMarkupsDisplayNode::SliceProjectionUseFiducialColorOn ( )
virtual

◆ UpdateActiveControlPointWorld()

int vtkMRMLMarkupsDisplayNode::UpdateActiveControlPointWorld ( int  controlPointIndex,
vtkMRMLInteractionEventData eventData,
double  accurateWorldOrientationMatrix[9],
const char *  viewNodeID,
const char *  associatedNodeID,
int  positionStatus 
)

Convenience method to perform several update operations at once, with minimum number of modified events. It updates the active control point index (if controlPointIndex<0 then it creates a new point) and updates its position and orientation. Returns the control point index (different from the input if the input was < 0).

◆ UpdateAssignedAttribute()

virtual void vtkMRMLMarkupsDisplayNode::UpdateAssignedAttribute ( )
overridevirtual

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

Reimplemented from vtkMRMLDisplayNode.

◆ UpdateScene()

void vtkMRMLMarkupsDisplayNode::UpdateScene ( vtkMRMLScene scene)
overridevirtual

Finds the storage node and read the data.

Reimplemented from vtkMRMLDisplayNode.

◆ UpdateTextPropertyFromString()

static void vtkMRMLMarkupsDisplayNode::UpdateTextPropertyFromString ( std::string  inputString,
vtkTextProperty *  property 
)
staticprotected

◆ UseGlyphScaleOff()

virtual void vtkMRMLMarkupsDisplayNode::UseGlyphScaleOff ( )
virtual

◆ UseGlyphScaleOn()

virtual void vtkMRMLMarkupsDisplayNode::UseGlyphScaleOn ( )
virtual

◆ vtkMRMLCopyContentMacro()

vtkMRMLMarkupsDisplayNode::vtkMRMLCopyContentMacro ( vtkMRMLMarkupsDisplayNode  )

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

See also
vtkMRMLNode::CopyContent

◆ WriteXML()

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

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

Reimplemented from vtkMRMLDisplayNode.

Member Data Documentation

◆ ActiveColor

double vtkMRMLMarkupsDisplayNode::ActiveColor[3]
protected

Definition at line 489 of file vtkMRMLMarkupsDisplayNode.h.

◆ ActiveComponents

std::map<std::string, ComponentInfo> vtkMRMLMarkupsDisplayNode::ActiveComponents
protected

Current active point or widget component type and index (hovered by the mouse or other interaction context) Map interaction context identifier (empty string for mouse) to component type enum

Definition at line 448 of file vtkMRMLMarkupsDisplayNode.h.

◆ CurveLineSizeMode

int vtkMRMLMarkupsDisplayNode::CurveLineSizeMode
protected

Definition at line 475 of file vtkMRMLMarkupsDisplayNode.h.

◆ FillOpacity

double vtkMRMLMarkupsDisplayNode::FillOpacity
protected

Definition at line 456 of file vtkMRMLMarkupsDisplayNode.h.

◆ FillVisibility

bool vtkMRMLMarkupsDisplayNode::FillVisibility
protected

Definition at line 454 of file vtkMRMLMarkupsDisplayNode.h.

◆ GlyphScale

double vtkMRMLMarkupsDisplayNode::GlyphScale
protected

Definition at line 460 of file vtkMRMLMarkupsDisplayNode.h.

◆ GlyphSize

double vtkMRMLMarkupsDisplayNode::GlyphSize
protected

Definition at line 461 of file vtkMRMLMarkupsDisplayNode.h.

◆ GlyphType

int vtkMRMLMarkupsDisplayNode::GlyphType
protected

Definition at line 459 of file vtkMRMLMarkupsDisplayNode.h.

◆ HandlesInteractive

bool vtkMRMLMarkupsDisplayNode::HandlesInteractive
protected

Definition at line 491 of file vtkMRMLMarkupsDisplayNode.h.

◆ LineColorFadingEnd

double vtkMRMLMarkupsDisplayNode::LineColorFadingEnd
protected

Definition at line 480 of file vtkMRMLMarkupsDisplayNode.h.

◆ LineColorFadingHueOffset

double vtkMRMLMarkupsDisplayNode::LineColorFadingHueOffset
protected

Definition at line 482 of file vtkMRMLMarkupsDisplayNode.h.

◆ LineColorFadingSaturation

double vtkMRMLMarkupsDisplayNode::LineColorFadingSaturation
protected

Definition at line 481 of file vtkMRMLMarkupsDisplayNode.h.

◆ LineColorFadingStart

double vtkMRMLMarkupsDisplayNode::LineColorFadingStart
protected

Definition at line 479 of file vtkMRMLMarkupsDisplayNode.h.

◆ LineColorNodeReferenceMRMLAttributeName

const char* vtkMRMLMarkupsDisplayNode::LineColorNodeReferenceMRMLAttributeName
staticprotected

Definition at line 473 of file vtkMRMLMarkupsDisplayNode.h.

◆ LineColorNodeReferenceRole

const char* vtkMRMLMarkupsDisplayNode::LineColorNodeReferenceRole
staticprotected

Definition at line 472 of file vtkMRMLMarkupsDisplayNode.h.

◆ LineDiameter

double vtkMRMLMarkupsDisplayNode::LineDiameter
protected

Definition at line 477 of file vtkMRMLMarkupsDisplayNode.h.

◆ LineThickness

double vtkMRMLMarkupsDisplayNode::LineThickness
protected

Definition at line 476 of file vtkMRMLMarkupsDisplayNode.h.

◆ OccludedOpacity

double vtkMRMLMarkupsDisplayNode::OccludedOpacity
protected

Definition at line 485 of file vtkMRMLMarkupsDisplayNode.h.

◆ OccludedVisibility

bool vtkMRMLMarkupsDisplayNode::OccludedVisibility
protected

Definition at line 484 of file vtkMRMLMarkupsDisplayNode.h.

◆ OutlineOpacity

double vtkMRMLMarkupsDisplayNode::OutlineOpacity
protected

Definition at line 457 of file vtkMRMLMarkupsDisplayNode.h.

◆ OutlineVisibility

bool vtkMRMLMarkupsDisplayNode::OutlineVisibility
protected

Definition at line 455 of file vtkMRMLMarkupsDisplayNode.h.

◆ PointLabelsVisibility

bool vtkMRMLMarkupsDisplayNode::PointLabelsVisibility
protected

Definition at line 453 of file vtkMRMLMarkupsDisplayNode.h.

◆ PropertiesLabelVisibility

bool vtkMRMLMarkupsDisplayNode::PropertiesLabelVisibility
protected

Definition at line 452 of file vtkMRMLMarkupsDisplayNode.h.

◆ SliceProjection

bool vtkMRMLMarkupsDisplayNode::SliceProjection
protected

Definition at line 464 of file vtkMRMLMarkupsDisplayNode.h.

◆ SliceProjectionColor

double vtkMRMLMarkupsDisplayNode::SliceProjectionColor[3]
protected

Definition at line 467 of file vtkMRMLMarkupsDisplayNode.h.

◆ SliceProjectionOpacity

double vtkMRMLMarkupsDisplayNode::SliceProjectionOpacity
protected

Definition at line 468 of file vtkMRMLMarkupsDisplayNode.h.

◆ SliceProjectionOutlinedBehindSlicePlane

bool vtkMRMLMarkupsDisplayNode::SliceProjectionOutlinedBehindSlicePlane
protected

Definition at line 466 of file vtkMRMLMarkupsDisplayNode.h.

◆ SliceProjectionUseFiducialColor

bool vtkMRMLMarkupsDisplayNode::SliceProjectionUseFiducialColor
protected

Definition at line 465 of file vtkMRMLMarkupsDisplayNode.h.

◆ SnapMode

int vtkMRMLMarkupsDisplayNode::SnapMode
protected

Definition at line 450 of file vtkMRMLMarkupsDisplayNode.h.

◆ TextProperty

vtkTextProperty* vtkMRMLMarkupsDisplayNode::TextProperty
protected

Definition at line 487 of file vtkMRMLMarkupsDisplayNode.h.

◆ TextScale

double vtkMRMLMarkupsDisplayNode::TextScale
protected

Definition at line 458 of file vtkMRMLMarkupsDisplayNode.h.

◆ UseGlyphScale

bool vtkMRMLMarkupsDisplayNode::UseGlyphScale
protected

Definition at line 462 of file vtkMRMLMarkupsDisplayNode.h.


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