vtkMRMLSliceCompositeNode Class Reference

MRML node for storing a slice through RAS space. More...

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

Inheritance diagram for vtkMRMLSliceCompositeNode:

Collaboration diagram for vtkMRMLSliceCompositeNode:

Public Types
enum	{ Alpha = 0 , ReverseAlpha , Add , Subtract }
	Modes for compositing. More...
enum	{   LayerNone = -1 , LayerBackground = 0 , LayerForeground = 1 , LayerLabel = 2 ,   Layer_Last }
enum	InteractionFlagType {   None = 0 , ForegroundVolumeFlag = 1 , BackgroundVolumeFlag = 2 , LabelVolumeFlag = 4 ,   LabelOpacityFlag = 8 , ForegroundOpacityFlag = 16 }
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
vtkMRMLNode *	CreateNodeInstance () override
	Create instance of the default node. Like New only virtual.
virtual const char *	GetClassName ()
const char *	GetNodeTagName () override
	Get node XML tag name (like Volume, Model)
int	GetNumberOfAdditionalLayers ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
void	ReadXMLAttributes (const char **atts) override
	Set node attributes.
void	ResetInteractionFlagsModifier ()
	vtkMRMLCopyContentMacro (vtkMRMLSliceCompositeNode)
void	WriteXML (ostream &of, int indent) override
	Write this node's information to a MRML file in XML format.
const char *	GetBackgroundVolumeID ()
void	SetBackgroundVolumeID (const char *id)
void	SetReferenceBackgroundVolumeID (const char *id)
const char *	GetForegroundVolumeID ()
void	SetForegroundVolumeID (const char *id)
void	SetReferenceForegroundVolumeID (const char *id)
const char *	GetLabelVolumeID ()
void	SetLabelVolumeID (const char *id)
void	SetReferenceLabelVolumeID (const char *id)
vtkMRMLVolumeNode *	GetNthLayerVolume (int layerIndex)
void	SetNthLayerVolume (int layerIndex, vtkMRMLVolumeNode *volumeNode)
const char *	GetNthLayerVolumeID (int layerIndex)
void	SetNthLayerVolumeID (int layerIndex, const char *volumeNodeID)
virtual int	GetCompositing ()
virtual void	SetCompositing (int)
virtual bool	GetClipToBackgroundVolume ()
virtual void	SetClipToBackgroundVolume (bool)
double	GetNthLayerOpacity (int layerIndex)
void	SetNthLayerOpacity (int layerIndex, double value)
double	GetForegroundOpacity ()
void	SetForegroundOpacity (double value)
double	GetLabelOpacity ()
void	SetLabelOpacity (double value)
virtual int	GetLinkedControl ()
virtual void	SetLinkedControl (int)
virtual void	LinkedControlOn ()
virtual void	LinkedControlOff ()
virtual int	GetHotLinkedControl ()
virtual void	SetHotLinkedControl (int)
virtual void	HotLinkedControlOn ()
virtual void	HotLinkedControlOff ()
virtual int	GetFiducialVisibility ()
virtual void	SetFiducialVisibility (int)
virtual int	GetFiducialLabelVisibility ()
virtual void	SetFiducialLabelVisibility (int)
int	GetSliceIntersectionVisibility ()
void	SetSliceIntersectionVisibility (int visibility)
virtual void	SetDoPropagateVolumeSelection (bool)
virtual bool	GetDoPropagateVolumeSelection ()
void	SetLayoutName (const char *layoutName)
char *	GetLayoutName ()
void	SetInteracting (int)
virtual int	GetInteracting ()
virtual void	InteractingOn ()
virtual void	InteractingOff ()
void	SetInteractionFlags (unsigned int)
virtual unsigned int	GetInteractionFlags ()
void	SetInteractionFlagsModifier (unsigned int)
virtual unsigned int	GetInteractionFlagsModifier ()
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	Copy (vtkMRMLNode *node)
	Copy node contents from another node of the same type. Does not copy node ID and Scene. Performs deep copy - an independent copy is created from all data, including bulk data.
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.
virtual void	ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
	Propagate events generated in mrml.
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.
virtual void	UpdateReferences ()
	The method should remove all pointers and observations to all nodes that are not in the scene anymore.
virtual void	UpdateScene (vtkMRMLScene *)
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 vtkMRMLSliceCompositeNode *	New ()
static vtkMRMLSliceCompositeNode *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkMRMLNode
static int	IsTypeOf (const char *type)
static vtkMRMLNode *	SafeDownCast (vtkObject *o)

Protected Member Functions
std::string	GetCompositeNodeIDFromSliceModelNode (vtkMRMLModelNode *sliceModelNode)
vtkMRMLSliceDisplayNode *	GetSliceDisplayNode ()
void	operator= (const vtkMRMLSliceCompositeNode &)
	vtkMRMLSliceCompositeNode ()
	vtkMRMLSliceCompositeNode (const vtkMRMLSliceCompositeNode &)
	~vtkMRMLSliceCompositeNode () 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
bool	ClipToBackgroundVolume { true }
int	Compositing { Alpha }
bool	DoPropagateVolumeSelection { true }
int	FiducialLabelVisibility { 1 }
int	FiducialVisibility { 1 }
int	HotLinkedControl { 0 }
int	Interacting { 0 }
unsigned int	InteractionFlags { 0 }
unsigned int	InteractionFlagsModifier { (unsigned int)-1 }
vtkWeakPointer< vtkMRMLSliceDisplayNode >	LastFoundSliceDisplayNode
std::vector< double >	LayerOpacities
int	LinkedControl { 0 }
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 node for storing a slice through RAS space.

This node stores the information about how to composite N vtkMRMLVolumes into a single display image.

Definition at line 28 of file vtkMRMLSliceCompositeNode.h.

Member Typedef Documentation

Superclass

typedef vtkMRMLNode vtkMRMLSliceCompositeNode::Superclass

Definition at line 32 of file vtkMRMLSliceCompositeNode.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Modes for compositing.

Enumerator
Alpha
ReverseAlpha
Add
Subtract

Definition at line 189 of file vtkMRMLSliceCompositeNode.h.

anonymous enum

anonymous enum

Enumerator
LayerNone
LayerBackground
LayerForeground
LayerLabel
Layer_Last

Definition at line 74 of file vtkMRMLSliceCompositeNode.h.

InteractionFlagType

enum vtkMRMLSliceCompositeNode::InteractionFlagType

Enum identifying the parameters being manipulated with calls to InteractionOn() and InteractionOff(). Identifiers are powers of two so they can be combined into a bitmask to manipulate multiple parameters. The meanings for the flags are: ForegroundVolumeFlag - broadcast the foreground volume selection BackgroundVolumeFlag - broadcast the background volume selection LabelVolumeFlag - broadcast the label volume selection

Enumerator
None
ForegroundVolumeFlag
BackgroundVolumeFlag
LabelVolumeFlag
LabelOpacityFlag
ForegroundOpacityFlag

Definition at line 216 of file vtkMRMLSliceCompositeNode.h.

Constructor & Destructor Documentation

vtkMRMLSliceCompositeNode() [1/2]

vtkMRMLSliceCompositeNode::vtkMRMLSliceCompositeNode ( )

protected

~vtkMRMLSliceCompositeNode()

vtkMRMLSliceCompositeNode::~vtkMRMLSliceCompositeNode ( )

overrideprotected

vtkMRMLSliceCompositeNode() [2/2]

vtkMRMLSliceCompositeNode::vtkMRMLSliceCompositeNode ( const vtkMRMLSliceCompositeNode & )

protected

Member Function Documentation

CreateNodeInstance()

vtkMRMLNode * vtkMRMLSliceCompositeNode::CreateNodeInstance ( )

overridevirtual

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

Note

Subclasses should implement this method

Implements vtkMRMLNode.

GetBackgroundVolumeID()

const char * vtkMRMLSliceCompositeNode::GetBackgroundVolumeID

(

)

the ID of a MRMLVolumeNode

See also

GetNthLayerVolumeID

GetClassName()

virtual const char * vtkMRMLSliceCompositeNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLNode.

GetClipToBackgroundVolume()

virtual bool vtkMRMLSliceCompositeNode::GetClipToBackgroundVolume ( )

virtual

Configures the behavior for blending layers. The default value is true, indicating that the layers will be clipped to fit the background.

GetCompositeNodeIDFromSliceModelNode()

std::string vtkMRMLSliceCompositeNode::GetCompositeNodeIDFromSliceModelNode ( vtkMRMLModelNode * sliceModelNode )

protected

GetCompositing()

virtual int vtkMRMLSliceCompositeNode::GetCompositing ( )

virtual

Compositing mode for foreground and background can be alpha blending, reverse alpha blending, addition, or subtraction

GetDoPropagateVolumeSelection()

virtual bool vtkMRMLSliceCompositeNode::GetDoPropagateVolumeSelection ( )

virtual

GetFiducialLabelVisibility()

virtual int vtkMRMLSliceCompositeNode::GetFiducialLabelVisibility ( )

virtual

GetFiducialVisibility()

virtual int vtkMRMLSliceCompositeNode::GetFiducialVisibility ( )

virtual

toggles fiducial visibility in the slice viewer

GetForegroundOpacity()

double vtkMRMLSliceCompositeNode::GetForegroundOpacity

(

)

opacity of the Foreground for rendering over background TODO: make different composite types (checkerboard, etc)

See also

GetNthLayerOpacity, SetNthLayerOpacity

GetForegroundVolumeID()

const char * vtkMRMLSliceCompositeNode::GetForegroundVolumeID

(

)

the ID of a MRMLVolumeNode

See also

GetNthLayerVolumeID

GetHotLinkedControl()

virtual int vtkMRMLSliceCompositeNode::GetHotLinkedControl ( )

virtual

toggle for whether linked behavior is immediate or waits until an interaction is finished

GetInteracting()

virtual int vtkMRMLSliceCompositeNode::GetInteracting ( )

virtual

GetInteractionFlags()

virtual unsigned int vtkMRMLSliceCompositeNode::GetInteractionFlags ( )

virtual

GetInteractionFlagsModifier()

virtual unsigned int vtkMRMLSliceCompositeNode::GetInteractionFlagsModifier ( )

virtual

GetLabelOpacity()

double vtkMRMLSliceCompositeNode::GetLabelOpacity

(

)

opacity of the Label for rendering over background TODO: make different composite types (checkerboard, etc)

See also

GetNthLayerOpacity, SetNthLayerOpacity

GetLabelVolumeID()

const char * vtkMRMLSliceCompositeNode::GetLabelVolumeID

(

)

the ID of a MRMLVolumeNode

See also

GetNthLayerVolumeID

GetLayoutName()

char * vtkMRMLSliceCompositeNode::GetLayoutName ( )

inline

Definition at line 183 of file vtkMRMLSliceCompositeNode.h.

GetLinkedControl()

virtual int vtkMRMLSliceCompositeNode::GetLinkedControl ( )

virtual

toggle that gangs control of slice viewers

GetNodeTagName()

const char * vtkMRMLSliceCompositeNode::GetNodeTagName ( )

inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Definition at line 48 of file vtkMRMLSliceCompositeNode.h.

GetNthLayerOpacity()

double vtkMRMLSliceCompositeNode::GetNthLayerOpacity

(

int

layerIndex

)

Opacity of layer N over layer N-1

Note

Only Foreground and Label opacity are saved into the MRML Scene

GetNthLayerVolume()

vtkMRMLVolumeNode * vtkMRMLSliceCompositeNode::GetNthLayerVolume

(

int

layerIndex

)

See also

GetNthLayerVolumeID, SetNthLayerVolumeID

GetNthLayerVolumeID()

const char * vtkMRMLSliceCompositeNode::GetNthLayerVolumeID

(

int

layerIndex

)

See also

GetNthLayerVolume, SetNthLayerVolume

GetNumberOfAdditionalLayers()

int vtkMRMLSliceCompositeNode::GetNumberOfAdditionalLayers

(

)

GetSliceDisplayNode()

vtkMRMLSliceDisplayNode * vtkMRMLSliceCompositeNode::GetSliceDisplayNode ( )

protected

GetSliceIntersectionVisibility()

int vtkMRMLSliceCompositeNode::GetSliceIntersectionVisibility

(

)

This method is deprecated. Instead of this method use SetIntersectingSlicesVisibility() and GetIntersectingSlicesVisibility() of vtkMRMLSliceDisplayNode.

HotLinkedControlOff()

virtual void vtkMRMLSliceCompositeNode::HotLinkedControlOff ( )

virtual

HotLinkedControlOn()

virtual void vtkMRMLSliceCompositeNode::HotLinkedControlOn ( )

virtual

InteractingOff()

virtual void vtkMRMLSliceCompositeNode::InteractingOff ( )

virtual

InteractingOn()

virtual void vtkMRMLSliceCompositeNode::InteractingOn ( )

virtual

IsA()

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

virtual

Reimplemented from vtkMRMLNode.

IsTypeOf()

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

static

LinkedControlOff()

virtual void vtkMRMLSliceCompositeNode::LinkedControlOff ( )

virtual

LinkedControlOn()

virtual void vtkMRMLSliceCompositeNode::LinkedControlOn ( )

virtual

New()

static vtkMRMLSliceCompositeNode * vtkMRMLSliceCompositeNode::New ( )

static

operator=()

void vtkMRMLSliceCompositeNode::operator= ( const vtkMRMLSliceCompositeNode & )

protected

PrintSelf()

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

override

ReadXMLAttributes()

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

overridevirtual

Set node attributes.

Reimplemented from vtkMRMLNode.

ResetInteractionFlagsModifier()

void vtkMRMLSliceCompositeNode::ResetInteractionFlagsModifier

(

)

Set all bits of the modifier to 1, resulting in the default linking behavior (selection of foreground, background and label volumes being broadcast when composite slice nodes are linked).

SafeDownCast()

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

static

SetBackgroundVolumeID()

void vtkMRMLSliceCompositeNode::SetBackgroundVolumeID

(

const char *

id

)

SetClipToBackgroundVolume()

virtual void vtkMRMLSliceCompositeNode::SetClipToBackgroundVolume ( bool )

virtual

SetCompositing()

virtual void vtkMRMLSliceCompositeNode::SetCompositing ( int )

virtual

SetDoPropagateVolumeSelection()

virtual void vtkMRMLSliceCompositeNode::SetDoPropagateVolumeSelection ( bool )

virtual

configures the behavior of PropagateVolumeSelection(): if set to false, the background/label for slice views will not be reset. Default value is true

SetFiducialLabelVisibility()

virtual void vtkMRMLSliceCompositeNode::SetFiducialLabelVisibility ( int )

virtual

SetFiducialVisibility()

virtual void vtkMRMLSliceCompositeNode::SetFiducialVisibility ( int )

virtual

SetForegroundOpacity()

void vtkMRMLSliceCompositeNode::SetForegroundOpacity

(

double

value

)

SetForegroundVolumeID()

void vtkMRMLSliceCompositeNode::SetForegroundVolumeID

(

const char *

id

)

SetHotLinkedControl()

virtual void vtkMRMLSliceCompositeNode::SetHotLinkedControl ( int )

virtual

SetInteracting()

void vtkMRMLSliceCompositeNode::SetInteracting

(

int

)

Get/Set a flag indicating whether this node is actively being manipulated (usually) by a user interface. This flag is used by logic classes to determine whether state changes should be propagated to other nodes to implement linked controls. Does not mark the node as Modified.

SetInteractionFlags()

void vtkMRMLSliceCompositeNode::SetInteractionFlags

(

unsigned int

)

Get/Set a flag indicating what parameters are being manipulated within calls to InteractingOn() and InteractingOff(). These fields are used to propagate linked behaviors. This flag is a bitfield, with multiple parameters OR'd to compose the flag. Does not mark the node as Modified.

SetInteractionFlagsModifier()

void vtkMRMLSliceCompositeNode::SetInteractionFlagsModifier

(

unsigned int

)

Get/Set a flag indicating how the linking behavior should be modified. InteractionFlags modifier uses bits defined by InteractionFlagType enum that by default are all set and result in the default behavior. If a bit is not set, this will result in composite slice node interactions not broadcast.

SetLabelOpacity()

void vtkMRMLSliceCompositeNode::SetLabelOpacity

(

double

value

)

SetLabelVolumeID()

void vtkMRMLSliceCompositeNode::SetLabelVolumeID

(

const char *

id

)

SetLayoutName()

void vtkMRMLSliceCompositeNode::SetLayoutName ( const char * layoutName )

inline

Name of the layout. Must be unique between all the slice composite nodes because it is used as a singleton tag. Must be the same than the slice node. No name (i.e. "") by default. Typical names are colors: "Red", "Green", "Yellow"... to uniquely define the slice node

See also

vtkMRMLSliceNode::SetLayoutName

Definition at line 180 of file vtkMRMLSliceCompositeNode.h.

SetLinkedControl()

virtual void vtkMRMLSliceCompositeNode::SetLinkedControl ( int )

virtual

SetNthLayerOpacity()

void vtkMRMLSliceCompositeNode::SetNthLayerOpacity	(	int	layerIndex,
		double	value )

SetNthLayerVolume()

void vtkMRMLSliceCompositeNode::SetNthLayerVolume	(	int	layerIndex,
		vtkMRMLVolumeNode *	volumeNode )

SetNthLayerVolumeID()

void vtkMRMLSliceCompositeNode::SetNthLayerVolumeID	(	int	layerIndex,
		const char *	volumeNodeID )

SetReferenceBackgroundVolumeID()

void vtkMRMLSliceCompositeNode::SetReferenceBackgroundVolumeID ( const char * id )

inline

Definition at line 55 of file vtkMRMLSliceCompositeNode.h.

SetReferenceForegroundVolumeID()

void vtkMRMLSliceCompositeNode::SetReferenceForegroundVolumeID ( const char * id )

inline

Definition at line 63 of file vtkMRMLSliceCompositeNode.h.

SetReferenceLabelVolumeID()

void vtkMRMLSliceCompositeNode::SetReferenceLabelVolumeID ( const char * id )

inline

Definition at line 71 of file vtkMRMLSliceCompositeNode.h.

SetSliceIntersectionVisibility()

void vtkMRMLSliceCompositeNode::SetSliceIntersectionVisibility

(

int

visibility

)

vtkMRMLCopyContentMacro()

vtkMRMLSliceCompositeNode::vtkMRMLCopyContentMacro

(

vtkMRMLSliceCompositeNode

)

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

See also

vtkMRMLNode::CopyContent

WriteXML()

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

overridevirtual

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

Reimplemented from vtkMRMLNode.

Member Data Documentation

ClipToBackgroundVolume

bool vtkMRMLSliceCompositeNode::ClipToBackgroundVolume { true }

protected

Definition at line 274 of file vtkMRMLSliceCompositeNode.h.

Compositing

int vtkMRMLSliceCompositeNode::Compositing { Alpha }

protected

Definition at line 272 of file vtkMRMLSliceCompositeNode.h.

DoPropagateVolumeSelection

bool vtkMRMLSliceCompositeNode::DoPropagateVolumeSelection { true }

protected

Definition at line 282 of file vtkMRMLSliceCompositeNode.h.

FiducialLabelVisibility

int vtkMRMLSliceCompositeNode::FiducialLabelVisibility { 1 }

protected

Definition at line 280 of file vtkMRMLSliceCompositeNode.h.

FiducialVisibility

int vtkMRMLSliceCompositeNode::FiducialVisibility { 1 }

protected

Definition at line 279 of file vtkMRMLSliceCompositeNode.h.

HotLinkedControl

int vtkMRMLSliceCompositeNode::HotLinkedControl { 0 }

protected

Definition at line 277 of file vtkMRMLSliceCompositeNode.h.

Interacting

int vtkMRMLSliceCompositeNode::Interacting { 0 }

protected

Definition at line 284 of file vtkMRMLSliceCompositeNode.h.

InteractionFlags

unsigned int vtkMRMLSliceCompositeNode::InteractionFlags { 0 }

protected

Definition at line 285 of file vtkMRMLSliceCompositeNode.h.

InteractionFlagsModifier

unsigned int vtkMRMLSliceCompositeNode::InteractionFlagsModifier { (unsigned int)-1 }

protected

Definition at line 286 of file vtkMRMLSliceCompositeNode.h.

LastFoundSliceDisplayNode

vtkWeakPointer<vtkMRMLSliceDisplayNode> vtkMRMLSliceCompositeNode::LastFoundSliceDisplayNode

protected

Definition at line 264 of file vtkMRMLSliceCompositeNode.h.

LayerOpacities

std::vector<double> vtkMRMLSliceCompositeNode::LayerOpacities

protected

Initial value:

= {
    1.0, 
    0.0, 
    1.0, 
  }

Definition at line 266 of file vtkMRMLSliceCompositeNode.h.

LinkedControl

int vtkMRMLSliceCompositeNode::LinkedControl { 0 }

protected

Definition at line 276 of file vtkMRMLSliceCompositeNode.h.

---

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

• Libs/MRML/Core/vtkMRMLSliceCompositeNode.h