MRML node to represent chart view parameters. More...

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

Inheritance diagram for vtkMRMLChartViewNode:

Collaboration diagram for vtkMRMLChartViewNode:

Public Types
enum	{ ChartNodeChangedEvent = 16000 }
	Events. More...

typedef vtkMRMLAbstractViewNode	Superclass

Public Types inherited from vtkMRMLAbstractViewNode
enum	OrientationMarkerSizeType { OrientationMarkerSizeSmall =0, OrientationMarkerSizeMedium, OrientationMarkerSizeLarge, OrientationMarkerSize_Last }

enum	OrientationMarkerTypeType { OrientationMarkerTypeNone =0, OrientationMarkerTypeCube, OrientationMarkerTypeHuman, OrientationMarkerTypeAxes, OrientationMarkerType_Last }
	Enum to specify orientation marker types. More...

enum	RulerTypeType { RulerTypeNone =0, RulerTypeThin, RulerTypeThick, RulerType_Last }
	Enum to specify orientation marker types. More...

typedef vtkMRMLNode	Superclass

Public Types inherited from vtkMRMLNode
enum	{ HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent, ReferenceRemovedEvent, ReferencedNodeModifiedEvent }

typedef vtkObject	Superclass

Public Member Functions
virtual void	Copy (vtkMRMLNode *node) VTK_OVERRIDE
	Copy the node's attributes to this object. More...

virtual vtkMRMLNode *	CreateNodeInstance () VTK_OVERRIDE
	MRMLNode methods. More...

virtual char *	GetChartNodeID ()
	Get the Chart node id displayed in this Chart View. More...

virtual const char *	GetClassName ()

virtual const char *	GetNodeTagName () VTK_OVERRIDE
	Get node XML tag name (like Volume, Model) More...

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

virtual void	ReadXMLAttributes (const char **atts) VTK_OVERRIDE
	Read node attributes from XML file. More...

void	SetChartNodeID (const char *)
	Set the Chart node id displayed in this Chart View. More...

virtual void	UpdateReferenceID (const char oldID, const char newID) VTK_OVERRIDE
	Update the stored reference to another node in the scene. More...

virtual void	UpdateReferences () VTK_OVERRIDE

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 vtkMRMLAbstractViewNode
virtual int	GetActive ()
	Indicates whether or not the view is active. More...

const char *	GetAxisLabel (int labelIndex)

virtual double *	GetBackgroundColor ()

virtual void	GetBackgroundColor (double &, double &, double &)

virtual void	GetBackgroundColor (double [3])

virtual double *	GetBackgroundColor2 ()

virtual void	GetBackgroundColor2 (double &, double &, double &)

virtual void	GetBackgroundColor2 (double [3])

virtual char *	GetLayoutLabel ()

const char *	GetLayoutName ()

virtual bool	GetOrientationMarkerEnabled ()

vtkMRMLModelNode *	GetOrientationMarkerHumanModelNode ()

const char *	GetOrientationMarkerHumanModelNodeID ()

virtual int	GetOrientationMarkerSize ()

virtual int	GetOrientationMarkerType ()

virtual bool	GetRulerEnabled ()

virtual int	GetRulerType ()

virtual int	GetViewGroup ()

virtual int	GetVisibility ()
	Indicates whether or not the view is visible. More...

virtual int	IsMappedInLayout ()

bool	IsViewVisibleInLayout ()
	Indicates whether or not the view is visible in the current layout. More...

void	PrintSelf (ostream &os, vtkIndent indent) VTK_OVERRIDE

virtual void	Reset (vtkMRMLNode *defaultNode) VTK_OVERRIDE
	Reimplemented to preserve layout label when reset. More...

virtual void	SetActive (int)

void	SetAxisLabel (int labelIndex, const char *label)

virtual void	SetBackgroundColor (double [3])

virtual void	SetBackgroundColor (double, double, double)

virtual void	SetBackgroundColor2 (double, double, double)

virtual void	SetBackgroundColor2 (double [3])

virtual void	SetLayoutLabel (const char *)

void	SetLayoutName (const char *layoutName)

virtual void	SetMappedInLayout (int value)

void	SetOrientationMarkerHumanModelNodeID (const char *modelNodeId)

virtual void	SetOrientationMarkerSize (int)
	Get/Set orientation marker is size. There are a few predefined marker sizes, defined by an enumerated value (e.g., small, medium, large). More...

virtual void	SetOrientationMarkerType (int)
	Get/Set orientation marker type (e.g., not displayed, cube, human, coordinate system axes) More...

virtual void	SetRulerType (int)
	Get/Set ruler type (e.g., not displayed, thin, thick) More...

virtual void	SetViewGroup (int)

virtual void	SetVisibility (int)

Public Member Functions inherited from vtkMRMLNode
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...

virtual void	ProcessMRMLEvents (vtkObject caller, unsigned long event, void callData)
	Propagate events generated in mrml. 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	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	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 vtkMRMLChartViewNode *	New ()

static vtkMRMLChartViewNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLAbstractViewNode
static const char *	GetOrientationMarkerSizeAsString (int id)
	Convert between orientation marker type ID and name. More...

static int	GetOrientationMarkerSizeFromString (const char *name)

static const char *	GetOrientationMarkerTypeAsString (int id)
	Convert between orientation marker type ID and name. More...

static int	GetOrientationMarkerTypeFromString (const char *name)

static const char *	GetRulerTypeAsString (int id)
	Convert between ruler type ID and name. More...

static int	GetRulerTypeFromString (const char *name)

static int	IsTypeOf (const char *type)

static vtkMRMLAbstractViewNode *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLNode
static int	IsTypeOf (const char *type)

static vtkMRMLNode *	SafeDownCast (vtkObject *o)

Protected Member Functions
void	operator= (const vtkMRMLChartViewNode &)

	vtkMRMLChartViewNode ()

	vtkMRMLChartViewNode (const vtkMRMLChartViewNode &)

	~vtkMRMLChartViewNode ()

Protected Member Functions inherited from vtkMRMLAbstractViewNode
void	operator= (const vtkMRMLAbstractViewNode &)

virtual void	RemoveActiveFlagInScene ()
	When a view is set Active, make other views inactive. More...

	vtkMRMLAbstractViewNode ()

	vtkMRMLAbstractViewNode (const vtkMRMLAbstractViewNode &)

	~vtkMRMLAbstractViewNode ()

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 NULL). 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...

Protected Attributes
char *	ChartNodeID

Protected Attributes inherited from vtkMRMLAbstractViewNode
int	Active

vtkSmartPointer< vtkStringArray >	AxisLabels
	Labels of coordinate system axes. More...

double	BackgroundColor [3]
	Background colors. More...

double	BackgroundColor2 [3]

char *	LayoutLabel
	Label to show for the view (shortcut for the name) More...

bool	OrientationMarkerEnabled

int	OrientationMarkerSize

int	OrientationMarkerType

bool	RulerEnabled

int	RulerType

int	ViewGroup
	Views with the same ViewGroup value are in the same group. More...

int	Visibility

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...

vtkObserverManager *	MRMLObserverManager

char *	Name

NodeReferenceEventsType	NodeReferenceEvents

std::map< std::string, std::string >	NodeReferenceMRMLAttributeNames

NodeReferencesType	NodeReferences

int	SaveWithScene

vtkWeakPointer< vtkMRMLScene >	Scene

int	Selectable

int	Selected

Additional Inherited Members
Static Public Attributes inherited from vtkMRMLAbstractViewNode
static const int	AxisLabelsCount
	Total number of coordinate system axis labels. More...

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, NodeReferenceListType >	NodeReferencesType

Static Protected Member Functions inherited from vtkMRMLNode
static void	MRMLCallback (vtkObject caller, unsigned long eid, void clientData, void *callData)

Static Protected Attributes inherited from vtkMRMLAbstractViewNode
static const char *	OrientationMarkerHumanModelMRMLAttributeName

static const char *	OrientationMarkerHumanModelReferenceRole

Detailed Description

MRML node to represent chart view parameters.

ChartViewNodes are associated one to one with a ChartWidget.

Definition at line 23 of file vtkMRMLChartViewNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLAbstractViewNode vtkMRMLChartViewNode::Superclass

Definition at line 27 of file vtkMRMLChartViewNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Events.

Enumerator
ChartNodeChangedEvent

Definition at line 72 of file vtkMRMLChartViewNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLChartViewNode() [1/2]

vtkMRMLChartViewNode::vtkMRMLChartViewNode ( )

protected

◆ ~vtkMRMLChartViewNode()

vtkMRMLChartViewNode::~vtkMRMLChartViewNode ( )

protected

◆ vtkMRMLChartViewNode() [2/2]

vtkMRMLChartViewNode::vtkMRMLChartViewNode ( const vtkMRMLChartViewNode & )

protected

Member Function Documentation

◆ Copy()

virtual void vtkMRMLChartViewNode::Copy ( vtkMRMLNode * node )

virtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLAbstractViewNode.

◆ CreateNodeInstance()

virtual vtkMRMLNode* vtkMRMLChartViewNode::CreateNodeInstance ( )

virtual

MRMLNode methods.

Implements vtkMRMLNode.

◆ GetChartNodeID()

virtual char* vtkMRMLChartViewNode::GetChartNodeID ( )

virtual

Get the Chart node id displayed in this Chart View.

◆ GetClassName()

virtual const char* vtkMRMLChartViewNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLAbstractViewNode.

◆ GetNodeTagName()

virtual const char* vtkMRMLChartViewNode::GetNodeTagName ( )

virtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

◆ IsA()

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

virtual

Reimplemented from vtkMRMLAbstractViewNode.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLChartViewNode* vtkMRMLChartViewNode::New ( )

static

◆ operator=()

void vtkMRMLChartViewNode::operator= ( const vtkMRMLChartViewNode & )

protected

◆ PrintSelf()

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

◆ ReadXMLAttributes()

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

virtual

Read node attributes from XML file.

Reimplemented from vtkMRMLAbstractViewNode.

◆ SafeDownCast()

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

static

◆ SetChartNodeID()

void vtkMRMLChartViewNode::SetChartNodeID ( const char * )

Set the Chart node id displayed in this Chart View.

◆ UpdateReferenceID()

virtual void vtkMRMLChartViewNode::UpdateReferenceID	(	const char *	oldID,
		const char *	newID
	)

virtual

Update the stored reference to another node in the scene.

Reimplemented from vtkMRMLNode.

◆ UpdateReferences()

virtual void vtkMRMLChartViewNode::UpdateReferences ( )

virtual

Updates this node if it depends on other nodes when the node is deleted in the scene

Reimplemented from vtkMRMLNode.

◆ WriteXML()

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

virtual

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

Reimplemented from vtkMRMLAbstractViewNode.

Member Data Documentation

◆ ChartNodeID

char* vtkMRMLChartViewNode::ChartNodeID

protected

Definition at line 83 of file vtkMRMLChartViewNode.h.

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

Libs/MRML/Core/vtkMRMLChartViewNode.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkMRMLChartViewNode() [1/2]

◆ ~vtkMRMLChartViewNode()

◆ vtkMRMLChartViewNode() [2/2]

Member Function Documentation

◆ Copy()

◆ CreateNodeInstance()

◆ GetChartNodeID()

◆ GetClassName()

◆ GetNodeTagName()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ ReadXMLAttributes()

◆ SafeDownCast()

◆ SetChartNodeID()

◆ UpdateReferenceID()

◆ UpdateReferences()

◆ WriteXML()

Member Data Documentation

◆ ChartNodeID