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

MRML node for referencing a collection of data to plot. More...

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

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

Public Types

enum  { PlotModifiedEvent = 17000 }
 
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

void AddAndObservePlotDataNodeID (const char *plotDataNodeID)
 
virtual void Copy (vtkMRMLNode *node) VTK_OVERRIDE
 Copy the node's attributes to this object. More...
 
virtual vtkMRMLNodeCreateNodeInstance () VTK_OVERRIDE
 Create instance of the default node. Like New only virtual. More...
 
virtual const char * GetClassName ()
 
vtkIdType GetColorPlotIndexFromID (const char *plotDataNodeID)
 
virtual const char * GetNodeTagName () VTK_OVERRIDE
 Get node XML tag name (like Volume, Model). More...
 
vtkMRMLPlotDataNodeGetNthPlotDataNode (int n)
 
const char * GetNthPlotDataNodeID (int n)
 
int GetNthPlotIndexFromID (const char *plotDataNodeID)
 
int GetNumberOfPlotDataNodes ()
 
vtkMRMLPlotDataNodeGetPlotDataNode ()
 
const char * GetPlotDataNodeID ()
 
virtual const char * GetPlotDataNodeReferenceRole ()
 
virtual int GetPlotIDs (std::vector< std::string > &plotDataNodeIDs)
 Get the list of Plot ids. More...
 
virtual int GetPlotNames (std::vector< std::string > &plotDataNodeNames)
 Get the list of Plot names. More...
 
bool HasPlotDataNodeID (const char *plotDataNodeID)
 Return true if PlotDataNodeID is in the plot node ID list. More...
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE
 
virtual void ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData) VTK_OVERRIDE
 Method to propagate events generated in mrml. More...
 
virtual void ReadXMLAttributes (const char **atts) VTK_OVERRIDE
 Set node attributes. More...
 
void RemoveAllPlotDataNodeIDs ()
 Remove all plot node IDs and associated plot nodes. More...
 
void RemoveNthPlotDataNodeID (int n)
 
void RemovePlotDataNodeID (const char *plotDataNodeID)
 
void SetAndObserveNthPlotDataNodeID (int n, const char *plotDataNodeID)
 
void SetAndObservePlotDataNodeID (const char *plotDataNodeID)
 Access methods. More...
 
virtual void WriteXML (ostream &of, int indent) VTK_OVERRIDE
 Write this node's information to a MRML file in XML format. More...
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=0)
 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=0, vtkIntArray *events=0)
 Add a referenceRole. More...
 
virtual void AddToSceneOff ()
 
virtual void AddToSceneOn ()
 
virtual void CopyReferences (vtkMRMLNode *node)
 Copy the references of the node into this. More...
 
void CopyWithoutModifiedEvent (vtkMRMLNode *node)
 
void CopyWithScene (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSceneWithSingleModifiedEvent (vtkMRMLNode *node)
 Copy everything (including Scene and ID) from another node of the same type. More...
 
void CopyWithSingleModifiedEvent (vtkMRMLNode *node)
 
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 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 ()
 Only the scene can set itself to the node. More...
 
virtual int GetSelectable ()
 Describes if the node is selectable. More...
 
virtual int GetSelected ()
 Get/Set for Selected. More...
 
virtual char * GetSingletonTag ()
 
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=NULL)
 This method allows the node to compress events. More...
 
virtual int InvokePendingModifiedEvent ()
 Invokes any modified events that are pending. More...
 
bool IsSingleton ()
 
virtual void Modified () VTK_OVERRIDE
 Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...
 
virtual void OnNodeAddedToScene ()
 
void PrintSelf (ostream &os, vtkIndent indent) VTK_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=0)
 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=0)
 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)
 
virtual void SetSceneReferences ()
 Update the references of the node to the scene. More...
 
virtual void SetSelectable (int)
 
virtual void SetSelected (int)
 
void SetSingletonOff ()
 
void SetSingletonOn ()
 
virtual void SetSingletonTag (const char *)
 Tag that make this node a singleton in the scene. More...
 
virtual int StartModify ()
 Start modifying the node. Disable Modify events. More...
 
virtual void UpdateReferenceID (const char *oldID, const char *newID)
 Update the stored reference to another node in the scene. More...
 
virtual void UpdateReferences ()
 The method should remove all pointers and observations to all nodes that are not in the scene anymore. More...
 
virtual void UpdateScene (vtkMRMLScene *)
 
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...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkMRMLPlotChartNodeNew ()
 Standard methods for MRML nodes. More...
 
static vtkMRMLPlotChartNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

virtual const char * GetPlotDataNodeReferenceMRMLAttributeName ()
 
virtual void OnNodeReferenceAdded (vtkMRMLNodeReference *reference) VTK_OVERRIDE
 Called when a node reference ID is added (list size increased). More...
 
virtual void OnNodeReferenceModified (vtkMRMLNodeReference *reference) VTK_OVERRIDE
 Called when a node reference ID is modified. More...
 
virtual void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) VTK_OVERRIDE
 Called after a node reference ID is removed (list size decreased). More...
 
void operator= (const vtkMRMLPlotChartNode &)
 
 vtkMRMLPlotChartNode ()
 Constructor and destroctor. More...
 
 vtkMRMLPlotChartNode (const vtkMRMLPlotChartNode &)
 
 ~vtkMRMLPlotChartNode ()
 
- Protected Member Functions inherited from vtkMRMLNode
virtual const char * GetMRMLAttributeNameFromReferenceRole (const char *refRole)
 Return the mrml attribute name (if found) associated with a reference role. Return 0 otherwise. More...
 
virtual const char * GetReferenceRoleFromMRMLAttributeName (const char *attName)
 Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise. More...
 
virtual char * GetTempURLString ()
 
void GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents)
 
virtual void InvalidateNodeReferences ()
 
virtual bool IsReferenceRoleGeneric (const char *refRole)
 Return true if the reference role is generic (ends with '/') or false otherwise. More...
 
void operator= (const vtkMRMLNode &)
 
void ParseReferencesAttribute (const char *attValue, std::map< std::string, 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=NULL)
 
virtual void UpdateNthNodeReference (const char *referenceRole, int n)
 
 vtkMRMLNode ()
 
 vtkMRMLNode (const vtkMRMLNode &)
 
virtual ~vtkMRMLNode ()
 critical to have a virtual destructor! More...
 

Static Protected Attributes

static const char * PlotDataNodeReferenceMRMLAttributeName
 
static const char * PlotDataNodeReferenceRole
 

Additional Inherited Members

- Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string > AttributesType
 
typedef std::map< std::string, vtkSmartPointer< vtkIntArray > > NodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
- Protected Attributes inherited from vtkMRMLNode
int AddToScene
 
AttributesType Attributes
 
char * Description
 
int HideFromEditors
 
char * ID
 
int InMRMLCallbackFlag
 Flag to avoid event loops. More...
 
vtkCallbackCommand * MRMLCallbackCommand
 Holders for MRML callbacks. More...
 
vtkObserverManagerMRMLObserverManager
 
char * Name
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene
 
vtkWeakPointer< vtkMRMLSceneScene
 
int Selectable
 
int Selected
 

Detailed Description

MRML node for referencing a collection of data to plot.

Definition at line 33 of file vtkMRMLPlotChartNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkMRMLPlotChartNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

PlotModifiedEvent is fired when:

  • a new plot node is observed
  • a plot node is not longer observed
  • an associated plot node is modified Note that when SetAndObserve(Nth)NodeID() is called with an ID that has not yet any associated plot node in the scene, then plotModifiedEvent is not fired until found for the first time in the scene, e.g. Get(Nth)PlotDataNode(), UpdateScene()...
Enumerator
PlotModifiedEvent 

Definition at line 77 of file vtkMRMLPlotChartNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLPlotChartNode() [1/2]

vtkMRMLPlotChartNode::vtkMRMLPlotChartNode ( )
protected

Constructor and destroctor.

◆ ~vtkMRMLPlotChartNode()

vtkMRMLPlotChartNode::~vtkMRMLPlotChartNode ( )
protected

◆ vtkMRMLPlotChartNode() [2/2]

vtkMRMLPlotChartNode::vtkMRMLPlotChartNode ( const vtkMRMLPlotChartNode )
protected

Member Function Documentation

◆ AddAndObservePlotDataNodeID()

void vtkMRMLPlotChartNode::AddAndObservePlotDataNodeID ( const char *  plotDataNodeID)

Convenience method that adds a plot node ID at the end of the list.

See also
SetAndObserverNthPlotDataNodeID(int, const char*)

◆ Copy()

virtual void vtkMRMLPlotChartNode::Copy ( vtkMRMLNode node)
virtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLNode.

◆ CreateNodeInstance()

virtual vtkMRMLNode* vtkMRMLPlotChartNode::CreateNodeInstance ( )
virtual

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

Note
Subclasses should implement this method

Implements vtkMRMLNode.

◆ GetClassName()

virtual const char* vtkMRMLPlotChartNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLNode.

◆ GetColorPlotIndexFromID()

vtkIdType vtkMRMLPlotChartNode::GetColorPlotIndexFromID ( const char *  plotDataNodeID)

Return an index to color each Plot. If not found, it return '-1'

◆ GetNodeTagName()

virtual const char* vtkMRMLPlotChartNode::GetNodeTagName ( )
inlinevirtual

Get node XML tag name (like Volume, Model).

Implements vtkMRMLNode.

Definition at line 61 of file vtkMRMLPlotChartNode.h.

◆ GetNthPlotDataNode()

vtkMRMLPlotDataNode* vtkMRMLPlotChartNode::GetNthPlotDataNode ( int  n)

Get associated plot MRML node. Can be 0 in temporary states; e.g. if the plot node has no scene, or if the associated plot is not yet into the scene. If not cached, it internally scans (slow) the scene to search for the associated plot node ID. If the plot node is no longer in the scene (GetScene() == 0), it happens after the node is removed from the scene (scene->RemoveNode(dn), the returned plot node is 0.

See also
GetNthPlotDataNodeByClass()

◆ GetNthPlotDataNodeID()

const char* vtkMRMLPlotChartNode::GetNthPlotDataNodeID ( int  n)

Return the string of the Nth plot node ID. Or 0 if no such node exist. Warning, a temporary char generated from a std::string::c_str() is returned.

◆ GetNthPlotIndexFromID()

int vtkMRMLPlotChartNode::GetNthPlotIndexFromID ( const char *  plotDataNodeID)

Return the index of the Nth plot node ID. If not found, it return '-1'

◆ GetNumberOfPlotDataNodes()

int vtkMRMLPlotChartNode::GetNumberOfPlotDataNodes ( )

Return the number of plot node IDs (and plot nodes as they always have the same size).

◆ GetPlotDataNode()

vtkMRMLPlotDataNode* vtkMRMLPlotChartNode::GetPlotDataNode ( )

Utility function that returns the first plot node.

See also
GetNthPlotDataNode(int), GetPlotDataNodeID()

◆ GetPlotDataNodeID()

const char* vtkMRMLPlotChartNode::GetPlotDataNodeID ( )

Utility function that returns the first plot node ID.

See also
GetNthPlotDataNodeID(int), GetPlotDataNode()

◆ GetPlotDataNodeReferenceMRMLAttributeName()

virtual const char* vtkMRMLPlotChartNode::GetPlotDataNodeReferenceMRMLAttributeName ( )
protectedvirtual

◆ GetPlotDataNodeReferenceRole()

virtual const char* vtkMRMLPlotChartNode::GetPlotDataNodeReferenceRole ( )
virtual

In addition a set of properties are available for a PlotChart. These are stored as Attributes of PlotChartNode. Available properties are:

  • "TitleName" - title ploted on the PlotChart
  • "ShowTitle" - show title "on" or "off"
  • "XAxisLabelName" - label ploted on the x-axis
  • "ShowXAxisLabel" - show x-axis label "on" or "off"
  • "ClickAndDragAlongX" - set the action along x-axis "on" or "off"
  • "ClickAndDragAlongY" - set the action along y-axis "on" or "off"
  • "YAxisLabelName" - label ploted on the y-axis
  • "ShowYAxisLabel" - show y-axis label "on" or "off"
  • "ShowGrid" - show grid "on" or "off"
  • "ShowLegend" - show legend "on" or "off"
  • "FontType" - global Font for the PlotChart: "Arial", "Times", "Courier"
  • "TitleFontSize" - default: "20"
  • "AxisTitleFontSize" - default: "16"
  • "AxisLabelFontSize" - default: "12"
  • "LookupTable" colorNodeID default: NULL

Further attributes of PlotChartNode are connected with the PlotDataProperties. If they are have value "Custom" then each PlotDataNode has its individual value. If another value is chosen, all the PlotDataNodes referenced by the PlotChartNode will be updated with the new value.

  • "Type" - "Custom", "Line", "Scatter", "Bar"
  • "XAxis" - Set XAxis "Custom", "..." (list of Columns)
  • "Markers" - show markers "Custom", "Cross", "Plus", "Square", "Circle", "Diamond"

◆ GetPlotIDs()

virtual int vtkMRMLPlotChartNode::GetPlotIDs ( std::vector< std::string > &  plotDataNodeIDs)
virtual

Get the list of Plot ids.

◆ GetPlotNames()

virtual int vtkMRMLPlotChartNode::GetPlotNames ( std::vector< std::string > &  plotDataNodeNames)
virtual

Get the list of Plot names.

◆ HasPlotDataNodeID()

bool vtkMRMLPlotChartNode::HasPlotDataNodeID ( const char *  plotDataNodeID)

Return true if PlotDataNodeID is in the plot node ID list.

◆ IsA()

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

Reimplemented from vtkMRMLNode.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLPlotChartNode* vtkMRMLPlotChartNode::New ( )
static

Standard methods for MRML nodes.

◆ OnNodeReferenceAdded()

virtual void vtkMRMLPlotChartNode::OnNodeReferenceAdded ( vtkMRMLNodeReference reference)
protectedvirtual

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

Reimplemented from vtkMRMLNode.

◆ OnNodeReferenceModified()

virtual void vtkMRMLPlotChartNode::OnNodeReferenceModified ( vtkMRMLNodeReference reference)
protectedvirtual

Called when a node reference ID is modified.

Reimplemented from vtkMRMLNode.

◆ OnNodeReferenceRemoved()

virtual void vtkMRMLPlotChartNode::OnNodeReferenceRemoved ( vtkMRMLNodeReference reference)
protectedvirtual

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

Reimplemented from vtkMRMLNode.

◆ operator=()

void vtkMRMLPlotChartNode::operator= ( const vtkMRMLPlotChartNode )
protected

◆ PrintSelf()

void vtkMRMLPlotChartNode::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ ProcessMRMLEvents()

virtual void vtkMRMLPlotChartNode::ProcessMRMLEvents ( vtkObject *  caller,
unsigned long  event,
void *  callData 
)
virtual

Method to propagate events generated in mrml.

Reimplemented from vtkMRMLNode.

◆ ReadXMLAttributes()

virtual void vtkMRMLPlotChartNode::ReadXMLAttributes ( const char **  atts)
virtual

Set node attributes.

Reimplemented from vtkMRMLNode.

◆ RemoveAllPlotDataNodeIDs()

void vtkMRMLPlotChartNode::RemoveAllPlotDataNodeIDs ( )

Remove all plot node IDs and associated plot nodes.

◆ RemoveNthPlotDataNodeID()

void vtkMRMLPlotChartNode::RemoveNthPlotDataNodeID ( int  n)

Convenience method that removes the Nth plot node ID from the list.

See also
SetAndObserverNthPlotDataNodeID(int, const char*)

◆ RemovePlotDataNodeID()

void vtkMRMLPlotChartNode::RemovePlotDataNodeID ( const char *  plotDataNodeID)

Convenience method that removes the plot node ID from the list.

See also
SetAndObserverNthPlotDataNodeID(int, const char*)

◆ SafeDownCast()

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

◆ SetAndObserveNthPlotDataNodeID()

void vtkMRMLPlotChartNode::SetAndObserveNthPlotDataNodeID ( int  n,
const char *  plotDataNodeID 
)

Set and observe the Nth plot node ID in the list. If n is larger than the number of plot nodes, the plot node ID is added at the end of the list. If PlotDataNodeID is 0, the node ID is removed from the list. When a node ID is set (added or changed), its corresponding node is searched (slow) into the scene and cached for fast future access. It is possible however that the node is not yet into the scene (due to some temporary state (at loading time for example). UpdateScene() can later be called to retrieve the plot nodes from the scene (automatically done when loading a scene). Get(Nth)PlotDataNode() also scan the scene if the node was not yet cached.

See also
SetAndObservePlotDataNodeID(const char*), AddAndObservePlotDataNodeID(const char *), RemoveNthPlotDataNodeID(int)

◆ SetAndObservePlotDataNodeID()

void vtkMRMLPlotChartNode::SetAndObservePlotDataNodeID ( const char *  plotDataNodeID)

Access methods.

Convenience method that sets the first plot node ID.

See also
SetAndObserverNthPlotDataNodeID(int, const char*)

◆ WriteXML()

virtual void vtkMRMLPlotChartNode::WriteXML ( ostream &  of,
int  indent 
)
virtual

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

Reimplemented from vtkMRMLNode.

Member Data Documentation

◆ PlotDataNodeReferenceMRMLAttributeName

const char* vtkMRMLPlotChartNode::PlotDataNodeReferenceMRMLAttributeName
staticprotected

Definition at line 226 of file vtkMRMLPlotChartNode.h.

◆ PlotDataNodeReferenceRole

const char* vtkMRMLPlotChartNode::PlotDataNodeReferenceRole
staticprotected

Definition at line 225 of file vtkMRMLPlotChartNode.h.


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