![]() |
Slicer
4.8
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
MRML node for referencing a collection of data to plot. More...
#include <Libs/MRML/Core/vtkMRMLPlotChartNode.h>
Public Types | |
enum | { PlotModifiedEvent = 17000 } |
typedef vtkMRMLNode | Superclass |
![]() | |
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 vtkMRMLNode * | CreateNodeInstance () 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... | |
vtkMRMLPlotDataNode * | GetNthPlotDataNode (int n) |
const char * | GetNthPlotDataNodeID (int n) |
int | GetNthPlotIndexFromID (const char *plotDataNodeID) |
int | GetNumberOfPlotDataNodes () |
vtkMRMLPlotDataNode * | GetPlotDataNode () |
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... | |
![]() | |
vtkMRMLNode * | AddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=0) |
Add and observe a reference node from this node for a specific referenceRole. More... | |
vtkMRMLNode * | AddNodeReferenceID (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 () |
vtkMRMLNode * | GetNodeReference (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... | |
vtkMRMLNode * | GetNthNodeReference (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 vtkMRMLScene * | GetScene () |
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) |
vtkMRMLNode * | SetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=0) |
Set and observe a reference node from this node for a specific referenceRole. More... | |
vtkMRMLNode * | SetAndObserveNthNodeReferenceID (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... | |
vtkMRMLNode * | SetNodeReferenceID (const char *referenceRole, const char *referencedNodeID) |
Set a reference to a node with specified nodeID from this node for a specific referenceRole. More... | |
vtkMRMLNode * | SetNthNodeReferenceID (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 vtkMRMLPlotChartNode * | New () |
Standard methods for MRML nodes. More... | |
static vtkMRMLPlotChartNode * | SafeDownCast (vtkObject *o) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkMRMLNode * | SafeDownCast (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 () | |
![]() | |
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... | |
vtkMRMLNode * | UpdateNodeReferenceEventObserver (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 | |
![]() | |
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, NodeReferenceListType > | NodeReferencesType |
![]() | |
static void | MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData) |
![]() | |
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... | |
vtkObserverManager * | MRMLObserverManager |
char * | Name |
NodeReferenceEventsType | NodeReferenceEvents |
std::map< std::string, std::string > | NodeReferenceMRMLAttributeNames |
NodeReferencesType | NodeReferences |
int | SaveWithScene |
vtkWeakPointer< vtkMRMLScene > | Scene |
int | Selectable |
int | Selected |
MRML node for referencing a collection of data to plot.
Definition at line 33 of file vtkMRMLPlotChartNode.h.
Definition at line 41 of file vtkMRMLPlotChartNode.h.
anonymous enum |
PlotModifiedEvent is fired when:
Enumerator | |
---|---|
PlotModifiedEvent |
Definition at line 77 of file vtkMRMLPlotChartNode.h.
|
protected |
Constructor and destroctor.
|
protected |
|
protected |
void vtkMRMLPlotChartNode::AddAndObservePlotDataNodeID | ( | const char * | plotDataNodeID | ) |
Convenience method that adds a plot node ID at the end of the list.
|
virtual |
Copy the node's attributes to this object.
Reimplemented from vtkMRMLNode.
|
virtual |
Create instance of the default node. Like New only virtual.
Implements vtkMRMLNode.
|
virtual |
Reimplemented from vtkMRMLNode.
vtkIdType vtkMRMLPlotChartNode::GetColorPlotIndexFromID | ( | const char * | plotDataNodeID | ) |
Return an index to color each Plot. If not found, it return '-1'
|
inlinevirtual |
Get node XML tag name (like Volume, Model).
Implements vtkMRMLNode.
Definition at line 61 of file vtkMRMLPlotChartNode.h.
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.
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.
int vtkMRMLPlotChartNode::GetNthPlotIndexFromID | ( | const char * | plotDataNodeID | ) |
Return the index of the Nth plot node ID. If not found, it return '-1'
int vtkMRMLPlotChartNode::GetNumberOfPlotDataNodes | ( | ) |
Return the number of plot node IDs (and plot nodes as they always have the same size).
vtkMRMLPlotDataNode* vtkMRMLPlotChartNode::GetPlotDataNode | ( | ) |
Utility function that returns the first plot node.
const char* vtkMRMLPlotChartNode::GetPlotDataNodeID | ( | ) |
Utility function that returns the first plot node ID.
|
protectedvirtual |
|
virtual |
In addition a set of properties are available for a PlotChart. These are stored as Attributes of PlotChartNode. Available properties are:
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.
|
virtual |
Get the list of Plot ids.
|
virtual |
Get the list of Plot names.
bool vtkMRMLPlotChartNode::HasPlotDataNodeID | ( | const char * | plotDataNodeID | ) |
Return true if PlotDataNodeID is in the plot node ID list.
|
virtual |
Reimplemented from vtkMRMLNode.
|
static |
|
static |
Standard methods for MRML nodes.
|
protectedvirtual |
Called when a node reference ID is added (list size increased).
Reimplemented from vtkMRMLNode.
|
protectedvirtual |
Called when a node reference ID is modified.
Reimplemented from vtkMRMLNode.
|
protectedvirtual |
Called after a node reference ID is removed (list size decreased).
Reimplemented from vtkMRMLNode.
|
protected |
void vtkMRMLPlotChartNode::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
virtual |
Method to propagate events generated in mrml.
Reimplemented from vtkMRMLNode.
|
virtual |
Set node attributes.
Reimplemented from vtkMRMLNode.
void vtkMRMLPlotChartNode::RemoveAllPlotDataNodeIDs | ( | ) |
Remove all plot node IDs and associated plot nodes.
void vtkMRMLPlotChartNode::RemoveNthPlotDataNodeID | ( | int | n | ) |
Convenience method that removes the Nth plot node ID from the list.
void vtkMRMLPlotChartNode::RemovePlotDataNodeID | ( | const char * | plotDataNodeID | ) |
Convenience method that removes the plot node ID from the list.
|
static |
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.
void vtkMRMLPlotChartNode::SetAndObservePlotDataNodeID | ( | const char * | plotDataNodeID | ) |
Access methods.
Convenience method that sets the first plot node ID.
|
virtual |
Write this node's information to a MRML file in XML format.
Reimplemented from vtkMRMLNode.
|
staticprotected |
Definition at line 226 of file vtkMRMLPlotChartNode.h.
|
staticprotected |
Definition at line 225 of file vtkMRMLPlotChartNode.h.