vtkMRMLLayoutNode Class Reference

Node that describes the view layout of the application. More...

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

Inheritance diagram for vtkMRMLLayoutNode:

Collaboration diagram for vtkMRMLLayoutNode:

Public Types
enum	SlicerLayout {   SlicerLayoutInitialView = 0 , SlicerLayoutDefaultView = 1 , SlicerLayoutConventionalView = 2 , SlicerLayoutFourUpView = 3 ,   SlicerLayoutOneUp3DView = 4 , SlicerLayoutOneUpRedSliceView = 6 , SlicerLayoutOneUpYellowSliceView = 7 , SlicerLayoutOneUpGreenSliceView = 8 ,   SlicerLayoutTabbed3DView = 9 , SlicerLayoutTabbedSliceView = 10 , SlicerLayoutCompareView = 12 , SlicerLayoutNone = 14 ,   SlicerLayoutDual3DView = 15 , SlicerLayoutConventionalWidescreenView = 16 , SlicerLayoutCompareWidescreenView = 17 , SlicerLayoutTriple3DEndoscopyView = 19 ,   SlicerLayoutThreeOverThreeView = 21 , SlicerLayoutFourOverFourView = 22 , SlicerLayoutCompareGridView = 23 , SlicerLayoutTwoOverTwoView = 27 ,   SlicerLayoutSideBySideView = 29 , SlicerLayoutFourByThreeSliceView = 30 , SlicerLayoutFourByTwoSliceView = 31 , SlicerLayoutFiveByTwoSliceView = 32 ,   SlicerLayoutThreeByThreeSliceView = 33 , SlicerLayoutFourUpTableView = 34 , SlicerLayout3DTableView = 35 , SlicerLayoutConventionalPlotView = 36 ,   SlicerLayoutFourUpPlotView = 37 , SlicerLayoutFourUpPlotTableView = 38 , SlicerLayoutOneUpPlotView = 39 , SlicerLayoutThreeOverThreePlotView = 40 ,   SlicerLayoutDicomBrowserView = 41 , SlicerLayoutDualMonitorFourUpView = 42 , SlicerLayoutFinalView , SlicerLayoutMaximizedView = 98 ,   SlicerLayoutCustomView = 99 , SlicerLayoutUserView = 100 }
typedef vtkMRMLAbstractLayoutNode	Superclass
Public Types inherited from vtkMRMLAbstractLayoutNode
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
bool	AddLayoutDescription (int layout, const char *layoutDescription)
void	AddMaximizedViewNode (vtkMRMLAbstractViewNode *maximizedViewNode)
void	CopyContent (vtkMRMLNode *node, bool deepCopy=true) override
	Copy the node's attributes to this object.
void	CopyLayoutDescriptions (vtkMRMLLayoutNode *source)
vtkMRMLNode *	CreateNodeInstance () override
	Create instance of the default node. Like New only virtual.
virtual int	GetBottomPanelVisibility ()
virtual const char *	GetClassName ()
virtual int	GetCollapseSliceControllers ()
	Control the collapse state of the SliceControllers.
virtual char *	GetCurrentLayoutDescription ()
virtual int	GetGUIPanelLR ()
	0 is left side, 1 is right side
virtual int	GetGUIPanelVisibility ()
std::string	GetLayoutDescription (int layout)
std::vector< int >	GetLayoutIndices ()
	Get list of all specified layout indices.
virtual vtkXMLDataElement *	GetLayoutRootElement ()
virtual int	GetMainPanelSize ()
vtkMRMLAbstractViewNode *	GetMaximizedViewNode (int maximizedViewNodeIndex)
const char *	GetNodeTagName () override
	Get node XML tag name (like Volume, Model)
virtual int	GetNumberOfCompareViewColumns ()
virtual int	GetNumberOfCompareViewLightboxColumns ()
virtual int	GetNumberOfCompareViewLightboxRows ()
	CompareView lightbox configuration Get/Set methods.
virtual int	GetNumberOfCompareViewRows ()
	CompareView configuration Get/Set methods.
int	GetNumberOfMaximizedViewNodes ()
virtual int	GetSecondaryPanelSize ()
virtual char *	GetSelectedModule ()
virtual int	GetViewArrangement ()
	Get/Set for Current layout.
virtual int	IsA (const char *type)
bool	IsLayoutDescription (int layout)
	Query whether a layout exists with a specified integer identifier.
bool	IsMaximizedViewNode (vtkMRMLAbstractViewNode *viewNode)
void	PrintSelf (ostream &os, vtkIndent indent) override
void	ReadXMLAttributes (const char **atts) override
	MRML methods.
void	RemoveAllMaximizedViewNodes ()
void	RemoveMaximizedViewNode (vtkMRMLAbstractViewNode *maximizedViewNode)
void	Reset (vtkMRMLNode *defaultNode) override
	Reimplemented to reset maximized view node.
virtual void	SetBottomPanelVisibility (int)
virtual void	SetCollapseSliceControllers (int)
virtual void	SetGUIPanelLR (int)
virtual void	SetGUIPanelVisibility (int)
bool	SetLayoutDescription (int layout, const char *layoutDescription)
virtual void	SetMainPanelSize (int)
virtual void	SetNumberOfCompareViewColumns (int)
virtual void	SetNumberOfCompareViewLightboxColumns (int)
virtual void	SetNumberOfCompareViewLightboxRows (int)
virtual void	SetNumberOfCompareViewRows (int)
virtual void	SetSecondaryPanelSize (int)
virtual void	SetSelectedModule (const char *)
virtual void	SetViewArrangement (int)
void	WriteXML (ostream &of, int indent) override
	Write this node's information to a MRML file in XML format.
Public Member Functions inherited from vtkMRMLAbstractLayoutNode
void	Copy (vtkMRMLNode *node) override
	Copy the node's attributes to this object.
void	PrintSelf (ostream &os, vtkIndent indent) override
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	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	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 vtkMRMLLayoutNode *	New ()
static vtkXMLDataElement *	ParseLayout (const char *description)
static vtkMRMLLayoutNode *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkMRMLAbstractLayoutNode
static int	IsTypeOf (const char *type)
static vtkMRMLAbstractLayoutNode *	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 vtkMRMLLayoutNode &)
void	SetAndParseCurrentLayoutDescription (const char *description)
virtual void	SetCurrentLayoutDescription (const char *)
void	UpdateCurrentLayoutDescription ()
	vtkMRMLLayoutNode ()
	vtkMRMLLayoutNode (const vtkMRMLLayoutNode &)
	~vtkMRMLLayoutNode () override
Protected Member Functions inherited from vtkMRMLAbstractLayoutNode
void	operator= (const vtkMRMLAbstractLayoutNode &)
	vtkMRMLAbstractLayoutNode ()
	vtkMRMLAbstractLayoutNode (const vtkMRMLAbstractLayoutNode &)
	~vtkMRMLAbstractLayoutNode () 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
int	BottomPanelVisibility
int	CollapseSliceControllers
char *	CurrentLayoutDescription
int	GUIPanelLR
int	GUIPanelVisibility
vtkXMLDataElement *	LayoutRootElement
std::map< int, std::string >	Layouts
int	MainPanelSize
int	NumberOfCompareViewColumns
int	NumberOfCompareViewLightboxColumns
int	NumberOfCompareViewLightboxRows
int	NumberOfCompareViewRows
int	SecondaryPanelSize
char *	SelectedModule
int	ViewArrangement
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

Node that describes the view layout of the application.

When the scene is closing (vtkMRMLScene::Clear), the view arrangement is set to none due to the Copy() call on an empty node.

Definition at line 14 of file vtkMRMLLayoutNode.h.

Member Typedef Documentation

Superclass

typedef vtkMRMLAbstractLayoutNode vtkMRMLLayoutNode::Superclass

Definition at line 18 of file vtkMRMLLayoutNode.h.

Member Enumeration Documentation

SlicerLayout

enum vtkMRMLLayoutNode::SlicerLayout

Enumerator
SlicerLayoutInitialView
SlicerLayoutDefaultView
SlicerLayoutConventionalView
SlicerLayoutFourUpView
SlicerLayoutOneUp3DView
SlicerLayoutOneUpRedSliceView
SlicerLayoutOneUpYellowSliceView
SlicerLayoutOneUpGreenSliceView
SlicerLayoutTabbed3DView
SlicerLayoutTabbedSliceView
SlicerLayoutCompareView
SlicerLayoutNone
SlicerLayoutDual3DView
SlicerLayoutConventionalWidescreenView
SlicerLayoutCompareWidescreenView
SlicerLayoutTriple3DEndoscopyView
SlicerLayoutThreeOverThreeView
SlicerLayoutFourOverFourView
SlicerLayoutCompareGridView
SlicerLayoutTwoOverTwoView
SlicerLayoutSideBySideView
SlicerLayoutFourByThreeSliceView
SlicerLayoutFourByTwoSliceView
SlicerLayoutFiveByTwoSliceView
SlicerLayoutThreeByThreeSliceView
SlicerLayoutFourUpTableView
SlicerLayout3DTableView
SlicerLayoutConventionalPlotView
SlicerLayoutFourUpPlotView
SlicerLayoutFourUpPlotTableView
SlicerLayoutOneUpPlotView
SlicerLayoutThreeOverThreePlotView
SlicerLayoutDicomBrowserView
SlicerLayoutDualMonitorFourUpView
SlicerLayoutFinalView
SlicerLayoutMaximizedView
SlicerLayoutCustomView
SlicerLayoutUserView

Definition at line 92 of file vtkMRMLLayoutNode.h.

Constructor & Destructor Documentation

vtkMRMLLayoutNode() [1/2]

vtkMRMLLayoutNode::vtkMRMLLayoutNode ( )

protected

~vtkMRMLLayoutNode()

vtkMRMLLayoutNode::~vtkMRMLLayoutNode ( )

overrideprotected

vtkMRMLLayoutNode() [2/2]

vtkMRMLLayoutNode::vtkMRMLLayoutNode ( const vtkMRMLLayoutNode & )

protected

Member Function Documentation

AddLayoutDescription()

bool vtkMRMLLayoutNode::AddLayoutDescription	(	int	layout,
		const char *	layoutDescription )

Adds a layout description with integer identifier "layout". Returns false without making any modifications if the integer identifier "layout" has already been added.

AddMaximizedViewNode()

void vtkMRMLLayoutNode::AddMaximizedViewNode

(

vtkMRMLAbstractViewNode *

maximizedViewNode

)

CopyContent()

void vtkMRMLLayoutNode::CopyContent ( vtkMRMLNode * node, bool deepCopy = true )

overridevirtual

Copy the node's attributes to this object.

Reimplemented from vtkMRMLNode.

CopyLayoutDescriptions()

void vtkMRMLLayoutNode::CopyLayoutDescriptions

(

vtkMRMLLayoutNode *

source

)

Copy all layout descriptions from the specified layout node. All the previous layout descriptions are replaced.

CreateNodeInstance()

vtkMRMLNode * vtkMRMLLayoutNode::CreateNodeInstance ( )

overridevirtual

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

Note

Subclasses should implement this method

Implements vtkMRMLNode.

GetBottomPanelVisibility()

virtual int vtkMRMLLayoutNode::GetBottomPanelVisibility ( )

virtual

GetClassName()

virtual const char * vtkMRMLLayoutNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLAbstractLayoutNode.

GetCollapseSliceControllers()

virtual int vtkMRMLLayoutNode::GetCollapseSliceControllers ( )

virtual

Control the collapse state of the SliceControllers.

GetCurrentLayoutDescription()

virtual char * vtkMRMLLayoutNode::GetCurrentLayoutDescription ( )

virtual

GetGUIPanelLR()

virtual int vtkMRMLLayoutNode::GetGUIPanelLR ( )

virtual

0 is left side, 1 is right side

GetGUIPanelVisibility()

virtual int vtkMRMLLayoutNode::GetGUIPanelVisibility ( )

virtual

GetLayoutDescription()

std::string vtkMRMLLayoutNode::GetLayoutDescription

(

int

layout

)

Get the layout description associated with a specified integer identifier. The empty string is returned if the layout does not exist.

GetLayoutIndices()

std::vector< int > vtkMRMLLayoutNode::GetLayoutIndices

(

)

Get list of all specified layout indices.

GetLayoutRootElement()

virtual vtkXMLDataElement * vtkMRMLLayoutNode::GetLayoutRootElement ( )

virtual

GetMainPanelSize()

virtual int vtkMRMLLayoutNode::GetMainPanelSize ( )

virtual

Set/Get the size of the main and secondary panels (size of Frame1 in each panel)

GetMaximizedViewNode()

vtkMRMLAbstractViewNode * vtkMRMLLayoutNode::GetMaximizedViewNode

(

int

maximizedViewNodeIndex

)

Set/Get the N-th view that are temporarily shown maximized. Only one view can be maximized in each viewport.

GetNodeTagName()

const char * vtkMRMLLayoutNode::GetNodeTagName ( )

inlineoverridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Definition at line 90 of file vtkMRMLLayoutNode.h.

GetNumberOfCompareViewColumns()

virtual int vtkMRMLLayoutNode::GetNumberOfCompareViewColumns ( )

virtual

GetNumberOfCompareViewLightboxColumns()

virtual int vtkMRMLLayoutNode::GetNumberOfCompareViewLightboxColumns ( )

virtual

GetNumberOfCompareViewLightboxRows()

virtual int vtkMRMLLayoutNode::GetNumberOfCompareViewLightboxRows ( )

virtual

CompareView lightbox configuration Get/Set methods.

GetNumberOfCompareViewRows()

virtual int vtkMRMLLayoutNode::GetNumberOfCompareViewRows ( )

virtual

CompareView configuration Get/Set methods.

GetNumberOfMaximizedViewNodes()

int vtkMRMLLayoutNode::GetNumberOfMaximizedViewNodes

(

)

GetSecondaryPanelSize()

virtual int vtkMRMLLayoutNode::GetSecondaryPanelSize ( )

virtual

GetSelectedModule()

virtual char * vtkMRMLLayoutNode::GetSelectedModule ( )

virtual

Set/Get the name of the last selected module Note: this is property is no longer used and may be removed in the future.

GetViewArrangement()

virtual int vtkMRMLLayoutNode::GetViewArrangement ( )

virtual

Get/Set for Current layout.

IsA()

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

virtual

Reimplemented from vtkMRMLAbstractLayoutNode.

IsLayoutDescription()

bool vtkMRMLLayoutNode::IsLayoutDescription

(

int

layout

)

Query whether a layout exists with a specified integer identifier.

IsMaximizedViewNode()

bool vtkMRMLLayoutNode::IsMaximizedViewNode

(

vtkMRMLAbstractViewNode *

viewNode

)

IsTypeOf()

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

static

New()

static vtkMRMLLayoutNode * vtkMRMLLayoutNode::New ( )

static

operator=()

void vtkMRMLLayoutNode::operator= ( const vtkMRMLLayoutNode & )

protected

ParseLayout()

static vtkXMLDataElement * vtkMRMLLayoutNode::ParseLayout ( const char * description )

static

PrintSelf()

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

override

ReadXMLAttributes()

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

overridevirtual

MRML methods.

Set node attributes

Reimplemented from vtkMRMLAbstractLayoutNode.

RemoveAllMaximizedViewNodes()

void vtkMRMLLayoutNode::RemoveAllMaximizedViewNodes

(

)

RemoveMaximizedViewNode()

void vtkMRMLLayoutNode::RemoveMaximizedViewNode

(

vtkMRMLAbstractViewNode *

maximizedViewNode

)

Reset()

void vtkMRMLLayoutNode::Reset ( vtkMRMLNode * defaultNode )

overridevirtual

Reimplemented to reset maximized view node.

Reimplemented from vtkMRMLNode.

SafeDownCast()

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

static

SetAndParseCurrentLayoutDescription()

void vtkMRMLLayoutNode::SetAndParseCurrentLayoutDescription ( const char * description )

protected

SetBottomPanelVisibility()

virtual void vtkMRMLLayoutNode::SetBottomPanelVisibility ( int )

virtual

SetCollapseSliceControllers()

virtual void vtkMRMLLayoutNode::SetCollapseSliceControllers ( int )

virtual

SetCurrentLayoutDescription()

virtual void vtkMRMLLayoutNode::SetCurrentLayoutDescription ( const char * )

protectedvirtual

SetGUIPanelLR()

virtual void vtkMRMLLayoutNode::SetGUIPanelLR ( int )

virtual

SetGUIPanelVisibility()

virtual void vtkMRMLLayoutNode::SetGUIPanelVisibility ( int )

virtual

SetLayoutDescription()

bool vtkMRMLLayoutNode::SetLayoutDescription	(	int	layout,
		const char *	layoutDescription )

Modifies a layout description for integer identifier "layout". Returns false without making any modifications if the integer identifier "layout" has NOT already been added. If layoutDescription is empty then the layout is removed.

SetMainPanelSize()

virtual void vtkMRMLLayoutNode::SetMainPanelSize ( int )

virtual

SetNumberOfCompareViewColumns()

virtual void vtkMRMLLayoutNode::SetNumberOfCompareViewColumns ( int )

virtual

SetNumberOfCompareViewLightboxColumns()

virtual void vtkMRMLLayoutNode::SetNumberOfCompareViewLightboxColumns ( int )

virtual

SetNumberOfCompareViewLightboxRows()

virtual void vtkMRMLLayoutNode::SetNumberOfCompareViewLightboxRows ( int )

virtual

SetNumberOfCompareViewRows()

virtual void vtkMRMLLayoutNode::SetNumberOfCompareViewRows ( int )

virtual

SetSecondaryPanelSize()

virtual void vtkMRMLLayoutNode::SetSecondaryPanelSize ( int )

virtual

SetSelectedModule()

virtual void vtkMRMLLayoutNode::SetSelectedModule ( const char * )

virtual

SetViewArrangement()

virtual void vtkMRMLLayoutNode::SetViewArrangement ( int )

virtual

UpdateCurrentLayoutDescription()

void vtkMRMLLayoutNode::UpdateCurrentLayoutDescription ( )

protected

WriteXML()

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

overridevirtual

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

Reimplemented from vtkMRMLAbstractLayoutNode.

Member Data Documentation

BottomPanelVisibility

int vtkMRMLLayoutNode::BottomPanelVisibility

protected

Definition at line 185 of file vtkMRMLLayoutNode.h.

CollapseSliceControllers

int vtkMRMLLayoutNode::CollapseSliceControllers

protected

Definition at line 187 of file vtkMRMLLayoutNode.h.

CurrentLayoutDescription

char* vtkMRMLLayoutNode::CurrentLayoutDescription

protected

Definition at line 200 of file vtkMRMLLayoutNode.h.

GUIPanelLR

int vtkMRMLLayoutNode::GUIPanelLR

protected

Definition at line 186 of file vtkMRMLLayoutNode.h.

GUIPanelVisibility

int vtkMRMLLayoutNode::GUIPanelVisibility

protected

Definition at line 184 of file vtkMRMLLayoutNode.h.

LayoutRootElement

vtkXMLDataElement* vtkMRMLLayoutNode::LayoutRootElement

protected

Definition at line 201 of file vtkMRMLLayoutNode.h.

Layouts

std::map<int, std::string> vtkMRMLLayoutNode::Layouts

protected

Definition at line 199 of file vtkMRMLLayoutNode.h.

MainPanelSize

int vtkMRMLLayoutNode::MainPanelSize

protected

Definition at line 196 of file vtkMRMLLayoutNode.h.

NumberOfCompareViewColumns

int vtkMRMLLayoutNode::NumberOfCompareViewColumns

protected

Definition at line 190 of file vtkMRMLLayoutNode.h.

NumberOfCompareViewLightboxColumns

int vtkMRMLLayoutNode::NumberOfCompareViewLightboxColumns

protected

Definition at line 192 of file vtkMRMLLayoutNode.h.

NumberOfCompareViewLightboxRows

int vtkMRMLLayoutNode::NumberOfCompareViewLightboxRows

protected

Definition at line 191 of file vtkMRMLLayoutNode.h.

NumberOfCompareViewRows

int vtkMRMLLayoutNode::NumberOfCompareViewRows

protected

Definition at line 189 of file vtkMRMLLayoutNode.h.

SecondaryPanelSize

int vtkMRMLLayoutNode::SecondaryPanelSize

protected

Definition at line 197 of file vtkMRMLLayoutNode.h.

SelectedModule

char* vtkMRMLLayoutNode::SelectedModule

protected

Definition at line 194 of file vtkMRMLLayoutNode.h.

ViewArrangement

int vtkMRMLLayoutNode::ViewArrangement

protected

Definition at line 188 of file vtkMRMLLayoutNode.h.

---

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

• Libs/MRML/Core/vtkMRMLLayoutNode.h