vtkMRMLViewNode Class Reference

#include <vtkMRMLViewNode.h>

Inheritance diagram for vtkMRMLViewNode:
vtkMRMLNode vtkObject

List of all members.

Public Types

enum  { RotateAround = 0, LookFrom }
 

vtkSetMacro (RenderMode, int );

More...
enum  {
  PitchUp = 0, PitchDown, RollLeft, RollRight,
  YawLeft, YawRight
}
 

Rotate camera directions.

More...
enum  {
  NoStereo = 0, RedBlue, Anaglyph, CrystalEyes,
  Interlaced
}
 

Stereo modes.

More...
enum  { Perspective = 0, Orthographic }
 

render modes

More...
enum  { Off = 0, Spin, Rock }
 

animation mode

More...
enum  {
  AnimationModeEvent = 19001, RenderModeEvent, StereoModeEvent, VisibilityEvent,
  BackgroundColorEvent, ActiveModifiedEvent, GraphicalResourcesCreatedEvent
}
 

events

More...

Public Member Functions

virtual void Copy (vtkMRMLNode *node)
virtual vtkMRMLNode * CreateNodeInstance ()
 MRMLNode methods.
virtual const char * GetNodeTagName ()
void PrintSelf (ostream &os, vtkIndent indent)
virtual void ReadXMLAttributes (const char **atts)
virtual void SetActive (int)
virtual void SetAnimationMode (int)
virtual void SetAxisLabelsVisible (int)
virtual void SetBackgroundColor (double *color)
virtual void SetBoxVisible (int)
virtual void SetFiducialLabelsVisible (int)
virtual void SetFiducialsVisible (int)
virtual void SetRenderMode (int)
virtual void SetStereoType (int)
virtual void SetVisibility (int)
 vtkGetMacro (RenderMode, int)
 vtkSetMacro ( StereoType, int );
 vtkGetMacro (StereoType, int)
 vtkGetMacro (RockCount, int)
 vtkGetMacro (RockLength, int)
 vtkGetMacro (AnimationMs, int)
 vtkGetMacro (RotateDegrees, double)
 vtkGetMacro (SpinDegrees, double)
 vtkGetMacro (SpinDirection, int)
 vtkGetMacro (ViewAxisMode, int)
 vtkSetMacro (AnimationMode, int );
 vtkGetMacro (AnimationMode, int)
 vtkSetVector3Macro (BackgroundColor, double);
 vtkGetMacro (LetterSize, double)
 vtkGetMacro (FieldOfView, double)
 vtkGetMacro (FiducialLabelsVisible, int)
 vtkSetMacro (FiducialsVisible, int);
 vtkGetMacro (FiducialsVisible, int)
 vtkSetMacro(AxisLabelsVisible, int);
 vtkGetMacro (AxisLabelsVisible, int)
 vtkGetMacro (BoxVisible, int)
 vtkGetMacro (Visibility, int)
 vtkGetMacro (Active, int)
 vtkGetVector3Macro (BackgroundColor, double)
 vtkSetMacro (RockCount, int)
 vtkSetMacro (RockLength, int)
 vtkSetMacro (AnimationMs, int)
 vtkSetMacro (RotateDegrees, double)
 vtkSetMacro (SpinDegrees, double)
 vtkSetMacro (SpinDirection, int)
 vtkSetMacro (ViewAxisMode, int)
 vtkSetMacro (LetterSize, double)
 vtkSetMacro (FieldOfView, double)
 vtkTypeMacro (vtkMRMLViewNode, vtkMRMLNode)
virtual void WriteXML (ostream &of, int indent)

Static Public Member Functions

static vtkMRMLViewNode * New ()

Protected Member Functions

void operator= (const vtkMRMLViewNode &)
virtual void RemoveActiveFlagInScene ()
 vtkMRMLViewNode (const vtkMRMLViewNode &)
 vtkMRMLViewNode ()
 ~vtkMRMLViewNode ()

Protected Attributes

int Active
int AnimationMode
int AnimationMs
int AxisLabelsVisible
double BackgroundColor [3]
int BoxVisible
int FiducialLabelsVisible
int FiducialsVisible
double FieldOfView
double LetterSize
int RenderMode
int RockCount
int RockLength
double RotateDegrees
double SpinDegrees
int SpinDirection
int StereoType
int ViewAxisMode
int Visibility

Detailed Description

vtkMRMLViewNode - MRML node to represent view parameters

View node contains view parameters

Member Enumeration Documentation

anonymous enum

vtkSetMacro (RenderMode, int );

Modes for automatically controlling camera

Enumerator:
RotateAround 
LookFrom 
anonymous enum

Rotate camera directions.

Enumerator:
PitchUp 
PitchDown 
RollLeft 
RollRight 
YawLeft 
YawRight 
anonymous enum

Stereo modes.

Enumerator:
NoStereo 
RedBlue 
Anaglyph 
CrystalEyes 
Interlaced 
anonymous enum

render modes

Enumerator:
Perspective 
Orthographic 
anonymous enum

animation mode

Enumerator:
Off 
Spin 
Rock 
anonymous enum

events

Enumerator:
AnimationModeEvent 
RenderModeEvent 
StereoModeEvent 
VisibilityEvent 
BackgroundColorEvent 
ActiveModifiedEvent 
GraphicalResourcesCreatedEvent 

Constructor & Destructor Documentation

vtkMRMLViewNode::vtkMRMLViewNode (  )  [protected]

References Active, AnimationMode, AnimationMs, AxisLabelsVisible, BackgroundColor, BoxVisible, FiducialLabelsVisible, FiducialsVisible, FieldOfView, vtkMRMLNode::HideFromEditors, LetterSize, LookFrom, NoStereo, Off, Perspective, RenderMode, RockCount, RockLength, RotateDegrees, SpinDegrees, SpinDirection, StereoType, ViewAxisMode, Visibility, and YawLeft.

vtkMRMLViewNode::~vtkMRMLViewNode (  )  [protected]
vtkMRMLViewNode::vtkMRMLViewNode ( const vtkMRMLViewNode &   )  [protected]

Member Function Documentation

void vtkMRMLViewNode::Copy ( vtkMRMLNode *  node  )  [virtual]

Copy the node's attributes to this object

References Active, vtkMRMLNode::EndModify(), SetAnimationMode(), SetAxisLabelsVisible(), SetBackgroundColor(), SetBoxVisible(), SetFiducialLabelsVisible(), SetFiducialsVisible(), SetRenderMode(), SetStereoType(), vtkMRMLNode::StartModify(), and Visibility.

vtkMRMLNode * vtkMRMLViewNode::CreateNodeInstance ( void   )  [virtual]

MRMLNode methods.

Implements vtkMRMLNode.

References autoSlicerTracto2regions::ret.

const char * vtkMRMLViewNode::GetNodeTagName (  )  [virtual]

Get node XML tag name (like Volume, Model)

Implements vtkMRMLNode.

Referenced by vtkSlicerApplicationGUI::OnViewNodeNeeded().

vtkMRMLViewNode * vtkMRMLViewNode::New (  )  [static]

Reimplemented from vtkMRMLNode.

References autoSlicerTracto2regions::ret.

void vtkMRMLViewNode::operator= ( const vtkMRMLViewNode &   )  [protected]

Reimplemented from vtkMRMLNode.

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

Reimplemented from vtkMRMLNode.

References Active, AnimationMode, AnimationMs, AxisLabelsVisible, BackgroundColor, BoxVisible, FiducialLabelsVisible, FiducialsVisible, FieldOfView, LetterSize, RenderMode, RockCount, RockLength, RotateDegrees, SpinDegrees, SpinDirection, StereoType, ViewAxisMode, and Visibility.

void vtkMRMLViewNode::ReadXMLAttributes ( const char **  atts  )  [virtual]

Read node attributes from XML file

Reimplemented from vtkMRMLNode.

References Active, Anaglyph, AnimationMode, AnimationMs, AxisLabelsVisible, BackgroundColor, BoxVisible, CrystalEyes, vtkMRMLNode::EndModify(), FiducialLabelsVisible, FiducialsVisible, FieldOfView, Interlaced, len, LetterSize, LookFrom, NoStereo, Off, Orthographic, Perspective, PitchDown, PitchUp, RedBlue, RenderMode, Rock, RockCount, RockLength, RollLeft, RollRight, RotateAround, RotateDegrees, Spin, SpinDegrees, SpinDirection, vtkMRMLNode::StartModify(), StereoType, ModifyHeader::val, ViewAxisMode, Visibility, YawLeft, and YawRight.

void vtkMRMLViewNode::RemoveActiveFlagInScene (  )  [protected, virtual]

When a view is set Active, make other views inactive.

References vtkMRMLScene::GetNthNodeByClass(), vtkMRMLScene::GetNumberOfNodesByClass(), mathExample::n, vtkMRMLNode::Scene, and SetActive().

Referenced by SetActive().

void vtkMRMLViewNode::SetActive ( int  _arg  )  [virtual]

References Active, ActiveModifiedEvent, vtkMRMLNode::Modified(), and RemoveActiveFlagInScene().

Referenced by vtkSlicerApplicationGUI::OnViewNodeAdded(), vtkSlicerCamerasGUI::ProcessGUIEvents(), and RemoveActiveFlagInScene().

void vtkMRMLViewNode::SetAnimationMode ( int  m  )  [virtual]

References AnimationMode, AnimationModeEvent, Off, Rock, and Spin.

Referenced by Copy().

void vtkMRMLViewNode::SetAxisLabelsVisible ( int  m  )  [virtual]

References AxisLabelsVisible, and VisibilityEvent.

Referenced by Copy(), vtkIA_FEMeshGUI::Enter(), vtkIA_FEMeshGUI::Exit(), and vtkSlicerViewControlGUI::MainViewResetFocalPoint().

void vtkMRMLViewNode::SetBackgroundColor ( double *  color  )  [virtual]

References BackgroundColor, and BackgroundColorEvent.

Referenced by Copy(), vtkIA_FEMeshGUI::Enter(), and vtkIA_FEMeshGUI::Exit().

void vtkMRMLViewNode::SetBoxVisible ( int  m  )  [virtual]

References BoxVisible, and VisibilityEvent.

Referenced by Copy(), vtkIA_FEMeshGUI::Enter(), vtkIA_FEMeshGUI::Exit(), and vtkSlicerViewControlGUI::MainViewResetFocalPoint().

void vtkMRMLViewNode::SetFiducialLabelsVisible ( int  m  )  [virtual]

References FiducialLabelsVisible, and VisibilityEvent.

Referenced by Copy().

void vtkMRMLViewNode::SetFiducialsVisible ( int  m  )  [virtual]

References FiducialsVisible, and VisibilityEvent.

Referenced by Copy().

void vtkMRMLViewNode::SetRenderMode ( int  m  )  [virtual]

References Orthographic, Perspective, RenderMode, and RenderModeEvent.

Referenced by Copy().

void vtkMRMLViewNode::SetStereoType ( int  m  )  [virtual]

References Anaglyph, CrystalEyes, Interlaced, NoStereo, RedBlue, StereoModeEvent, and StereoType.

Referenced by Copy().

void vtkMRMLViewNode::SetVisibility ( int  _arg  )  [virtual]

References vtkMRMLNode::Modified(), Visibility, and VisibilityEvent.

Referenced by vtkSlicerApplicationGUI::PackDual3DView(), vtkSlicerApplicationGUI::PackTriple3DEndoscopyView(), and vtkSlicerApplicationGUI::UpdateMain3DViewers().

vtkMRMLViewNode::vtkGetMacro ( RenderMode  ,
int   
)

vtkSetMacro ( StereoType, int );

specifies orthographic or perspective rendering

vtkMRMLViewNode::vtkGetMacro ( StereoType  ,
int   
)

stereo mode (including nostereo)

vtkMRMLViewNode::vtkGetMacro ( RockCount  ,
int   
)

Increment of animated rock

vtkMRMLViewNode::vtkGetMacro ( RockLength  ,
int   
)

Length of animated rocking

vtkMRMLViewNode::vtkGetMacro ( AnimationMs  ,
int   
)

Amount of wait time between spin increments

vtkMRMLViewNode::vtkGetMacro ( RotateDegrees  ,
double   
)
vtkMRMLViewNode::vtkGetMacro ( SpinDegrees  ,
double   
)

Number of degrees in spin increment.

vtkMRMLViewNode::vtkGetMacro ( SpinDirection  ,
int   
)

Direction of animated spinning

vtkMRMLViewNode::vtkGetMacro ( ViewAxisMode  ,
int   
)

vtkSetMacro (AnimationMode, int );

vtkMRMLViewNode::vtkGetMacro ( AnimationMode  ,
int   
)

vtkSetVector3Macro (BackgroundColor, double);

Turn on and off animated spinning or rocking.

vtkMRMLViewNode::vtkGetMacro ( LetterSize  ,
double   
)

Axis label size

vtkMRMLViewNode::vtkGetMacro ( FieldOfView  ,
double   
)

Field of view size

vtkMRMLViewNode::vtkGetMacro ( FiducialLabelsVisible  ,
int   
)

vtkSetMacro (FiducialsVisible, int);

vtkMRMLViewNode::vtkGetMacro ( FiducialsVisible  ,
int   
)

vtkSetMacro(AxisLabelsVisible, int);

Toggles visibility of fiducial points in 3D viewer

vtkMRMLViewNode::vtkGetMacro ( AxisLabelsVisible  ,
int   
)

Indicates if the axis labels are visible

vtkMRMLViewNode::vtkGetMacro ( BoxVisible  ,
int   
)

Indicates if the box is visible

vtkMRMLViewNode::vtkGetMacro ( Visibility  ,
int   
)

Indicates whether or not the view is visible (if it is not visible, then the view is not shown in any of the view layouts, but can be privately used by modules)

vtkMRMLViewNode::vtkGetMacro ( Active  ,
int   
)

Indicates whether or not the view is active

vtkMRMLViewNode::vtkGetVector3Macro ( BackgroundColor  ,
double   
)

Background color

vtkMRMLViewNode::vtkSetMacro ( RockCount  ,
int   
)
vtkMRMLViewNode::vtkSetMacro ( RockLength  ,
int   
)
vtkMRMLViewNode::vtkSetMacro ( AnimationMs  ,
int   
)
vtkMRMLViewNode::vtkSetMacro ( RotateDegrees  ,
double   
)
vtkMRMLViewNode::vtkSetMacro ( SpinDegrees  ,
double   
)
vtkMRMLViewNode::vtkSetMacro ( SpinDirection  ,
int   
)
vtkMRMLViewNode::vtkSetMacro ( ViewAxisMode  ,
int   
)
vtkMRMLViewNode::vtkSetMacro ( LetterSize  ,
double   
)
vtkMRMLViewNode::vtkSetMacro ( FieldOfView  ,
double   
)
vtkMRMLViewNode::vtkTypeMacro ( vtkMRMLViewNode  ,
vtkMRMLNode   
)
void vtkMRMLViewNode::WriteXML ( ostream &  of,
int  indent 
) [virtual]

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

Reimplemented from vtkMRMLNode.

References Active, Anaglyph, AxisLabelsVisible, BackgroundColor, BoxVisible, CrystalEyes, FiducialLabelsVisible, FiducialsVisible, Interlaced, LookFrom, NoStereo, Off, Orthographic, Perspective, PitchDown, PitchUp, RedBlue, Rock, RollLeft, RollRight, RotateAround, Spin, Visibility, YawLeft, and YawRight.

Member Data Documentation

int vtkMRMLViewNode::Active [protected]

Indicates whether or not the View is active

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), SetActive(), vtkMRMLViewNode(), and WriteXML().

int vtkMRMLViewNode::AnimationMode [protected]

parameters of automatic spin

Referenced by PrintSelf(), ReadXMLAttributes(), SetAnimationMode(), and vtkMRMLViewNode().

int vtkMRMLViewNode::AnimationMs [protected]

Referenced by PrintSelf(), ReadXMLAttributes(), and vtkMRMLViewNode().

int vtkMRMLViewNode::AxisLabelsVisible [protected]

Referenced by PrintSelf(), ReadXMLAttributes(), SetAxisLabelsVisible(), vtkMRMLViewNode(), and WriteXML().

double vtkMRMLViewNode::BackgroundColor[3] [protected]

Referenced by PrintSelf(), ReadXMLAttributes(), SetBackgroundColor(), vtkMRMLViewNode(), and WriteXML().

int vtkMRMLViewNode::BoxVisible [protected]

Referenced by PrintSelf(), ReadXMLAttributes(), SetBoxVisible(), vtkMRMLViewNode(), and WriteXML().

int vtkMRMLViewNode::FiducialLabelsVisible [protected]

Referenced by PrintSelf(), ReadXMLAttributes(), SetFiducialLabelsVisible(), vtkMRMLViewNode(), and WriteXML().

int vtkMRMLViewNode::FiducialsVisible [protected]

Referenced by PrintSelf(), ReadXMLAttributes(), SetFiducialsVisible(), vtkMRMLViewNode(), and WriteXML().

double vtkMRMLViewNode::FieldOfView [protected]

Referenced by PrintSelf(), ReadXMLAttributes(), and vtkMRMLViewNode().

double vtkMRMLViewNode::LetterSize [protected]

Referenced by PrintSelf(), ReadXMLAttributes(), and vtkMRMLViewNode().

int vtkMRMLViewNode::RenderMode [protected]

Specifies orthographic or perspective rendering

Referenced by PrintSelf(), ReadXMLAttributes(), SetRenderMode(), and vtkMRMLViewNode().

int vtkMRMLViewNode::RockCount [protected]

Referenced by PrintSelf(), ReadXMLAttributes(), and vtkMRMLViewNode().

int vtkMRMLViewNode::RockLength [protected]

parameters of automatic rock

Referenced by PrintSelf(), ReadXMLAttributes(), and vtkMRMLViewNode().

double vtkMRMLViewNode::RotateDegrees [protected]

Increment used to rotate the view once about an axis.

Referenced by PrintSelf(), ReadXMLAttributes(), and vtkMRMLViewNode().

double vtkMRMLViewNode::SpinDegrees [protected]

Referenced by PrintSelf(), ReadXMLAttributes(), and vtkMRMLViewNode().

int vtkMRMLViewNode::SpinDirection [protected]

Referenced by PrintSelf(), ReadXMLAttributes(), and vtkMRMLViewNode().

int vtkMRMLViewNode::StereoType [protected]

parameters for stereo viewing

Referenced by PrintSelf(), ReadXMLAttributes(), SetStereoType(), and vtkMRMLViewNode().

int vtkMRMLViewNode::ViewAxisMode [protected]

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

Referenced by PrintSelf(), ReadXMLAttributes(), and vtkMRMLViewNode().

int vtkMRMLViewNode::Visibility [protected]

Indicates whether or not the View is visible

Referenced by Copy(), PrintSelf(), ReadXMLAttributes(), SetVisibility(), vtkMRMLViewNode(), and WriteXML().

The documentation for this class was generated from the following files:
Generated on 6 Apr 2011 for Slicer3 by  doxygen 1.6.1