vtkMRMLViewNode Class Reference

MRML node to represent a 3D view. More...

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

Inheritance diagram for vtkMRMLViewNode:

Collaboration diagram for vtkMRMLViewNode:

Public Types
enum	{ RotateAround = 0, LookFrom, ViewAxisMode_Last }
	Modes for automatically controlling camera. More...
enum	{   PitchUp = 0, PitchDown, RollLeft, RollRight,   YawLeft, YawRight, SpinDirection_Last }
	Rotate camera directions. More...
enum	{   NoStereo = 0, RedBlue, Anaglyph, QuadBuffer,   Interlaced, UserDefined_1, UserDefined_2, UserDefined_3,   StereoType_Last }
	Stereo modes. More...
enum	{ Perspective = 0, Orthographic, RenderMode_Last }
	Render modes. More...
enum	{ Off = 0, Spin, Rock, AnimationMode_Last }
	Animation mode. More...
enum	{ Adaptive = 0, Normal, Maximum, VolumeRenderingQuality_Last }
	Quality setting used for. More...
enum	{   Composite = 0, CompositeEdgeColoring, MaximumIntensityProjection, MinimumIntensityProjection,   GradiantMagnitudeOpacityModulation, IllustrativeContextPreservingExploration, RaycastTechnique_Last }
	Ray casting technique for volume rendering. More...
enum	{ GraphicalResourcesCreatedEvent = 19001, ResetFocalPointRequestedEvent }
	Events. More...
enum	InteractionFlagType {   None = 0, AnimationModeFlag, RenderModeFlag, BoxVisibleFlag,   BoxLabelVisibileFlag, BackgroundColorFlag, StereoTypeFlag, OrientationMarkerTypeFlag,   OrientationMarkerSizeFlag, RulerTypeFlag, RulerColorFlag, UseDepthPeelingFlag,   FPSVisibleFlag }
typedef vtkMRMLAbstractViewNode	Superclass
Public Types inherited from vtkMRMLAbstractViewNode
enum	OrientationMarkerSizeType { OrientationMarkerSizeSmall =0, OrientationMarkerSizeMedium, OrientationMarkerSizeLarge, OrientationMarkerSize_Last }
enum	OrientationMarkerTypeType {   OrientationMarkerTypeNone =0, OrientationMarkerTypeCube, OrientationMarkerTypeHuman, OrientationMarkerTypeAxes,   OrientationMarkerType_Last }
	Enum to specify orientation marker types. More...
enum	RulerColorType { RulerColorWhite =0, RulerColorBlack, RulerColorYellow, RulerColor_Last }
	Enum to specify ruler colors. More...
enum	RulerTypeType { RulerTypeNone =0, RulerTypeThin, RulerTypeThick, RulerType_Last }
	Enum to specify ruler types. More...
typedef vtkMRMLNode	Superclass
Public Types inherited from vtkMRMLNode
enum	{   HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,   ReferenceRemovedEvent, ReferencedNodeModifiedEvent }
typedef vtkObject	Superclass

Public Member Functions
vtkMRMLNode *	CreateNodeInstance () override
	MRMLNode methods. More...
virtual int	GetAnimationMode ()
	Turn on and off animated spinning or rocking. More...
virtual int	GetAnimationMs ()
	Amount of wait time between spin increments. More...
virtual int	GetAxisLabelsCameraDependent ()
	Indicates if the axis labels visibility controlled by camera orientation. More...
virtual int	GetAxisLabelsVisible ()
	Indicates if the axis labels are visible. More...
virtual int	GetBoxVisible ()
	Indicates if the box is visible. More...
virtual const char *	GetClassName ()
virtual double	GetExpectedFPS ()
virtual int	GetFiducialLabelsVisible ()
virtual int	GetFiducialsVisible ()
	Toggles visibility of fiducial points in 3D viewer. More...
virtual double	GetFieldOfView ()
	Field of view size. More...
virtual int	GetFPSVisible ()
virtual int	GetGPUMemorySize ()
virtual int	GetInteracting ()
virtual unsigned int	GetInteractionFlags ()
virtual double	GetLetterSize ()
	Axis label size. More...
virtual int	GetLinkedControl ()
	toggle the view linking More...
const char *	GetNodeTagName () override
	Get node XML tag name (like Volume, Model) More...
virtual int	GetRaycastTechnique ()
	Rycasting technique for volume rendering. More...
virtual int	GetRenderMode ()
	Specifies orthographic or perspective rendering. More...
virtual int	GetRockCount ()
	Increment of animated rock. More...
virtual int	GetRockLength ()
	Length of animated rocking. More...
virtual double	GetRotateDegrees ()
virtual double	GetSpinDegrees ()
	Number of degrees in spin increment. More...
virtual int	GetSpinDirection ()
	Direction of animated spinning. More...
virtual int	GetStereoType ()
	Stereo mode (including NoStereo) More...
virtual int	GetUseDepthPeeling ()
virtual int	GetViewAxisMode ()
virtual double	GetVolumeRenderingOversamplingFactor ()
virtual int	GetVolumeRenderingQuality ()
virtual bool	GetVolumeRenderingSurfaceSmoothing ()
virtual void	InteractingOff ()
virtual void	InteractingOn ()
virtual int	IsA (const char *type)
virtual void	LinkedControlOff ()
virtual void	LinkedControlOn ()
void	PrintSelf (ostream &os, vtkIndent indent) override
void	ReadXMLAttributes (const char **atts) override
	Read node attributes from XML file. More...
virtual void	SetAnimationMode (int)
virtual void	SetAnimationMs (int)
virtual void	SetAxisLabelsCameraDependent (int)
virtual void	SetAxisLabelsVisible (int)
virtual void	SetBoxVisible (int)
virtual void	SetExpectedFPS (double)
	Expected FPS. More...
virtual void	SetFiducialLabelsVisible (int)
virtual void	SetFiducialsVisible (int)
virtual void	SetFieldOfView (double)
virtual void	SetFPSVisible (int)
virtual void	SetGPUMemorySize (int)
void	SetInteracting (int)
void	SetInteractionFlags (unsigned int)
virtual void	SetLetterSize (double)
virtual void	SetLinkedControl (int)
virtual void	SetRaycastTechnique (int)
virtual void	SetRenderMode (int)
virtual void	SetRockCount (int)
virtual void	SetRockLength (int)
virtual void	SetRotateDegrees (double)
virtual void	SetSpinDegrees (double)
virtual void	SetSpinDirection (int)
virtual void	SetStereoType (int)
virtual void	SetUseDepthPeeling (int)
virtual void	SetViewAxisMode (int)
virtual void	SetVolumeRenderingOversamplingFactor (double)
virtual void	SetVolumeRenderingQuality (int)
virtual void	SetVolumeRenderingSurfaceSmoothing (bool)
	vtkMRMLCopyContentMacro (vtkMRMLViewNode)
void	WriteXML (ostream &of, int indent) override
	Write this node's information to a MRML file in XML format. More...
virtual void	SetAutoReleaseGraphicsResources (bool)
virtual bool	GetAutoReleaseGraphicsResources ()
virtual void	AutoReleaseGraphicsResourcesOn ()
virtual void	AutoReleaseGraphicsResourcesOff ()
Public Member Functions inherited from vtkMRMLAbstractViewNode
virtual int	GetActive ()
	Indicates whether or not the view is active. More...
const char *	GetAxisLabel (int labelIndex)
virtual double *	GetBackgroundColor ()
virtual void	GetBackgroundColor (double &, double &, double &)
virtual void	GetBackgroundColor (double [3])
virtual double *	GetBackgroundColor2 ()
virtual void	GetBackgroundColor2 (double &, double &, double &)
virtual void	GetBackgroundColor2 (double [3])
vtkMRMLInteractionNode *	GetInteractionNode ()
	Get interaction node. More...
virtual double *	GetLayoutColor ()
virtual void	GetLayoutColor (double &, double &, double &)
virtual void	GetLayoutColor (double [3])
virtual char *	GetLayoutLabel ()
const char *	GetLayoutName ()
virtual bool	GetOrientationMarkerEnabled ()
vtkMRMLModelNode *	GetOrientationMarkerHumanModelNode ()
const char *	GetOrientationMarkerHumanModelNodeID ()
virtual int	GetOrientationMarkerSize ()
virtual int	GetOrientationMarkerType ()
vtkMRMLNode *	GetParentLayoutNode ()
virtual int	GetRulerColor ()
virtual bool	GetRulerEnabled ()
virtual int	GetRulerType ()
virtual int	GetViewGroup ()
virtual int	GetVisibility ()
	Indicates whether or not the view is visible. More...
virtual int	IsMappedInLayout ()
bool	IsViewVisibleInLayout ()
	Indicates whether or not the view is visible in the current layout. More...
void	PrintSelf (ostream &os, vtkIndent indent) override
void	Reset (vtkMRMLNode *defaultNode) override
	Reimplemented to preserve layout label when reset. More...
virtual void	SetActive (int)
bool	SetAndObserveParentLayoutNode (vtkMRMLNode *node)
bool	SetAndObserveParentLayoutNodeID (const char *layoutNodeId)
void	SetAxisLabel (int labelIndex, const char *label)
virtual void	SetBackgroundColor (double, double, double)
virtual void	SetBackgroundColor (double [3])
virtual void	SetBackgroundColor2 (double, double, double)
virtual void	SetBackgroundColor2 (double [3])
bool	SetInteractionNode (vtkMRMLNode *node)
bool	SetInteractionNodeID (const char *interactionNodeId)
virtual void	SetLayoutColor (double, double, double)
virtual void	SetLayoutColor (double [3])
virtual void	SetLayoutLabel (const char *)
void	SetLayoutName (const char *layoutName)
virtual void	SetMappedInLayout (int value)
void	SetOrientationMarkerHumanModelNodeID (const char *modelNodeId)
virtual void	SetOrientationMarkerSize (int)
	Get/Set orientation marker is size. There are a few predefined marker sizes, defined by an enumerated value (e.g., small, medium, large). More...
virtual void	SetOrientationMarkerType (int)
	Get/Set orientation marker type (e.g., not displayed, cube, human, coordinate system axes) More...
virtual void	SetRulerColor (int)
	Get/Set ruler color (e.g., white or black) More...
virtual void	SetRulerType (int)
	Get/Set ruler type (e.g., not displayed, thin, thick) More...
virtual void	SetViewGroup (int)
virtual void	SetVisibility (int)
	vtkMRMLCopyContentMacro (vtkMRMLAbstractViewNode)
Public Member Functions inherited from vtkMRMLNode
vtkMRMLNode *	AddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
	Add and observe a reference node from this node for a specific referenceRole. More...
vtkMRMLNode *	AddNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
	Convenience method that adds a referencedNodeID at the end of the list. More...
void	AddNodeReferenceRole (const char *referenceRole, const char *mrmlAttributeName=nullptr, vtkIntArray *events=nullptr)
	Add a referenceRole. More...
virtual void	AddToSceneOff ()
virtual void	AddToSceneOn ()
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. More...
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. More...
virtual void	CopyReferences (vtkMRMLNode *node)
	Copy the references of the node into this. More...
void	CopyWithScene (vtkMRMLNode *node)
	Copy everything (including Scene and ID) from another node of the same type. More...
void	DisableModifiedEventOff ()
void	DisableModifiedEventOn ()
virtual int	EndModify (int previousDisableModifiedEventState)
	End modifying the node. More...
virtual int	GetAddToScene ()
	node added to MRML scene. More...
const char *	GetAttribute (const char *name)
	Get value of a name value pair attribute. More...
std::vector< std::string >	GetAttributeNames ()
	Get all attribute names. More...
void	GetAttributeNames (vtkStringArray *attributeNames)
	Get all attribute names. Python-wrappable version. More...
virtual vtkIntArray *	GetContentModifiedEvents ()
virtual char *	GetDescription ()
virtual int	GetDisableModifiedEvent ()
	Turn on/off generating InvokeEvent for set macros. More...
virtual int	GetHideFromEditors ()
	Describes if the node is hidden. More...
virtual char *	GetID ()
	ID use by other nodes to reference this node in XML. More...
virtual int	GetInMRMLCallbackFlag ()
	Flags to avoid event loops. More...
virtual int	GetModifiedEventPending ()
virtual char *	GetName ()
vtkMRMLNode *	GetNodeReference (const char *referenceRole)
const char *	GetNodeReferenceID (const char *referenceRole)
	Utility function that returns the first node id for a specific referenceRole. More...
void	GetNodeReferenceIDs (const char *referenceRole, std::vector< const char *> &referencedNodeIDs)
	Return a list of the referenced node IDs. More...
void	GetNodeReferenceRoles (std::vector< std::string > &roles)
void	GetNodeReferences (const char *referenceRole, std::vector< vtkMRMLNode *> &nodes)
	Return a list of the referenced nodes. More...
vtkMRMLNode *	GetNthNodeReference (const char *referenceRole, int n)
	Get referenced MRML node for a specific referenceRole. More...
const char *	GetNthNodeReferenceID (const char *referenceRole, int n)
	Return the string of the Nth node ID for a specific reference role. More...
const char *	GetNthNodeReferenceRole (int n)
int	GetNumberOfNodeReferenceRoles ()
int	GetNumberOfNodeReferences (const char *referenceRole)
	Return the number of node IDs for a specific reference role (and nodes as they always have the same size). More...
virtual int	GetSaveWithScene ()
	Save node with MRML scene. More...
virtual vtkMRMLScene *	GetScene ()
	Get the scene this node has been added to. More...
virtual int	GetSelectable ()
	Describes if the node is selectable. More...
virtual int	GetSelected ()
	Get/Set for Selected. More...
virtual char *	GetSingletonTag ()
virtual bool	GetUndoEnabled ()
virtual bool	HasCopyContent () const
	Returns true if the class supports deep and shallow copying node content. More...
bool	HasNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
	Return true if referencedNodeID is in the node ID list for a specific referenceRole. More...
virtual void	HideFromEditorsOff ()
virtual void	HideFromEditorsOn ()
virtual void	InvokeCustomModifiedEvent (int eventId, void *callData=nullptr)
	This method allows the node to compress events. More...
virtual int	InvokePendingModifiedEvent ()
	Invokes any modified events that are pending. More...
bool	IsSingleton ()
void	Modified () override
	Customized version of Modified() allowing to compress vtkCommand::ModifiedEvent. More...
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. More...
virtual void	ProcessMRMLEvents (vtkObject *caller, unsigned long event, void *callData)
	Propagate events generated in mrml. More...
void	RemoveAttribute (const char *name)
	Remove attribute with the specified name. More...
void	RemoveNodeReferenceIDs (const char *referenceRole)
	Remove all node IDs and associated nodes for a specific referenceRole. More...
void	RemoveNthNodeReferenceID (const char *referenceRole, int n)
	Convenience method that removes the Nth node ID from the list. More...
virtual void	SaveWithSceneOff ()
virtual void	SaveWithSceneOn ()
virtual void	SelectableOff ()
virtual void	SelectableOn ()
virtual void	SelectedOff ()
virtual void	SelectedOn ()
virtual void	SetAddToScene (int)
void	SetAddToSceneNoModify (int value)
vtkMRMLNode *	SetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
	Set and observe a reference node from this node for a specific referenceRole. More...
vtkMRMLNode *	SetAndObserveNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID, vtkIntArray *events=nullptr)
	Set and observe the Nth node ID for a specific reference role. More...
void	SetAttribute (const char *name, const char *value)
	Set a name value pair attribute. More...
virtual void	SetDescription (const char *)
	Text description of this node, to be set by the user. More...
void	SetDisableModifiedEvent (int onOff)
virtual void	SetHideFromEditors (int)
void	SetInMRMLCallbackFlag (int flag)
virtual void	SetName (const char *)
	Name of this node, to be set by the user. More...
vtkMRMLNode *	SetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
	Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
vtkMRMLNode *	SetNthNodeReferenceID (const char *referenceRole, int n, const char *referencedNodeID)
	Set a N-th reference from this node with specified referencedNodeID for a specific referenceRole. More...
virtual void	SetSaveWithScene (int)
virtual void	SetScene (vtkMRMLScene *scene)
	This method is for internal use only. Use AddNode method of vtkMRMLScene to add a node to the scene. More...
virtual void	SetSceneReferences ()
	Update the references of the node to the scene. More...
virtual void	SetSelectable (int)
virtual void	SetSelected (int)
void	SetSingletonOff ()
void	SetSingletonOn ()
virtual void	SetSingletonTag (const char *)
	Tag that make this node a singleton in the scene. More...
virtual void	SetUndoEnabled (bool)
virtual int	StartModify ()
	Start modifying the node. Disable Modify events. More...
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. More...
virtual void	UpdateReferences ()
	The method should remove all pointers and observations to all nodes that are not in the scene anymore. More...
virtual void	UpdateScene (vtkMRMLScene *)
const char *	URLDecodeString (const char *inString)
	Decode a URL string. More...
const char *	URLEncodeString (const char *inString)
	Encode a URL string. More...
virtual void	WriteNodeBodyXML (ostream &of, int indent)
	Write this node's body to a MRML file in XML format. More...
std::string	XMLAttributeDecodeString (const std::string &inString)
	Decode an XML attribute string. More...
std::string	XMLAttributeEncodeString (const std::string &inString)
	Encode an XML attribute string (replaces special characters by code sequences) More...

Static Public Member Functions
static double *	defaultBackgroundColor ()
	Return the color the view nodes have for the background by default. More...
static double *	defaultBackgroundColor2 ()
static const char *	GetAnimationModeAsString (int id)
static int	GetAnimationModeFromString (const char *name)
static const char *	GetRaycastTechniqueAsString (int id)
static int	GetRaycastTechniqueFromString (const char *name)
static const char *	GetRenderModeAsString (int id)
static int	GetRenderModeFromString (const char *name)
static const char *	GetSpinDirectionAsString (int id)
static int	GetSpinDirectionFromString (const char *name)
static const char *	GetStereoTypeAsString (int id)
static int	GetStereoTypeFromString (const char *name)
static const char *	GetViewAxisModeAsString (int id)
static int	GetViewAxisModeFromString (const char *name)
static const char *	GetVolumeRenderingQualityAsString (int id)
static int	GetVolumeRenderingQualityFromString (const char *name)
static int	IsTypeOf (const char *type)
static vtkMRMLViewNode *	New ()
static vtkMRMLViewNode *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkMRMLAbstractViewNode
static double *	GetCompareColor ()
static double *	GetGrayColor ()
static double *	GetGreenColor ()
static const char *	GetOrientationMarkerSizeAsString (int id)
	Convert between orientation marker type ID and name. More...
static int	GetOrientationMarkerSizeFromString (const char *name)
static const char *	GetOrientationMarkerTypeAsString (int id)
	Convert between orientation marker type ID and name. More...
static int	GetOrientationMarkerTypeFromString (const char *name)
static double *	GetRedColor ()
static const char *	GetRulerColorAsString (int id)
	Convert between ruler color ID and name. More...
static int	GetRulerColorFromString (const char *name)
static const char *	GetRulerTypeAsString (int id)
	Convert between ruler type ID and name. More...
static int	GetRulerTypeFromString (const char *name)
static double *	GetThreeDViewBlueColor ()
static double *	GetYellowColor ()
static int	IsTypeOf (const char *type)
static vtkMRMLAbstractViewNode *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkMRMLNode
static int	IsTypeOf (const char *type)
static vtkMRMLNode *	SafeDownCast (vtkObject *o)

Protected Member Functions
void	operator= (const vtkMRMLViewNode &)
	vtkMRMLViewNode ()
	vtkMRMLViewNode (const vtkMRMLViewNode &)
	~vtkMRMLViewNode () override
Protected Member Functions inherited from vtkMRMLAbstractViewNode
void	operator= (const vtkMRMLAbstractViewNode &)
	vtkMRMLAbstractViewNode ()
	vtkMRMLAbstractViewNode (const vtkMRMLAbstractViewNode &)
	~vtkMRMLAbstractViewNode () 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. More...
virtual const char *	GetReferenceRoleFromMRMLAttributeName (const char *attName)
	Return the reference role (if found) associated with the attribute name found in a MRML scene file. Return 0 otherwise. More...
virtual char *	GetTempURLString ()
void	GetUpdatedReferencedNodeEventList (int &oldReferencedNodeUseCount, int &newReferencedNodeUseCount, vtkIntArray *oldConsolidatedEventList, vtkIntArray *newConsolidatedEventList, vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkMRMLNodeReference *referenceToIgnore, vtkIntArray *newEvents)
virtual void	InvalidateNodeReferences ()
virtual bool	IsReferenceRoleGeneric (const char *refRole)
	Return true if the reference role is generic (ends with '/') or false otherwise. More...
virtual void	OnNodeReferenceAdded (vtkMRMLNodeReference *reference)
virtual void	OnNodeReferenceModified (vtkMRMLNodeReference *reference)
	Called when a referenced node pointer is modified. More...
virtual void	OnNodeReferenceRemoved (vtkMRMLNodeReference *reference)
	Called when a referenced node pointer is removed (set to nullptr). More...
void	operator= (const vtkMRMLNode &)
void	ParseReferencesAttribute (const char *attValue, std::set< std::string > &references)
virtual void	SetTempURLString (const char *)
	Get/Set the string used to manage encoding/decoding of strings/URLs with special characters. More...
vtkMRMLNode *	UpdateNodeReferenceEventObserver (vtkMRMLNode *oldReferencedNode, vtkMRMLNode *newReferencedNode, vtkIntArray *newEvents, vtkMRMLNodeReference *referenceToIgnore)
virtual void	UpdateNodeReferences (const char *referenceRole=nullptr)
virtual void	UpdateNthNodeReference (const char *referenceRole, int n)
	vtkMRMLNode ()
	vtkMRMLNode (const vtkMRMLNode &)
	~vtkMRMLNode () override
	critical to have a virtual destructor! More...

Protected Attributes
int	AnimationMode
	Parameters of automatic spin. More...
int	AnimationMs
bool	AutoReleaseGraphicsResources
	Immediately release graphics resources when they are not in use. More...
int	AxisLabelsCameraDependent
int	AxisLabelsVisible
int	BoxVisible
double	ExpectedFPS
	Expected frame per second rendered. More...
int	FiducialLabelsVisible
int	FiducialsVisible
double	FieldOfView
int	FPSVisible
	Show the Frame per second as text on the lower right part of the view. More...
int	GPUMemorySize
int	Interacting
unsigned int	InteractionFlags
double	LetterSize
int	LinkedControl
int	RaycastTechnique
int	RenderMode
	Specifies orthographic or perspective rendering. More...
int	RockCount
int	RockLength
	Parameters of automatic rock. More...
double	RotateDegrees
double	SpinDegrees
int	SpinDirection
int	StereoType
	Parameters for stereo viewing. More...
int	UseDepthPeeling
	Use the depth peeling rendering mode. More...
int	ViewAxisMode
double	VolumeRenderingOversamplingFactor
int	VolumeRenderingQuality
bool	VolumeRenderingSurfaceSmoothing
	Make surface appearance smoother in volume rendering. Off by default. More...
Protected Attributes inherited from vtkMRMLAbstractViewNode
int	Active {0}
vtkSmartPointer< vtkStringArray >	AxisLabels
	Labels of coordinate system axes More...
double	BackgroundColor [3]
	Background colors More...
double	BackgroundColor2 [3]
double	LayoutColor [3]
	Color for view header in layout as RGB More...
char *	LayoutLabel {nullptr}
	Label to show for the view (shortcut for the name) More...
bool	OrientationMarkerEnabled {false}
int	OrientationMarkerSize {OrientationMarkerSizeMedium}
int	OrientationMarkerType {OrientationMarkerTypeNone}
int	RulerColor {RulerColorWhite}
bool	RulerEnabled {false}
int	RulerType {RulerTypeNone}
int	ViewGroup {0}
	Views with the same ViewGroup value are in the same group. More...
int	Visibility {1}
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 More...
vtkCallbackCommand *	MRMLCallbackCommand
	Holders for MRML callbacks. More...
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
Static Public Attributes inherited from vtkMRMLAbstractViewNode
static const int	AxisLabelsCount
	Total number of coordinate system axis labels. More...
Protected Types inherited from vtkMRMLNode
typedef std::map< std::string, std::string >	AttributesType
typedef std::map< std::string, vtkSmartPointer< vtkIntArray > >	NodeReferenceEventsType
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > >	NodeReferenceListType
typedef std::map< std::string, NodeReferenceListType >	NodeReferencesType
Static Protected Member Functions inherited from vtkMRMLNode
static void	MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
Static Protected Attributes inherited from vtkMRMLAbstractViewNode
static const char *	InteractionNodeReferenceRole
static const char *	OrientationMarkerHumanModelReferenceRole
static const char *	ParentLayoutNodeReferenceRole

Detailed Description

MRML node to represent a 3D view.

View node contains view parameters.

Definition at line 24 of file vtkMRMLViewNode.h.

Member Typedef Documentation

Superclass

typedef vtkMRMLAbstractViewNode vtkMRMLViewNode::Superclass

Definition at line 29 of file vtkMRMLViewNode.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Modes for automatically controlling camera.

Enumerator
RotateAround
LookFrom
ViewAxisMode_Last

Definition at line 186 of file vtkMRMLViewNode.h.

anonymous enum

anonymous enum

Rotate camera directions.

Enumerator
PitchUp
PitchDown
RollLeft
RollRight
YawLeft
YawRight
SpinDirection_Last

Definition at line 194 of file vtkMRMLViewNode.h.

anonymous enum

anonymous enum

Stereo modes.

Enumerator
NoStereo
RedBlue
Anaglyph
QuadBuffer
Interlaced
UserDefined_1
UserDefined_2
UserDefined_3
StereoType_Last

Definition at line 206 of file vtkMRMLViewNode.h.

anonymous enum

anonymous enum

Render modes.

Enumerator
Perspective
Orthographic
RenderMode_Last

Definition at line 220 of file vtkMRMLViewNode.h.

anonymous enum

anonymous enum

Animation mode.

Enumerator
Off
Spin
Rock
AnimationMode_Last

Definition at line 228 of file vtkMRMLViewNode.h.

anonymous enum

anonymous enum

Quality setting used for.

See also

VolumeRenderingQuality

Enumerator
Adaptive	quality determined from desired update rate
Normal	good image quality at reasonable speed
Maximum	high image quality, rendering time is not considered
VolumeRenderingQuality_Last

Definition at line 237 of file vtkMRMLViewNode.h.

anonymous enum

anonymous enum

Ray casting technique for volume rendering.

Enumerator
Composite
CompositeEdgeColoring
MaximumIntensityProjection
MinimumIntensityProjection
GradiantMagnitudeOpacityModulation
IllustrativeContextPreservingExploration
RaycastTechnique_Last

Definition at line 246 of file vtkMRMLViewNode.h.

anonymous enum

anonymous enum

Events.

Enumerator
GraphicalResourcesCreatedEvent
ResetFocalPointRequestedEvent

Definition at line 258 of file vtkMRMLViewNode.h.

InteractionFlagType

enum vtkMRMLViewNode::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: RenderModeFlag - broadcast the RenderMode to all linked viewers

Enumerator
None
AnimationModeFlag
RenderModeFlag
BoxVisibleFlag
BoxLabelVisibileFlag
BackgroundColorFlag
StereoTypeFlag
OrientationMarkerTypeFlag
OrientationMarkerSizeFlag
RulerTypeFlag
RulerColorFlag
UseDepthPeelingFlag
FPSVisibleFlag

Definition at line 279 of file vtkMRMLViewNode.h.

Constructor & Destructor Documentation

vtkMRMLViewNode() [1/2]

vtkMRMLViewNode::vtkMRMLViewNode ( )

protected

~vtkMRMLViewNode()

vtkMRMLViewNode::~vtkMRMLViewNode ( )

overrideprotected

vtkMRMLViewNode() [2/2]

vtkMRMLViewNode::vtkMRMLViewNode ( const vtkMRMLViewNode &  )

protected

Member Function Documentation

AutoReleaseGraphicsResourcesOff()

virtual void vtkMRMLViewNode::AutoReleaseGraphicsResourcesOff ( )

virtual

AutoReleaseGraphicsResourcesOn()

virtual void vtkMRMLViewNode::AutoReleaseGraphicsResourcesOn ( )

virtual

CreateNodeInstance()

vtkMRMLNode* vtkMRMLViewNode::CreateNodeInstance ( )

overridevirtual

MRMLNode methods.

Implements vtkMRMLNode.

defaultBackgroundColor()

static double* vtkMRMLViewNode::defaultBackgroundColor ( )

static

Return the color the view nodes have for the background by default.

defaultBackgroundColor2()

static double* vtkMRMLViewNode::defaultBackgroundColor2 ( )

static

GetAnimationMode()

virtual int vtkMRMLViewNode::GetAnimationMode ( )

virtual

Turn on and off animated spinning or rocking.

GetAnimationModeAsString()

static const char* vtkMRMLViewNode::GetAnimationModeAsString ( int  id )

static

GetAnimationModeFromString()

static int vtkMRMLViewNode::GetAnimationModeFromString ( const char *  name )

static

GetAnimationMs()

virtual int vtkMRMLViewNode::GetAnimationMs ( )

virtual

Amount of wait time between spin increments.

GetAutoReleaseGraphicsResources()

virtual bool vtkMRMLViewNode::GetAutoReleaseGraphicsResources ( )

virtual

GetAxisLabelsCameraDependent()

virtual int vtkMRMLViewNode::GetAxisLabelsCameraDependent ( )

virtual

Indicates if the axis labels visibility controlled by camera orientation.

GetAxisLabelsVisible()

virtual int vtkMRMLViewNode::GetAxisLabelsVisible ( )

virtual

Indicates if the axis labels are visible.

GetBoxVisible()

virtual int vtkMRMLViewNode::GetBoxVisible ( )

virtual

Indicates if the box is visible.

GetClassName()

virtual const char* vtkMRMLViewNode::GetClassName ( )

virtual

Reimplemented from vtkMRMLAbstractViewNode.

GetExpectedFPS()

virtual double vtkMRMLViewNode::GetExpectedFPS ( )

virtual

GetFiducialLabelsVisible()

virtual int vtkMRMLViewNode::GetFiducialLabelsVisible ( )

virtual

GetFiducialsVisible()

virtual int vtkMRMLViewNode::GetFiducialsVisible ( )

virtual

Toggles visibility of fiducial points in 3D viewer.

GetFieldOfView()

virtual double vtkMRMLViewNode::GetFieldOfView ( )

virtual

Field of view size.

GetFPSVisible()

virtual int vtkMRMLViewNode::GetFPSVisible ( )

virtual

Show FPS in the lower right side of the screen. 0 by default.

GetGPUMemorySize()

virtual int vtkMRMLViewNode::GetGPUMemorySize ( )

virtual

GPU memory size in MB 0 by default (application default)

GetInteracting()

virtual int vtkMRMLViewNode::GetInteracting ( )

virtual

GetInteractionFlags()

virtual unsigned int vtkMRMLViewNode::GetInteractionFlags ( )

virtual

GetLetterSize()

virtual double vtkMRMLViewNode::GetLetterSize ( )

virtual

Axis label size.

GetLinkedControl()

virtual int vtkMRMLViewNode::GetLinkedControl ( )

virtual

toggle the view linking

GetNodeTagName()

const char* vtkMRMLViewNode::GetNodeTagName ( )

overridevirtual

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

GetRaycastTechnique()

virtual int vtkMRMLViewNode::GetRaycastTechnique ( )

virtual

Rycasting technique for volume rendering.

GetRaycastTechniqueAsString()

static const char* vtkMRMLViewNode::GetRaycastTechniqueAsString ( int  id )

static

GetRaycastTechniqueFromString()

static int vtkMRMLViewNode::GetRaycastTechniqueFromString ( const char *  name )

static

GetRenderMode()

virtual int vtkMRMLViewNode::GetRenderMode ( )

virtual

Specifies orthographic or perspective rendering.

GetRenderModeAsString()

static const char* vtkMRMLViewNode::GetRenderModeAsString ( int  id )

static

GetRenderModeFromString()

static int vtkMRMLViewNode::GetRenderModeFromString ( const char *  name )

static

GetRockCount()

virtual int vtkMRMLViewNode::GetRockCount ( )

virtual

Increment of animated rock.

GetRockLength()

virtual int vtkMRMLViewNode::GetRockLength ( )

virtual

Length of animated rocking.

GetRotateDegrees()

virtual double vtkMRMLViewNode::GetRotateDegrees ( )

virtual

GetSpinDegrees()

virtual double vtkMRMLViewNode::GetSpinDegrees ( )

virtual

Number of degrees in spin increment.

GetSpinDirection()

virtual int vtkMRMLViewNode::GetSpinDirection ( )

virtual

Direction of animated spinning.

GetSpinDirectionAsString()

static const char* vtkMRMLViewNode::GetSpinDirectionAsString ( int  id )

static

GetSpinDirectionFromString()

static int vtkMRMLViewNode::GetSpinDirectionFromString ( const char *  name )

static

GetStereoType()

virtual int vtkMRMLViewNode::GetStereoType ( )

virtual

Stereo mode (including NoStereo)

GetStereoTypeAsString()

static const char* vtkMRMLViewNode::GetStereoTypeAsString ( int  id )

static

GetStereoTypeFromString()

static int vtkMRMLViewNode::GetStereoTypeFromString ( const char *  name )

static

GetUseDepthPeeling()

virtual int vtkMRMLViewNode::GetUseDepthPeeling ( )

virtual

Use depth peeling or not. 0 by default.

GetViewAxisMode()

virtual int vtkMRMLViewNode::GetViewAxisMode ( )

virtual

GetViewAxisModeAsString()

static const char* vtkMRMLViewNode::GetViewAxisModeAsString ( int  id )

static

GetViewAxisModeFromString()

static int vtkMRMLViewNode::GetViewAxisModeFromString ( const char *  name )

static

GetVolumeRenderingOversamplingFactor()

virtual double vtkMRMLViewNode::GetVolumeRenderingOversamplingFactor ( )

virtual

GetVolumeRenderingQuality()

virtual int vtkMRMLViewNode::GetVolumeRenderingQuality ( )

virtual

GetVolumeRenderingQualityAsString()

static const char* vtkMRMLViewNode::GetVolumeRenderingQualityAsString ( int  id )

static

GetVolumeRenderingQualityFromString()

static int vtkMRMLViewNode::GetVolumeRenderingQualityFromString ( const char *  name )

static

GetVolumeRenderingSurfaceSmoothing()

virtual bool vtkMRMLViewNode::GetVolumeRenderingSurfaceSmoothing ( )

virtual

Reduce wood grain artifact to make surfaces appear smoother. For example, by applying jittering on casted rays. Note: Only applies to GPU-based techniques

InteractingOff()

virtual void vtkMRMLViewNode::InteractingOff ( )

virtual

InteractingOn()

virtual void vtkMRMLViewNode::InteractingOn ( )

virtual

IsA()

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

virtual

Reimplemented from vtkMRMLAbstractViewNode.

IsTypeOf()

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

static

LinkedControlOff()

virtual void vtkMRMLViewNode::LinkedControlOff ( )

virtual

LinkedControlOn()

virtual void vtkMRMLViewNode::LinkedControlOn ( )

virtual

New()

static vtkMRMLViewNode* vtkMRMLViewNode::New ( )

static

operator=()

void vtkMRMLViewNode::operator= ( const vtkMRMLViewNode &  )

protected

PrintSelf()

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

override

ReadXMLAttributes()

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

overridevirtual

Read node attributes from XML file.

Reimplemented from vtkMRMLAbstractViewNode.

SafeDownCast()

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

static

SetAnimationMode()

virtual void vtkMRMLViewNode::SetAnimationMode ( int  )

virtual

SetAnimationMs()

virtual void vtkMRMLViewNode::SetAnimationMs ( int  )

virtual

SetAutoReleaseGraphicsResources()

virtual void vtkMRMLViewNode::SetAutoReleaseGraphicsResources ( bool  )

virtual

Enable/Disable automatic immediate release of graphics resources when not in use. If GPU volume rendering is used, enabling this option makes the volume immediately unloaded from GPU memory when visibility is turned off. Disabled by default to allow faster toggling of visibility.

SetAxisLabelsCameraDependent()

virtual void vtkMRMLViewNode::SetAxisLabelsCameraDependent ( int  )

virtual

SetAxisLabelsVisible()

virtual void vtkMRMLViewNode::SetAxisLabelsVisible ( int  )

virtual

SetBoxVisible()

virtual void vtkMRMLViewNode::SetBoxVisible ( int  )

virtual

SetExpectedFPS()

virtual void vtkMRMLViewNode::SetExpectedFPS ( double  )

virtual

Expected FPS.

SetFiducialLabelsVisible()

virtual void vtkMRMLViewNode::SetFiducialLabelsVisible ( int  )

virtual

SetFiducialsVisible()

virtual void vtkMRMLViewNode::SetFiducialsVisible ( int  )

virtual

SetFieldOfView()

virtual void vtkMRMLViewNode::SetFieldOfView ( double  )

virtual

SetFPSVisible()

virtual void vtkMRMLViewNode::SetFPSVisible ( int  )

virtual

SetGPUMemorySize()

virtual void vtkMRMLViewNode::SetGPUMemorySize ( int  )

virtual

SetInteracting()

void vtkMRMLViewNode::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 cause a Modified().

SetInteractionFlags()

void vtkMRMLViewNode::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 cause a Modified().

SetLetterSize()

virtual void vtkMRMLViewNode::SetLetterSize ( double  )

virtual

SetLinkedControl()

virtual void vtkMRMLViewNode::SetLinkedControl ( int  )

virtual

SetRaycastTechnique()

virtual void vtkMRMLViewNode::SetRaycastTechnique ( int  )

virtual

SetRenderMode()

virtual void vtkMRMLViewNode::SetRenderMode ( int  )

virtual

SetRockCount()

virtual void vtkMRMLViewNode::SetRockCount ( int  )

virtual

SetRockLength()

virtual void vtkMRMLViewNode::SetRockLength ( int  )

virtual

SetRotateDegrees()

virtual void vtkMRMLViewNode::SetRotateDegrees ( double  )

virtual

SetSpinDegrees()

virtual void vtkMRMLViewNode::SetSpinDegrees ( double  )

virtual

SetSpinDirection()

virtual void vtkMRMLViewNode::SetSpinDirection ( int  )

virtual

SetStereoType()

virtual void vtkMRMLViewNode::SetStereoType ( int  )

virtual

SetUseDepthPeeling()

virtual void vtkMRMLViewNode::SetUseDepthPeeling ( int  )

virtual

SetViewAxisMode()

virtual void vtkMRMLViewNode::SetViewAxisMode ( int  )

virtual

SetVolumeRenderingOversamplingFactor()

virtual void vtkMRMLViewNode::SetVolumeRenderingOversamplingFactor ( double  )

virtual

Oversampling factor for sample distance. The sample distance is calculated by

See also

GetSampleDistance to be the volume's minimum spacing divided by the oversampling factor. If

VolumeRenderingQuality is set to maximum quality, then a fix oversampling factor of 10 is used.

SetVolumeRenderingQuality()

virtual void vtkMRMLViewNode::SetVolumeRenderingQuality ( int  )

virtual

SetVolumeRenderingSurfaceSmoothing()

virtual void vtkMRMLViewNode::SetVolumeRenderingSurfaceSmoothing ( bool  )

virtual

vtkMRMLCopyContentMacro()

vtkMRMLViewNode::vtkMRMLCopyContentMacro

(

vtkMRMLViewNode

)

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

See also

vtkMRMLNode::CopyContent

WriteXML()

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

overridevirtual

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

Reimplemented from vtkMRMLAbstractViewNode.

Member Data Documentation

AnimationMode

int vtkMRMLViewNode::AnimationMode

protected

Parameters of automatic spin.

Definition at line 325 of file vtkMRMLViewNode.h.

AnimationMs

int vtkMRMLViewNode::AnimationMs

protected

Definition at line 328 of file vtkMRMLViewNode.h.

AutoReleaseGraphicsResources

bool vtkMRMLViewNode::AutoReleaseGraphicsResources

protected

Immediately release graphics resources when they are not in use.

Definition at line 360 of file vtkMRMLViewNode.h.

AxisLabelsCameraDependent

int vtkMRMLViewNode::AxisLabelsCameraDependent

protected

Definition at line 320 of file vtkMRMLViewNode.h.

AxisLabelsVisible

int vtkMRMLViewNode::AxisLabelsVisible

protected

Definition at line 319 of file vtkMRMLViewNode.h.

BoxVisible

int vtkMRMLViewNode::BoxVisible

protected

Definition at line 318 of file vtkMRMLViewNode.h.

ExpectedFPS

double vtkMRMLViewNode::ExpectedFPS

protected

Expected frame per second rendered.

Definition at line 363 of file vtkMRMLViewNode.h.

FiducialLabelsVisible

int vtkMRMLViewNode::FiducialLabelsVisible

protected

Definition at line 317 of file vtkMRMLViewNode.h.

FiducialsVisible

int vtkMRMLViewNode::FiducialsVisible

protected

Definition at line 316 of file vtkMRMLViewNode.h.

FieldOfView

double vtkMRMLViewNode::FieldOfView

protected

Definition at line 321 of file vtkMRMLViewNode.h.

FPSVisible

int vtkMRMLViewNode::FPSVisible

protected

Show the Frame per second as text on the lower right part of the view.

Definition at line 352 of file vtkMRMLViewNode.h.

GPUMemorySize

int vtkMRMLViewNode::GPUMemorySize

protected

Tracking GPU memory size in MB. Not saved into scene file because different machines may have different GPU memory values. A value of 0 indicates to use the default value in the settings

Definition at line 357 of file vtkMRMLViewNode.h.

Interacting

int vtkMRMLViewNode::Interacting

protected

Definition at line 390 of file vtkMRMLViewNode.h.

InteractionFlags

unsigned int vtkMRMLViewNode::InteractionFlags

protected

Definition at line 391 of file vtkMRMLViewNode.h.

LetterSize

double vtkMRMLViewNode::LetterSize

protected

Definition at line 322 of file vtkMRMLViewNode.h.

LinkedControl

int vtkMRMLViewNode::LinkedControl

protected

Definition at line 389 of file vtkMRMLViewNode.h.

RaycastTechnique

int vtkMRMLViewNode::RaycastTechnique

protected

Techniques for volume rendering ray cast 0: Composite with directional lighting (default) 1: Composite with fake lighting (edge coloring, faster) - Not used 2: MIP 3: MINIP 4: Gradient Magnitude Opacity Modulation - Not used 5: Illustrative Context Preserving Exploration - Not used

Definition at line 378 of file vtkMRMLViewNode.h.

RenderMode

int vtkMRMLViewNode::RenderMode

protected

Specifies orthographic or perspective rendering.

Definition at line 342 of file vtkMRMLViewNode.h.

RockCount

int vtkMRMLViewNode::RockCount

protected

Definition at line 332 of file vtkMRMLViewNode.h.

RockLength

int vtkMRMLViewNode::RockLength

protected

Parameters of automatic rock.

Definition at line 331 of file vtkMRMLViewNode.h.

RotateDegrees

double vtkMRMLViewNode::RotateDegrees

protected

Increment used to rotate the view once about an axis.

Definition at line 336 of file vtkMRMLViewNode.h.

SpinDegrees

double vtkMRMLViewNode::SpinDegrees

protected

Definition at line 327 of file vtkMRMLViewNode.h.

SpinDirection

int vtkMRMLViewNode::SpinDirection

protected

Definition at line 326 of file vtkMRMLViewNode.h.

StereoType

int vtkMRMLViewNode::StereoType

protected

Parameters for stereo viewing.

Definition at line 339 of file vtkMRMLViewNode.h.

UseDepthPeeling

int vtkMRMLViewNode::UseDepthPeeling

protected

Use the depth peeling rendering mode.

Definition at line 349 of file vtkMRMLViewNode.h.

ViewAxisMode

int vtkMRMLViewNode::ViewAxisMode

protected

Parameters for look-from or rotate-around automatic view control

Definition at line 346 of file vtkMRMLViewNode.h.

VolumeRenderingOversamplingFactor

double vtkMRMLViewNode::VolumeRenderingOversamplingFactor

protected

Oversampling factor for sample distance. The sample distance is calculated by

See also

GetSampleDistance to be the volume's minimum spacing divided by the oversampling factor. If

VolumeRenderingQuality is set to maximum quality, then a fix oversampling factor of 10 is used.

Definition at line 387 of file vtkMRMLViewNode.h.

VolumeRenderingQuality

int vtkMRMLViewNode::VolumeRenderingQuality

protected

Volume rendering quality control mode 0: Adaptive 1: Normal Quality 2: Maximum Quality

Definition at line 369 of file vtkMRMLViewNode.h.

VolumeRenderingSurfaceSmoothing

bool vtkMRMLViewNode::VolumeRenderingSurfaceSmoothing

protected

Make surface appearance smoother in volume rendering. Off by default.

Definition at line 381 of file vtkMRMLViewNode.h.

---

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

• Libs/MRML/Core/vtkMRMLViewNode.h