MRML list node to represent a list of ROINODE. More...

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

Inheritance diagram for vtkMRMLROIListNode:

[legend]

Collaboration diagram for vtkMRMLROIListNode:

[legend]

Public Types
enum	{ DisplayModifiedEvent = 21000 , PolyDataModifiedEvent = 21001 , ROIModifiedEvent = 21002 }

typedef vtkMRMLNode	Superclass

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

enum	ContentModifiedObserveType { ContentModifiedObserveUndefined = -1 , ContentModifiedObserveDisabled = 0 , ContentModifiedObserveEnabled = 1 }

typedef std::map< std::string, std::string >	ReferencePropertiesType
	Get the node reference properties for a specific referenceRole.

typedef vtkObject	Superclass

Public Member Functions
int	AddROI ()
	Add an ROI to the list with default values.

void	Copy (vtkMRMLNode *node) override
	Copy the node's attributes to this object.

vtkMRMLNode *	CreateNodeInstance () override
	MRMLNode methods.

virtual double	GetAmbient ()

virtual const char *	GetClassName ()

virtual double *	GetColor ()

virtual void	GetColor (double data[3])

virtual double	GetDiffuse ()

const char *	GetNodeTagName () override
	Get node XML tag name (like Volume, Model)

const char *	GetNthROIID (int n)

double *	GetNthROIIJK (int n)

const char *	GetNthROILabelText (int n)

vtkMRMLROINode *	GetNthROINode (int n)

double *	GetNthROIRadiusIJK (int n)

double *	GetNthROIRadiusXYZ (int n)

int	GetNthROISelected (int n)

double *	GetNthROIXYZ (int n)

int	GetNumberOfROIs ()
	Get the number of ROIs in the list.

virtual double	GetOpacity ()

virtual double	GetPower ()

virtual double *	GetSelectedColor ()

virtual void	GetSelectedColor (double data[3])

virtual double	GetSpecular ()

virtual double	GetTextScale ()

virtual int	GetVisibility ()

virtual char *	GetVolumeNodeID ()
	Get/Set for the volume ID associated with the ROI.

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	ProcessMRMLEvents (vtkObject caller, unsigned long event, void callData) override
	Propagate events generated in mrml.

void	ReadXMLAttributes (const char **atts) override
	Set node attributes.

void	RemoveAllROIs ()
	Remove all ROIs from the list.

void	RemoveROI (int i)
	Remove an ROI from the list.

void	SetAllVolumeNodeID ()
	Set the Volume node ID for each ROI node in the list.

virtual void	SetAmbient (double)
	Ambient of the ROI expressed as a number from 0 to 100.

void	SetColor (double c[3])

void	SetColor (double r, double g, double b)
	Get/Set for ROI and Text color.

virtual void	SetDiffuse (double)
	Diffuse of the ROI expressed as a number from 0 to 100.

int	SetNthROIID (int n, const char *id)
	Get/Set for ID of the Nth ROI.

int	SetNthROIIJK (int n, double i, double j, double k)

int	SetNthROILabelText (int n, const char *text)
	Get/Set for label text of the Nth ROI.

int	SetNthROIRadiusIJK (int n, double Radiusi, double Radiusj, double Radiusk)
	Get/Set for Nth radius of the ROI in IJK coordinates.

int	SetNthROIRadiusXYZ (int n, double Radiusx, double Radiusy, double Radiusz)
	Get/Set for Nth radius of the ROI in RAS coordinates.

int	SetNthROISelected (int n, int flag)
	Get/Set for selected flag of the Nth ROI.

int	SetNthROIXYZ (int n, double x, double y, double z)

void	SetOpacity (double opacity)
	Opacity of the ROI expressed as a number from 0 to 1.

virtual void	SetPower (double)
	Power of the ROI expressed as a number from 0 to 100.

void	SetSelectedColor (double c[3])

void	SetSelectedColor (double r, double g, double b)
	Get/Set for color for when an ROI is selected.

virtual void	SetSpecular (double)
	Specular of the ROI expressed as a number from 0 to 100.

void	SetTextScale (double scale)
	Get/Set for Text scale.

void	SetVisibility (int visible)
	Get/Set for list visibility.

virtual void	SetVolumeNodeID (const char *)

void	UpdateIJK ()

void	UpdateReferences () override
	update display node ids

void	UpdateScene (vtkMRMLScene *scene) override

void	WriteXML (ostream &of, int indent) override
	Write this node's information to a MRML file in XML format.

Public Member Functions inherited from vtkMRMLNode
vtkMRMLNode *	AddAndObserveNodeReferenceID (const char referenceRole, const char referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Add and observe a reference node from this node for a specific referenceRole.

vtkMRMLNode *	AddNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Convenience method that adds a referencedNodeID at the end of the list.

void	AddNodeReferenceRole (const char referenceRole, const char mrmlAttributeName=nullptr, vtkIntArray *events=nullptr, bool observeContentModifiedEvents=false)
	Add a referenceRole.

virtual void	AddToSceneOff ()

virtual void	AddToSceneOn ()

void	ClearNodeReferenceProperties (const std::string &referenceRole)
	Remove all node reference properties for a specific referenceRole.

void	ClearNthNodeReferenceProperties (const std::string &referenceRole, int n)

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.

virtual void	CopyReferences (vtkMRMLNode *node)
	Copy the references of the node into this.

void	CopyWithScene (vtkMRMLNode *node)
	Copy everything (including Scene and ID) from another node of the same type.

void	DisableModifiedEventOff ()

void	DisableModifiedEventOn ()

virtual int	EndModify (int previousDisableModifiedEventState)
	End modifying the node.

virtual int	GetAddToScene ()
	node added to MRML scene.

const char *	GetAttribute (const char *name)
	Get value of a name value pair attribute.

std::vector< std::string >	GetAttributeNames ()
	Get all attribute names.

void	GetAttributeNames (vtkStringArray *attributeNames)
	Get all attribute names. Python-wrappable version.

virtual vtkIntArray *	GetContentModifiedEvents ()

int	GetCustomModifiedEventPending (int eventId)

virtual char *	GetDescription ()

virtual int	GetDisableModifiedEvent ()
	Turn on/off generating InvokeEvent for set macros.

virtual int	GetHideFromEditors ()
	Describes if the node is hidden.

virtual char *	GetID ()
	ID use by other nodes to reference this node in XML.

virtual int	GetInMRMLCallbackFlag ()
	Flags to avoid event loops.

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.

void	GetNodeReferenceIDs (const char referenceRole, std::vector< const char > &referencedNodeIDs)
	Return a list of the referenced node IDs.

const ReferencePropertiesType *	GetNodeReferenceProperties (const char *referenceRole)

std::string	GetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
	Get the node reference property for a specific referenceRole.

std::string	GetNodeReferencePropertyName (const std::string &referenceRole, int propertyIndex)
	Get the name of the Nth node reference property for a specific referenceRole.

std::vector< std::string >	GetNodeReferencePropertyNames (const std::string &referenceRole)
	Get the names of all node reference properties for a specific referenceRole.

void	GetNodeReferenceRoles (std::vector< std::string > &roles)

void	GetNodeReferences (const char referenceRole, std::vector< vtkMRMLNode > &nodes)
	Return a list of the referenced nodes.

vtkMRMLNode *	GetNthNodeReference (const char *referenceRole, int n)
	Get referenced MRML node for a specific referenceRole.

const char *	GetNthNodeReferenceID (const char *referenceRole, int n)
	Return the string of the Nth node ID for a specific reference role.

const ReferencePropertiesType *	GetNthNodeReferenceProperties (const char *referenceRole, int n)

std::string	GetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)

std::string	GetNthNodeReferencePropertyName (const std::string &referenceRole, int referenceIndex, int propertyIndex)

std::vector< std::string >	GetNthNodeReferencePropertyNames (const std::string &referenceRole, int n)

const char *	GetNthNodeReferenceRole (int n)

int	GetNumberOfNodeReferenceProperties (const std::string &referenceRole)
	Get the number of node reference properties for a specific referenceRole.

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

int	GetNumberOfNthNodeReferenceProperties (const std::string &referenceRole, int n)

virtual int	GetSaveWithScene ()
	Save node with MRML scene.

virtual vtkMRMLScene *	GetScene ()
	Get the scene this node has been added to.

virtual int	GetSelectable ()
	Describes if the node is selectable.

virtual int	GetSelected ()
	Get/Set for Selected.

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.

bool	HasNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Return true if referencedNodeID is in the node ID list for a specific referenceRole.

virtual void	HideFromEditorsOff ()

virtual void	HideFromEditorsOn ()

virtual void	InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
	This method allows the node to compress events.

virtual int	InvokePendingModifiedEvent ()
	Invokes any modified events that are `pending`.

bool	IsSingleton ()

void	Modified () override
	Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent.

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.

void	RemoveAttribute (const char *name)
	Remove attribute with the specified name.

void	RemoveNodeReferenceIDs (const char *referenceRole)
	Remove all node IDs and associated nodes for a specific referenceRole.

void	RemoveNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName)
	Remove a node reference property for a specific referenceRole.

void	RemoveNthNodeReferenceID (const char *referenceRole, int n)
	Convenience method that removes the Nth node ID from the list.

void	RemoveNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName)

virtual void	Reset (vtkMRMLNode *defaultNode)
	Reset node attributes to the initial state as defined in the constructor or the passed default node.

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=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Set and observe a reference node from this node for a specific referenceRole.

vtkMRMLNode *	SetAndObserveNthNodeReferenceID (const char referenceRole, int n, const char referencedNodeID, vtkIntArray *events=nullptr, ContentModifiedObserveType observeContentModifiedEvents=ContentModifiedObserveUndefined)
	Set and observe the Nth node ID for a specific reference role.

void	SetAttribute (const char name, const char value)
	Set a name value pair attribute.

virtual void	SetDescription (const char *)
	Text description of this node, to be set by the user.

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.

vtkMRMLNode *	SetNodeReferenceID (const char referenceRole, const char referencedNodeID)
	Set a reference to a node with specified nodeID from this node for a specific referenceRole.

void	SetNodeReferenceProperty (const std::string &referenceRole, const std::string &propertyName, const std::string &value)
	Set the node reference property for a specific referenceRole.

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.

void	SetNthNodeReferenceProperty (const std::string &referenceRole, int n, const std::string &propertyName, const std::string &value)

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.

virtual void	SetSceneReferences ()
	Update the references of the node to the scene.

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.

virtual void	SetUndoEnabled (bool)

virtual int	StartModify ()
	Start modifying the node. Disable Modify events.

virtual void	UndoEnabledOff ()

virtual void	UndoEnabledOn ()

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

const char *	URLDecodeString (const char *inString)
	Decode a URL string.

const char *	URLEncodeString (const char *inString)
	Encode a URL string.

virtual void	WriteNodeBodyXML (ostream &of, int indent)
	Write this node's body to a MRML file in XML format.

std::string	XMLAttributeDecodeString (const std::string &inString)
	Decode an XML attribute string.

std::string	XMLAttributeEncodeString (const std::string &inString)
	Encode an XML attribute string (replaces special characters by code sequences)

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

static vtkMRMLROIListNode *	New ()

static vtkMRMLROIListNode *	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 vtkMRMLROIListNode &)

	vtkMRMLROIListNode ()

	vtkMRMLROIListNode (const vtkMRMLROIListNode &)

	~vtkMRMLROIListNode () 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.

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.

virtual char *	GetTempURLString ()

void	GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray oldConsolidatedEventList, vtkIntArray newConsolidatedEventList, vtkMRMLNode oldReferencedNode, vtkMRMLNode newReferencedNode, vtkMRMLNodeReference referenceToIgnore, vtkIntArray newEvents, bool newObserveContentModifiedEvents)

virtual void	InvalidateNodeReferences ()

virtual bool	IsReferenceRoleGeneric (const char *refRole)
	Return true if the reference role is generic (ends with '/') or false otherwise.

std::string	NodeReferencePropertyDecodeString (const std::string &inString)
	Decode a node reference property string.

std::string	NodeReferencePropertyEncodeString (const std::string &inString)
	Encode a node reference property string (replaces special characters by code sequences)

virtual void	OnNodeReferenceAdded (vtkMRMLNodeReference *reference)

virtual void	OnNodeReferenceModified (vtkMRMLNodeReference *reference)
	Called when a referenced node pointer is modified.

virtual void	OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
	Called when a referenced node pointer is removed (set to nullptr).

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.

vtkMRMLNode *	UpdateNodeReferenceEventObserver (vtkMRMLNode oldReferencedNode, vtkMRMLNode newReferencedNode, vtkIntArray newEvents, bool newObserveContentModifiedEvents, 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!

Protected Attributes
double	Ambient

double	Color [3]

double	Diffuse

double	Opacity
	Numbers relating to the 3D render of the ROI.

double	Power

vtkCollection *	ROIList
	The collection of ROI that make up this list.

double	SelectedColor [3]

double	Specular

double	TextScale

int	Visibility

char *	VolumeNodeID
	The ID of the volume node that is associated with the ROI.

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.

vtkCallbackCommand *	MRMLCallbackCommand
	Holders for MRML callbacks.

vtkObserverManager *	MRMLObserverManager

char *	Name {nullptr}

NodeReferenceEventsType	NodeReferenceEvents

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

NodeReferencesType	NodeReferences

int	SaveWithScene {true}

vtkWeakPointer< vtkMRMLScene >	Scene

int	Selectable {1}

int	Selected {0}

bool	UndoEnabled {false}

Additional Inherited Members
Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string >	AttributesType

typedef std::map< std::string, NodeReferenceEventList >	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)

Detailed Description

MRML list node to represent a list of ROINODE.

Definition at line 10 of file vtkMRMLROIListNode.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLNode vtkMRMLROIListNode::Superclass

Definition at line 14 of file vtkMRMLROIListNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

DisplayModifiedEvent is generated when display node parameters is changed PolyDataModifiedEvent is generated when something else is changed

Enumerator
DisplayModifiedEvent
PolyDataModifiedEvent
ROIModifiedEvent

Definition at line 100 of file vtkMRMLROIListNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLROIListNode() [1/2]

vtkMRMLROIListNode::vtkMRMLROIListNode ( )

protected

◆ ~vtkMRMLROIListNode()

vtkMRMLROIListNode::~vtkMRMLROIListNode ( )

overrideprotected

◆ vtkMRMLROIListNode() [2/2]

vtkMRMLROIListNode::vtkMRMLROIListNode ( const vtkMRMLROIListNode & )

protected

Member Function Documentation

◆ AddROI()

int vtkMRMLROIListNode::AddROI ( )

Add an ROI to the list with default values.

◆ Copy()

void vtkMRMLROIListNode::Copy ( vtkMRMLNode * node )

overridevirtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLNode.

◆ CreateNodeInstance()

vtkMRMLNode * vtkMRMLROIListNode::CreateNodeInstance ( )

overridevirtual

MRMLNode methods.

Implements vtkMRMLNode.

◆ GetAmbient()

virtual double vtkMRMLROIListNode::GetAmbient ( )

virtual

◆ GetClassName()

virtual const char * vtkMRMLROIListNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLNode.

◆ GetColor() [1/2]

virtual double * vtkMRMLROIListNode::GetColor ( )

virtual

◆ GetColor() [2/2]

virtual void vtkMRMLROIListNode::GetColor ( double data[3] )

virtual

◆ GetDiffuse()

virtual double vtkMRMLROIListNode::GetDiffuse ( )

virtual

◆ GetNodeTagName()

const char * vtkMRMLROIListNode::GetNodeTagName ( )

inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Definition at line 36 of file vtkMRMLROIListNode.h.

◆ GetNthROIID()

const char * vtkMRMLROIListNode::GetNthROIID ( int n )

◆ GetNthROIIJK()

double * vtkMRMLROIListNode::GetNthROIIJK ( int n )

◆ GetNthROILabelText()

const char * vtkMRMLROIListNode::GetNthROILabelText ( int n )

◆ GetNthROINode()

vtkMRMLROINode * vtkMRMLROIListNode::GetNthROINode ( int n )

disallow access to the ROI box by outside classes, have them use SetNthROI

◆ GetNthROIRadiusIJK()

double * vtkMRMLROIListNode::GetNthROIRadiusIJK ( int n )

◆ GetNthROIRadiusXYZ()

double * vtkMRMLROIListNode::GetNthROIRadiusXYZ ( int n )

◆ GetNthROISelected()

int vtkMRMLROIListNode::GetNthROISelected ( int n )

◆ GetNthROIXYZ()

double * vtkMRMLROIListNode::GetNthROIXYZ ( int n )

◆ GetNumberOfROIs()

int vtkMRMLROIListNode::GetNumberOfROIs ( )

Get the number of ROIs in the list.

◆ GetOpacity()

virtual double vtkMRMLROIListNode::GetOpacity ( )

virtual

◆ GetPower()

virtual double vtkMRMLROIListNode::GetPower ( )

virtual

◆ GetSelectedColor() [1/2]

virtual double * vtkMRMLROIListNode::GetSelectedColor ( )

virtual

◆ GetSelectedColor() [2/2]

virtual void vtkMRMLROIListNode::GetSelectedColor ( double data[3] )

virtual

◆ GetSpecular()

virtual double vtkMRMLROIListNode::GetSpecular ( )

virtual

◆ GetTextScale()

virtual double vtkMRMLROIListNode::GetTextScale ( )

virtual

◆ GetVisibility()

virtual int vtkMRMLROIListNode::GetVisibility ( )

virtual

◆ GetVolumeNodeID()

virtual char * vtkMRMLROIListNode::GetVolumeNodeID ( )

virtual

Get/Set for the volume ID associated with the ROI.

◆ IsA()

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

virtual

Reimplemented from vtkMRMLNode.

◆ IsTypeOf()

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

static

◆ New()

static vtkMRMLROIListNode * vtkMRMLROIListNode::New ( )

static

◆ operator=()

void vtkMRMLROIListNode::operator= ( const vtkMRMLROIListNode & )

protected

◆ PrintSelf()

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

override

◆ ProcessMRMLEvents()

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

overridevirtual

Propagate events generated in mrml.

Reimplemented from vtkMRMLNode.

◆ ReadXMLAttributes()

void vtkMRMLROIListNode::ReadXMLAttributes ( const char ** atts )

overridevirtual

Set node attributes.

Reimplemented from vtkMRMLNode.

◆ RemoveAllROIs()

void vtkMRMLROIListNode::RemoveAllROIs ( )

Remove all ROIs from the list.

◆ RemoveROI()

void vtkMRMLROIListNode::RemoveROI ( int i )

Remove an ROI from the list.

◆ SafeDownCast()

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

static

◆ SetAllVolumeNodeID()

void vtkMRMLROIListNode::SetAllVolumeNodeID ( )

Set the Volume node ID for each ROI node in the list.

◆ SetAmbient()

virtual void vtkMRMLROIListNode::SetAmbient ( double )

virtual

Ambient of the ROI expressed as a number from 0 to 100.

◆ SetColor() [1/2]

void vtkMRMLROIListNode::SetColor ( double c[3] )

◆ SetColor() [2/2]

void vtkMRMLROIListNode::SetColor	(	double	r,
		double	g,
		double	b )

Get/Set for ROI and Text color.

◆ SetDiffuse()

virtual void vtkMRMLROIListNode::SetDiffuse ( double )

virtual

Diffuse of the ROI expressed as a number from 0 to 100.

◆ SetNthROIID()

int vtkMRMLROIListNode::SetNthROIID	(	int	n,
		const char *	id )

Get/Set for ID of the Nth ROI.

◆ SetNthROIIJK()

int vtkMRMLROIListNode::SetNthROIIJK	(	int	n,
		double	i,
		double	j,
		double	k )

Get/Set for Nth ROI node Position in IJK coordinates Note: The ROI Position is the center of the ROI

◆ SetNthROILabelText()

int vtkMRMLROIListNode::SetNthROILabelText	(	int	n,
		const char *	text )

Get/Set for label text of the Nth ROI.

◆ SetNthROIRadiusIJK()

int vtkMRMLROIListNode::SetNthROIRadiusIJK	(	int	n,
		double	Radiusi,
		double	Radiusj,
		double	Radiusk )

Get/Set for Nth radius of the ROI in IJK coordinates.

◆ SetNthROIRadiusXYZ()

int vtkMRMLROIListNode::SetNthROIRadiusXYZ	(	int	n,
		double	Radiusx,
		double	Radiusy,
		double	Radiusz )

Get/Set for Nth radius of the ROI in RAS coordinates.

◆ SetNthROISelected()

int vtkMRMLROIListNode::SetNthROISelected	(	int	n,
		int	flag )

Get/Set for selected flag of the Nth ROI.

◆ SetNthROIXYZ()

int vtkMRMLROIListNode::SetNthROIXYZ	(	int	n,
		double	x,
		double	y,
		double	z )

Restrict access to the ROI, pass in a value via the list so that the appropriate events can be invoked. Returns 0 on success Get/Set for Nth ROI node Position in RAS coordinates Note: The ROI Position is the center of the ROI

◆ SetOpacity()

void vtkMRMLROIListNode::SetOpacity ( double opacity )

Opacity of the ROI expressed as a number from 0 to 1.

◆ SetPower()

virtual void vtkMRMLROIListNode::SetPower ( double )

virtual

Power of the ROI expressed as a number from 0 to 100.

◆ SetSelectedColor() [1/2]

void vtkMRMLROIListNode::SetSelectedColor ( double c[3] )

◆ SetSelectedColor() [2/2]

void vtkMRMLROIListNode::SetSelectedColor	(	double	r,
		double	g,
		double	b )

Get/Set for color for when an ROI is selected.

◆ SetSpecular()

virtual void vtkMRMLROIListNode::SetSpecular ( double )

virtual

Specular of the ROI expressed as a number from 0 to 100.

◆ SetTextScale()

void vtkMRMLROIListNode::SetTextScale ( double scale )

Get/Set for Text scale.

◆ SetVisibility()

void vtkMRMLROIListNode::SetVisibility ( int visible )

Get/Set for list visibility.

◆ SetVolumeNodeID()

virtual void vtkMRMLROIListNode::SetVolumeNodeID ( const char * )

virtual

◆ UpdateIJK()

void vtkMRMLROIListNode::UpdateIJK ( )

Synchronize the ROI position and radius in IJK coordinates according RAS coordinates

◆ UpdateReferences()

void vtkMRMLROIListNode::UpdateReferences ( )

overridevirtual

update display node ids

Reimplemented from vtkMRMLNode.

◆ UpdateScene()

void vtkMRMLROIListNode::UpdateScene ( vtkMRMLScene * )

overridevirtual

Updates other nodes in the scene depending on this node or updates this node if it depends on other nodes when the scene is read in This method is called automatically by XML parser after all nodes are created

Reimplemented from vtkMRMLNode.

◆ WriteXML()

void vtkMRMLROIListNode::WriteXML	(	ostream &	of,
		int	indent )

overridevirtual

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

Reimplemented from vtkMRMLNode.

Member Data Documentation

◆ Ambient

double vtkMRMLROIListNode::Ambient

protected

Definition at line 193 of file vtkMRMLROIListNode.h.

◆ Color

double vtkMRMLROIListNode::Color[3]

protected

Definition at line 186 of file vtkMRMLROIListNode.h.

◆ Diffuse

double vtkMRMLROIListNode::Diffuse

protected

Definition at line 194 of file vtkMRMLROIListNode.h.

◆ Opacity

double vtkMRMLROIListNode::Opacity

protected

Numbers relating to the 3D render of the ROI.

Definition at line 192 of file vtkMRMLROIListNode.h.

◆ Power

double vtkMRMLROIListNode::Power

protected

Definition at line 196 of file vtkMRMLROIListNode.h.

◆ ROIList

vtkCollection* vtkMRMLROIListNode::ROIList

protected

The collection of ROI that make up this list.

Definition at line 182 of file vtkMRMLROIListNode.h.

◆ SelectedColor

double vtkMRMLROIListNode::SelectedColor[3]

protected

Definition at line 187 of file vtkMRMLROIListNode.h.

◆ Specular

double vtkMRMLROIListNode::Specular

protected

Definition at line 195 of file vtkMRMLROIListNode.h.

◆ TextScale

double vtkMRMLROIListNode::TextScale

protected

Definition at line 184 of file vtkMRMLROIListNode.h.

◆ Visibility

int vtkMRMLROIListNode::Visibility

protected

Definition at line 185 of file vtkMRMLROIListNode.h.

◆ VolumeNodeID

char* vtkMRMLROIListNode::VolumeNodeID

protected

The ID of the volume node that is associated with the ROI.

Definition at line 200 of file vtkMRMLROIListNode.h.

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

Libs/MRML/Core/vtkMRMLROIListNode.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

◆ vtkMRMLROIListNode() [1/2]

◆ ~vtkMRMLROIListNode()

◆ vtkMRMLROIListNode() [2/2]

Member Function Documentation

◆ AddROI()

◆ Copy()

◆ CreateNodeInstance()

◆ GetAmbient()

◆ GetClassName()

◆ GetColor() [1/2]

◆ GetColor() [2/2]

◆ GetDiffuse()

◆ GetNodeTagName()

◆ GetNthROIID()

◆ GetNthROIIJK()

◆ GetNthROILabelText()

◆ GetNthROINode()

◆ GetNthROIRadiusIJK()

◆ GetNthROIRadiusXYZ()

◆ GetNthROISelected()

◆ GetNthROIXYZ()

◆ GetNumberOfROIs()

◆ GetOpacity()

◆ GetPower()

◆ GetSelectedColor() [1/2]

◆ GetSelectedColor() [2/2]

◆ GetSpecular()

◆ GetTextScale()

◆ GetVisibility()

◆ GetVolumeNodeID()

◆ IsA()

◆ IsTypeOf()

◆ New()

◆ operator=()

◆ PrintSelf()

◆ ProcessMRMLEvents()

◆ ReadXMLAttributes()

◆ RemoveAllROIs()

◆ RemoveROI()

◆ SafeDownCast()

◆ SetAllVolumeNodeID()

◆ SetAmbient()

◆ SetColor() [1/2]

◆ SetColor() [2/2]

◆ SetDiffuse()

◆ SetNthROIID()

◆ SetNthROIIJK()

◆ SetNthROILabelText()

◆ SetNthROIRadiusIJK()

◆ SetNthROIRadiusXYZ()

◆ SetNthROISelected()

◆ SetNthROIXYZ()

◆ SetOpacity()

◆ SetPower()

◆ SetSelectedColor() [1/2]

◆ SetSelectedColor() [2/2]

◆ SetSpecular()

◆ SetTextScale()

◆ SetVisibility()

◆ SetVolumeNodeID()

◆ UpdateIJK()

◆ UpdateReferences()

◆ UpdateScene()

◆ WriteXML()

Member Data Documentation

◆ Ambient

◆ Color

◆ Diffuse