Slicer  5.0
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 | Static Public Attributes | Protected Member Functions | Protected Attributes | Friends
vtkMRMLSegmentationDisplayNode Class Reference

MRML node for representing segmentation display attributes. More...

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

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

Classes

struct  SegmentDisplayProperties
 Display properties per segment. More...
 

Public Types

typedef std::map< std::string, SegmentDisplayPropertiesSegmentDisplayPropertiesMap
 
typedef vtkMRMLDisplayNode Superclass
 
- 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

bool CalculateAutoOpacitiesForSegments ()
 
void ClearSegmentDisplayProperties ()
 Clear segment display properties. More...
 
vtkMRMLNodeCreateNodeInstance () override
 Create instance of the default node. Like New only virtual. More...
 
void GenerateSegmentColor (double color[3], int colorNumber=0)
 
void GenerateSegmentColor (double &r, double &g, double &b)
 
virtual const char * GetClassName ()
 
std::string GetDisplayRepresentationName2D ()
 
std::string GetDisplayRepresentationName3D ()
 
const char * GetNodeTagName () override
 Get node XML tag name (like Volume, Model) More...
 
virtual double GetOpacity2DFill ()
 Get/Set 2D fill opacity. More...
 
virtual double GetOpacity2DOutline ()
 Get/Set 2D outline opacity. More...
 
virtual double GetOpacity3D ()
 Get/Set 3D opacity. More...
 
void GetPolyDataRepresentationNames (std::set< std::string > &representationNames)
 Collect representation names that are stored as poly data. More...
 
virtual char * GetPreferredDisplayRepresentationName2D ()
 
virtual char * GetPreferredDisplayRepresentationName3D ()
 Get name of representation that is displayed in the 3D view if exists. More...
 
vtkVector3d GetSegmentColor (std::string segmentID)
 
bool GetSegmentColor (std::string segmentID, double *color)
 Get segment color by segment ID. If overridden then the override color is returned. More...
 
bool GetSegmentColor (std::string segmentID, double &r, double &g, double &b)
 Get segment color by segment ID. If overridden then the override color is returned. More...
 
bool GetSegmentDisplayProperties (std::string segmentID, SegmentDisplayProperties &properties)
 
double GetSegmentOpacity2DFill (std::string segmentID)
 
double GetSegmentOpacity2DOutline (std::string segmentID)
 
double GetSegmentOpacity3D (std::string segmentID)
 
vtkVector3d GetSegmentOverrideColor (std::string segmentID)
 
bool GetSegmentVisibility (std::string segmentID)
 
bool GetSegmentVisibility2DFill (std::string segmentID)
 
bool GetSegmentVisibility2DOutline (std::string segmentID)
 
bool GetSegmentVisibility3D (std::string segmentID)
 
virtual bool GetVisibility2DFill ()
 Get/Set 2D fill visibility. More...
 
virtual bool GetVisibility2DOutline ()
 Get/Set 2D outline visibility. More...
 
void GetVisibleSegmentIDs (vtkStringArray *segmentIDs)
 Get all visible segment IDs. More...
 
void GetVisibleSegmentIDs (std::vector< std::string > &segmentIDs)
 Get all visible segment IDs. More...
 
std::vector< std::string > GetVisibleSegmentIDs ()
 Get all visible segment IDs. More...
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ReadXMLAttributes (const char **atts) override
 Set node attributes from name/value pairs. More...
 
void RemoveSegmentDisplayProperties (std::string segmentID)
 Remove segment display properties. More...
 
void SetAllSegmentsOpacity (double opacity, bool changeVisibleSegmentsOnly=false)
 
void SetAllSegmentsOpacity2DFill (double opacity, bool changeVisibleSegmentsOnly=false)
 
void SetAllSegmentsOpacity2DOutline (double opacity, bool changeVisibleSegmentsOnly=false)
 
void SetAllSegmentsOpacity3D (double opacity, bool changeVisibleSegmentsOnly=false)
 
void SetAllSegmentsVisibility (bool visible)
 
void SetAllSegmentsVisibility2DFill (bool visible, bool changeVisibleSegmentsOnly=false)
 
void SetAllSegmentsVisibility2DOutline (bool visible, bool changeVisibleSegmentsOnly=false)
 
void SetAllSegmentsVisibility3D (bool visible, bool changeVisibleSegmentsOnly=false)
 
virtual void SetOpacity2DFill (double)
 
virtual void SetOpacity2DOutline (double)
 
virtual void SetOpacity3D (double)
 
virtual void SetPreferredDisplayRepresentationName2D (const char *)
 Set name of representation that is displayed in the 2D view if exists. More...
 
virtual void SetPreferredDisplayRepresentationName3D (const char *)
 Set name of representation that is displayed in the 3D view if exists. More...
 
void SetSegmentDisplayProperties (std::string segmentID, SegmentDisplayProperties &properties)
 Set segment display properties. More...
 
void SetSegmentDisplayPropertiesToDefault (const std::string &segmentId)
 Set segment display properties to default. More...
 
void SetSegmentOpacity (std::string segmentID, double opacity)
 Set all three types of segment opacity by segment ID. More...
 
void SetSegmentOpacity2DFill (std::string segmentID, double opacity)
 Set segment 2D fill opacity by segment ID. Convenience function for python compatibility. More...
 
void SetSegmentOpacity2DOutline (std::string segmentID, double opacity)
 Set segment 2D outline opacity by segment ID. Convenience function for python compatibility. More...
 
void SetSegmentOpacity3D (std::string segmentID, double opacity)
 Set segment 3D opacity by segment ID. Convenience function for python compatibility. More...
 
void SetSegmentOverrideColor (std::string segmentID, double r, double g, double b)
 
void SetSegmentOverrideColor (std::string segmentID, vtkVector3d overrideColor)
 Set segment override color by segment ID. More...
 
void SetSegmentVisibility (std::string segmentID, bool visible)
 Set overall segment visibility by segment ID. Convenience function for python compatibility. More...
 
void SetSegmentVisibility2DFill (std::string segmentID, bool visible)
 Set segment 2D fill visibility by segment ID. Convenience function for python compatibility. More...
 
void SetSegmentVisibility2DOutline (std::string segmentID, bool visible)
 Set segment 2D outline visibility by segment ID. Convenience function for python compatibility. More...
 
void SetSegmentVisibility3D (std::string segmentID, bool visible)
 Set segment 3D visibility by segment ID. Convenience function for python compatibility. More...
 
virtual void SetVisibility2DFill (bool)
 
virtual void SetVisibility2DOutline (bool)
 
void UnsetSegmentOverrideColor (std::string segmentID)
 Unset segment override color (default segment color will be used for display instead). More...
 
virtual void Visibility2DFillOff ()
 
virtual void Visibility2DFillOn ()
 
virtual void Visibility2DOutlineOff ()
 
virtual void Visibility2DOutlineOn ()
 
 vtkMRMLCopyContentMacro (vtkMRMLSegmentationDisplayNode)
 
void WriteXML (ostream &of, int indent) override
 Write this node's information to a MRML file in XML format. More...
 
void SetSegmentColorGeneratorSourceColorNodeID (const char *colorNodeID)
 
const char * GetSegmentColorGeneratorSourceColorNodeID ()
 
- 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 vtkDataArray * GetActiveScalarArray ()
 
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 vtkDataSet * GetScalarDataSet ()
 
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 ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) 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 ()
 
virtual void UpdateAssignedAttribute ()
 
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 ()
 
void UpdateScene (vtkMRMLScene *scene) override
 Finds the storage node and read the data. More...
 
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 vtkMRMLSegmentationDisplayNodeNew ()
 
static vtkMRMLSegmentationDisplayNodeSafeDownCast (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 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)
 

Static Public Attributes

static const double SEGMENT_COLOR_NO_OVERRIDE
 

Protected Member Functions

void GetSegmentIDs (std::vector< std::string > &segmentIDs, bool visibleSegmentsOnly)
 Convenience function for getting all segment IDs. More...
 
void operator= (const vtkMRMLSegmentationDisplayNode &)
 
void UpdateSegmentList (bool removeUnusedDisplayProperties=true)
 
 vtkMRMLSegmentationDisplayNode ()
 
 vtkMRMLSegmentationDisplayNode (const vtkMRMLSegmentationDisplayNode &)
 
 ~vtkMRMLSegmentationDisplayNode () 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

unsigned int NumberOfGeneratedColors {0}
 
double Opacity2DFill {0.5}
 2D fill opacity for the whole segmentation More...
 
double Opacity2DOutline {1.0}
 2D outline opacity for the whole segmentation More...
 
double Opacity3D {1.0}
 3D opacity for the whole segmentation More...
 
char * PreferredDisplayRepresentationName2D {nullptr}
 
char * PreferredDisplayRepresentationName3D {nullptr}
 
SegmentDisplayPropertiesMap SegmentationDisplayProperties
 
vtkSegmentationSegmentListUpdateSource {nullptr}
 
vtkMTimeType SegmentListUpdateTime {0}
 For checking if cached segment list in SegmentationDisplayProperties has to be updated. More...
 
bool Visibility2DFill {true}
 
bool Visibility2DOutline {true}
 
- 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}
 

Friends

class vtkMRMLSegmentationNode
 

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)
 

Detailed Description

MRML node for representing segmentation display attributes.

vtkMRMLSegmentationDisplayNode nodes describe how volume is displayed.

Definition at line 40 of file vtkMRMLSegmentationDisplayNode.h.

Member Typedef Documentation

◆ SegmentDisplayPropertiesMap

Definition at line 74 of file vtkMRMLSegmentationDisplayNode.h.

◆ Superclass

Definition at line 78 of file vtkMRMLSegmentationDisplayNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLSegmentationDisplayNode() [1/2]

vtkMRMLSegmentationDisplayNode::vtkMRMLSegmentationDisplayNode ( )
protected

◆ ~vtkMRMLSegmentationDisplayNode()

vtkMRMLSegmentationDisplayNode::~vtkMRMLSegmentationDisplayNode ( )
overrideprotected

◆ vtkMRMLSegmentationDisplayNode() [2/2]

vtkMRMLSegmentationDisplayNode::vtkMRMLSegmentationDisplayNode ( const vtkMRMLSegmentationDisplayNode )
protected

Member Function Documentation

◆ CalculateAutoOpacitiesForSegments()

bool vtkMRMLSegmentationDisplayNode::CalculateAutoOpacitiesForSegments ( )

Determine and set automatic opacities for segments using topological hierarchies. Stores value in opacity component of

See also
SegmentDisplayProperties.
Returns
Success flag

◆ ClearSegmentDisplayProperties()

void vtkMRMLSegmentationDisplayNode::ClearSegmentDisplayProperties ( )

Clear segment display properties.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLSegmentationDisplayNode::CreateNodeInstance ( )
overridevirtual

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

Note
Subclasses should implement this method

Implements vtkMRMLNode.

◆ GenerateSegmentColor() [1/2]

void vtkMRMLSegmentationDisplayNode::GenerateSegmentColor ( double  color[3],
int  colorNumber = 0 
)

Generate new color for an added segment. Uses

See also
NumberOfGeneratedColors to get the color for the new segment from default label color table
Parameters
colorOutput argument for the generated color
colorNumberIndex of the color in generic anatomy color table that is returned. Default value is 0, meaning that
See also
NumberOfGeneratedColors is used. A value of -1 means that a random color is generated.

◆ GenerateSegmentColor() [2/2]

void vtkMRMLSegmentationDisplayNode::GenerateSegmentColor ( double &  r,
double &  g,
double &  b 
)

Python compatibility function for

See also
GenerateSegmentColor. The color with index
NumberOfGeneratedColors from generic anatomy color table is returned.

◆ GetClassName()

virtual const char* vtkMRMLSegmentationDisplayNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLDisplayNode.

◆ GetDisplayRepresentationName2D()

std::string vtkMRMLSegmentationDisplayNode::GetDisplayRepresentationName2D ( )

Decide which representation to use for 2D display. If preferred representation exists

See also
PreferredDisplayRepresentationName2D, then return that. Otherwise return master representation.

◆ GetDisplayRepresentationName3D()

std::string vtkMRMLSegmentationDisplayNode::GetDisplayRepresentationName3D ( )

Decide which poly data representation to use for 3D display. If preferred representation exists

See also
PreferredDisplayRepresentationName3D, then return that. Otherwise if master representation is a poly data then return master representation type. Otherwise return first poly data representation if any. Otherwise return empty string meaning there is no poly data representation to display.

◆ GetNodeTagName()

const char* vtkMRMLSegmentationDisplayNode::GetNodeTagName ( )
inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Definition at line 94 of file vtkMRMLSegmentationDisplayNode.h.

◆ GetOpacity2DFill()

virtual double vtkMRMLSegmentationDisplayNode::GetOpacity2DFill ( )
virtual

Get/Set 2D fill opacity.

◆ GetOpacity2DOutline()

virtual double vtkMRMLSegmentationDisplayNode::GetOpacity2DOutline ( )
virtual

Get/Set 2D outline opacity.

◆ GetOpacity3D()

virtual double vtkMRMLSegmentationDisplayNode::GetOpacity3D ( )
virtual

Get/Set 3D opacity.

◆ GetPolyDataRepresentationNames()

void vtkMRMLSegmentationDisplayNode::GetPolyDataRepresentationNames ( std::set< std::string > &  representationNames)

Collect representation names that are stored as poly data.

◆ GetPreferredDisplayRepresentationName2D()

virtual char* vtkMRMLSegmentationDisplayNode::GetPreferredDisplayRepresentationName2D ( )
virtual

Get name of representation that is displayed in the 2D view if exists To get the actually displayed 2D representation call

See also

◆ GetPreferredDisplayRepresentationName3D()

virtual char* vtkMRMLSegmentationDisplayNode::GetPreferredDisplayRepresentationName3D ( )
virtual

Get name of representation that is displayed in the 3D view if exists.

◆ GetSegmentColor() [1/3]

vtkVector3d vtkMRMLSegmentationDisplayNode::GetSegmentColor ( std::string  segmentID)

Get segment color by segment ID. Convenience function for python compatibility.

Returns
Segment color not overridden, otherwise the override color

◆ GetSegmentColor() [2/3]

bool vtkMRMLSegmentationDisplayNode::GetSegmentColor ( std::string  segmentID,
double *  color 
)

Get segment color by segment ID. If overridden then the override color is returned.

◆ GetSegmentColor() [3/3]

bool vtkMRMLSegmentationDisplayNode::GetSegmentColor ( std::string  segmentID,
double &  r,
double &  g,
double &  b 
)

Get segment color by segment ID. If overridden then the override color is returned.

◆ GetSegmentColorGeneratorSourceColorNodeID()

const char* vtkMRMLSegmentationDisplayNode::GetSegmentColorGeneratorSourceColorNodeID ( )

◆ GetSegmentDisplayProperties()

bool vtkMRMLSegmentationDisplayNode::GetSegmentDisplayProperties ( std::string  segmentID,
SegmentDisplayProperties properties 
)

Get segment display properties for a specific segment

Parameters
segmentIDIdentifier of segment of which the properties are queried
propertiesDisplay properties of the segment are copied into this object. If display properties are not defined for this segment explicitly then a warning is logged and default display properties are used.
Returns
True if display properties are specified for the segment.

◆ GetSegmentIDs()

void vtkMRMLSegmentationDisplayNode::GetSegmentIDs ( std::vector< std::string > &  segmentIDs,
bool  visibleSegmentsOnly 
)
protected

Convenience function for getting all segment IDs.

◆ GetSegmentOpacity2DFill()

double vtkMRMLSegmentationDisplayNode::GetSegmentOpacity2DFill ( std::string  segmentID)

Get segment 2D fill opacity by segment ID. Convenience function for python compatibility.

Returns
Segment 2D fill opacity if segment found, otherwise false

◆ GetSegmentOpacity2DOutline()

double vtkMRMLSegmentationDisplayNode::GetSegmentOpacity2DOutline ( std::string  segmentID)

Get segment 2D outline opacity by segment ID. Convenience function for python compatibility.

Returns
Segment 2D outline opacity if segment found, otherwise false

◆ GetSegmentOpacity3D()

double vtkMRMLSegmentationDisplayNode::GetSegmentOpacity3D ( std::string  segmentID)

Get segment 3D opacity by segment ID. Convenience function for python compatibility.

Returns
Segment 3D opacity if segment found, otherwise false

◆ GetSegmentOverrideColor()

vtkVector3d vtkMRMLSegmentationDisplayNode::GetSegmentOverrideColor ( std::string  segmentID)

Get segment override color by segment ID. Convenience function for python compatibility.

Returns
Override color if segment found and color overridden, otherwise the invalid override color (-1,-1,-1)

◆ GetSegmentVisibility()

bool vtkMRMLSegmentationDisplayNode::GetSegmentVisibility ( std::string  segmentID)

Get overall segment visibility by segment ID. Convenience function for python compatibility.

Returns
Segment visibility if segment found, otherwise false

◆ GetSegmentVisibility2DFill()

bool vtkMRMLSegmentationDisplayNode::GetSegmentVisibility2DFill ( std::string  segmentID)

Get segment 2D fill visibility by segment ID. Convenience function for python compatibility.

Returns
Segment 2D fill visibility if segment found, otherwise false

◆ GetSegmentVisibility2DOutline()

bool vtkMRMLSegmentationDisplayNode::GetSegmentVisibility2DOutline ( std::string  segmentID)

Get segment 2D outline visibility by segment ID. Convenience function for python compatibility.

Returns
Segment 2D outline visibility if segment found, otherwise false

◆ GetSegmentVisibility3D()

bool vtkMRMLSegmentationDisplayNode::GetSegmentVisibility3D ( std::string  segmentID)

Get segment 3D visibility by segment ID. Convenience function for python compatibility.

Returns
Segment 3D visibility if segment found, otherwise false

◆ GetVisibility2DFill()

virtual bool vtkMRMLSegmentationDisplayNode::GetVisibility2DFill ( )
virtual

Get/Set 2D fill visibility.

◆ GetVisibility2DOutline()

virtual bool vtkMRMLSegmentationDisplayNode::GetVisibility2DOutline ( )
virtual

Get/Set 2D outline visibility.

◆ GetVisibleSegmentIDs() [1/3]

void vtkMRMLSegmentationDisplayNode::GetVisibleSegmentIDs ( vtkStringArray *  segmentIDs)

Get all visible segment IDs.

◆ GetVisibleSegmentIDs() [2/3]

void vtkMRMLSegmentationDisplayNode::GetVisibleSegmentIDs ( std::vector< std::string > &  segmentIDs)

Get all visible segment IDs.

◆ GetVisibleSegmentIDs() [3/3]

std::vector<std::string> vtkMRMLSegmentationDisplayNode::GetVisibleSegmentIDs ( )

Get all visible segment IDs.

◆ IsA()

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

Reimplemented from vtkMRMLDisplayNode.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLSegmentationDisplayNode* vtkMRMLSegmentationDisplayNode::New ( )
static

◆ operator=()

void vtkMRMLSegmentationDisplayNode::operator= ( const vtkMRMLSegmentationDisplayNode )
protected

◆ PrintSelf()

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

◆ ReadXMLAttributes()

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

Set node attributes from name/value pairs.

Reimplemented from vtkMRMLDisplayNode.

◆ RemoveSegmentDisplayProperties()

void vtkMRMLSegmentationDisplayNode::RemoveSegmentDisplayProperties ( std::string  segmentID)

Remove segment display properties.

◆ SafeDownCast()

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

◆ SetAllSegmentsOpacity()

void vtkMRMLSegmentationDisplayNode::SetAllSegmentsOpacity ( double  opacity,
bool  changeVisibleSegmentsOnly = false 
)

◆ SetAllSegmentsOpacity2DFill()

void vtkMRMLSegmentationDisplayNode::SetAllSegmentsOpacity2DFill ( double  opacity,
bool  changeVisibleSegmentsOnly = false 
)

◆ SetAllSegmentsOpacity2DOutline()

void vtkMRMLSegmentationDisplayNode::SetAllSegmentsOpacity2DOutline ( double  opacity,
bool  changeVisibleSegmentsOnly = false 
)

◆ SetAllSegmentsOpacity3D()

void vtkMRMLSegmentationDisplayNode::SetAllSegmentsOpacity3D ( double  opacity,
bool  changeVisibleSegmentsOnly = false 
)

◆ SetAllSegmentsVisibility()

void vtkMRMLSegmentationDisplayNode::SetAllSegmentsVisibility ( bool  visible)

◆ SetAllSegmentsVisibility2DFill()

void vtkMRMLSegmentationDisplayNode::SetAllSegmentsVisibility2DFill ( bool  visible,
bool  changeVisibleSegmentsOnly = false 
)

◆ SetAllSegmentsVisibility2DOutline()

void vtkMRMLSegmentationDisplayNode::SetAllSegmentsVisibility2DOutline ( bool  visible,
bool  changeVisibleSegmentsOnly = false 
)

◆ SetAllSegmentsVisibility3D()

void vtkMRMLSegmentationDisplayNode::SetAllSegmentsVisibility3D ( bool  visible,
bool  changeVisibleSegmentsOnly = false 
)

◆ SetOpacity2DFill()

virtual void vtkMRMLSegmentationDisplayNode::SetOpacity2DFill ( double  )
virtual

◆ SetOpacity2DOutline()

virtual void vtkMRMLSegmentationDisplayNode::SetOpacity2DOutline ( double  )
virtual

◆ SetOpacity3D()

virtual void vtkMRMLSegmentationDisplayNode::SetOpacity3D ( double  )
virtual

◆ SetPreferredDisplayRepresentationName2D()

virtual void vtkMRMLSegmentationDisplayNode::SetPreferredDisplayRepresentationName2D ( const char *  )
virtual

Set name of representation that is displayed in the 2D view if exists.

◆ SetPreferredDisplayRepresentationName3D()

virtual void vtkMRMLSegmentationDisplayNode::SetPreferredDisplayRepresentationName3D ( const char *  )
virtual

Set name of representation that is displayed in the 3D view if exists.

◆ SetSegmentColorGeneratorSourceColorNodeID()

void vtkMRMLSegmentationDisplayNode::SetSegmentColorGeneratorSourceColorNodeID ( const char *  colorNodeID)

Get/Set color table node ID that is used for generating default colors for new segments. If not specified then "vtkMRMLColorTableNodeFileGenericAnatomyColors.txt" is used.

◆ SetSegmentDisplayProperties()

void vtkMRMLSegmentationDisplayNode::SetSegmentDisplayProperties ( std::string  segmentID,
SegmentDisplayProperties properties 
)

Set segment display properties.

◆ SetSegmentDisplayPropertiesToDefault()

void vtkMRMLSegmentationDisplayNode::SetSegmentDisplayPropertiesToDefault ( const std::string &  segmentId)

Set segment display properties to default.

◆ SetSegmentOpacity()

void vtkMRMLSegmentationDisplayNode::SetSegmentOpacity ( std::string  segmentID,
double  opacity 
)

Set all three types of segment opacity by segment ID.

◆ SetSegmentOpacity2DFill()

void vtkMRMLSegmentationDisplayNode::SetSegmentOpacity2DFill ( std::string  segmentID,
double  opacity 
)

Set segment 2D fill opacity by segment ID. Convenience function for python compatibility.

◆ SetSegmentOpacity2DOutline()

void vtkMRMLSegmentationDisplayNode::SetSegmentOpacity2DOutline ( std::string  segmentID,
double  opacity 
)

Set segment 2D outline opacity by segment ID. Convenience function for python compatibility.

◆ SetSegmentOpacity3D()

void vtkMRMLSegmentationDisplayNode::SetSegmentOpacity3D ( std::string  segmentID,
double  opacity 
)

Set segment 3D opacity by segment ID. Convenience function for python compatibility.

◆ SetSegmentOverrideColor() [1/2]

void vtkMRMLSegmentationDisplayNode::SetSegmentOverrideColor ( std::string  segmentID,
double  r,
double  g,
double  b 
)

Set segment override color by segment ID Override color is used for specifying custom color for a segment in selected views. By default, segment color is invalid (-1,-1,-1), which means that the color stored in vtkSegment object will be used. If a valid override color is specified then in the views corresponding to this display node, segment will be colored using the override color.

◆ SetSegmentOverrideColor() [2/2]

void vtkMRMLSegmentationDisplayNode::SetSegmentOverrideColor ( std::string  segmentID,
vtkVector3d  overrideColor 
)

Set segment override color by segment ID.

◆ SetSegmentVisibility()

void vtkMRMLSegmentationDisplayNode::SetSegmentVisibility ( std::string  segmentID,
bool  visible 
)

Set overall segment visibility by segment ID. Convenience function for python compatibility.

◆ SetSegmentVisibility2DFill()

void vtkMRMLSegmentationDisplayNode::SetSegmentVisibility2DFill ( std::string  segmentID,
bool  visible 
)

Set segment 2D fill visibility by segment ID. Convenience function for python compatibility.

◆ SetSegmentVisibility2DOutline()

void vtkMRMLSegmentationDisplayNode::SetSegmentVisibility2DOutline ( std::string  segmentID,
bool  visible 
)

Set segment 2D outline visibility by segment ID. Convenience function for python compatibility.

◆ SetSegmentVisibility3D()

void vtkMRMLSegmentationDisplayNode::SetSegmentVisibility3D ( std::string  segmentID,
bool  visible 
)

Set segment 3D visibility by segment ID. Convenience function for python compatibility.

◆ SetVisibility2DFill()

virtual void vtkMRMLSegmentationDisplayNode::SetVisibility2DFill ( bool  )
virtual

◆ SetVisibility2DOutline()

virtual void vtkMRMLSegmentationDisplayNode::SetVisibility2DOutline ( bool  )
virtual

◆ UnsetSegmentOverrideColor()

void vtkMRMLSegmentationDisplayNode::UnsetSegmentOverrideColor ( std::string  segmentID)

Unset segment override color (default segment color will be used for display instead).

◆ UpdateSegmentList()

void vtkMRMLSegmentationDisplayNode::UpdateSegmentList ( bool  removeUnusedDisplayProperties = true)
protected

Update list of segment display properties. Remove entries for missing segments (if removeUnusedDisplayProperties is enabled) and add missing entries for existing segments.

◆ Visibility2DFillOff()

virtual void vtkMRMLSegmentationDisplayNode::Visibility2DFillOff ( )
virtual

◆ Visibility2DFillOn()

virtual void vtkMRMLSegmentationDisplayNode::Visibility2DFillOn ( )
virtual

◆ Visibility2DOutlineOff()

virtual void vtkMRMLSegmentationDisplayNode::Visibility2DOutlineOff ( )
virtual

◆ Visibility2DOutlineOn()

virtual void vtkMRMLSegmentationDisplayNode::Visibility2DOutlineOn ( )
virtual

◆ vtkMRMLCopyContentMacro()

vtkMRMLSegmentationDisplayNode::vtkMRMLCopyContentMacro ( vtkMRMLSegmentationDisplayNode  )

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

See also
vtkMRMLNode::CopyContent

◆ WriteXML()

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

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

Reimplemented from vtkMRMLDisplayNode.

Friends And Related Function Documentation

◆ vtkMRMLSegmentationNode

friend class vtkMRMLSegmentationNode
friend

Definition at line 285 of file vtkMRMLSegmentationDisplayNode.h.

Member Data Documentation

◆ NumberOfGeneratedColors

unsigned int vtkMRMLSegmentationDisplayNode::NumberOfGeneratedColors {0}
protected

Number of segments ever added to the segmentation belonging to this display node. Used to generate new color for new segments, taken into account removed segments too.

Definition at line 303 of file vtkMRMLSegmentationDisplayNode.h.

◆ Opacity2DFill

double vtkMRMLSegmentationDisplayNode::Opacity2DFill {0.5}
protected

2D fill opacity for the whole segmentation

Definition at line 321 of file vtkMRMLSegmentationDisplayNode.h.

◆ Opacity2DOutline

double vtkMRMLSegmentationDisplayNode::Opacity2DOutline {1.0}
protected

2D outline opacity for the whole segmentation

Definition at line 323 of file vtkMRMLSegmentationDisplayNode.h.

◆ Opacity3D

double vtkMRMLSegmentationDisplayNode::Opacity3D {1.0}
protected

3D opacity for the whole segmentation

Definition at line 319 of file vtkMRMLSegmentationDisplayNode.h.

◆ PreferredDisplayRepresentationName2D

char* vtkMRMLSegmentationDisplayNode::PreferredDisplayRepresentationName2D {nullptr}
protected

Name of representation that is displayed in 2D views as outline or filled area if exists. If does not exist, then master representation is displayed.

Definition at line 290 of file vtkMRMLSegmentationDisplayNode.h.

◆ PreferredDisplayRepresentationName3D

char* vtkMRMLSegmentationDisplayNode::PreferredDisplayRepresentationName3D {nullptr}
protected

Name of representation that is displayed as poly data in the 3D view. If does not exist, then master representation is displayed if poly data, otherwise the first poly data representation if any.

Definition at line 295 of file vtkMRMLSegmentationDisplayNode.h.

◆ SEGMENT_COLOR_NO_OVERRIDE

const double vtkMRMLSegmentationDisplayNode::SEGMENT_COLOR_NO_OVERRIDE
static

Definition at line 44 of file vtkMRMLSegmentationDisplayNode.h.

◆ SegmentationDisplayProperties

SegmentDisplayPropertiesMap vtkMRMLSegmentationDisplayNode::SegmentationDisplayProperties
protected

List of segment display properties for all segments in associated segmentation. Maps segment identifier string (segment name by default) to properties.

Definition at line 299 of file vtkMRMLSegmentationDisplayNode.h.

◆ SegmentListUpdateSource

vtkSegmentation* vtkMRMLSegmentationDisplayNode::SegmentListUpdateSource {nullptr}
protected

Definition at line 307 of file vtkMRMLSegmentationDisplayNode.h.

◆ SegmentListUpdateTime

vtkMTimeType vtkMRMLSegmentationDisplayNode::SegmentListUpdateTime {0}
protected

For checking if cached segment list in SegmentationDisplayProperties has to be updated.

Definition at line 306 of file vtkMRMLSegmentationDisplayNode.h.

◆ Visibility2DFill

bool vtkMRMLSegmentationDisplayNode::Visibility2DFill {true}
protected

2D fill visibility for the whole segmentation. In order for the fill to be visible,

See also
Visibility, Visibility2D, and Visibility2DFill need to be all enabled.

Definition at line 312 of file vtkMRMLSegmentationDisplayNode.h.

◆ Visibility2DOutline

bool vtkMRMLSegmentationDisplayNode::Visibility2DOutline {true}
protected

2D outline visibility for the whole segmentation. In order for the outline to be visible,

See also
Visibility, Visibility2D, and Visibility2DOutline need to be all enabled.

Definition at line 316 of file vtkMRMLSegmentationDisplayNode.h.


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