Slicer  5.0
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkMRMLCameraNode Class Reference

MRML node to represent camera node. More...

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

Inheritance diagram for vtkMRMLCameraNode:
Inheritance graph
[legend]
Collaboration diagram for vtkMRMLCameraNode:
Collaboration graph
[legend]

Public Types

enum  { LayoutNameModifiedEvent = 30000, ActiveTagModifiedEvent = LayoutNameModifiedEvent, CameraInteractionEvent = 31000, ResetCameraClippingEvent = 32000 }
 
Events More...
 
enum  Direction {
  Right = 0, Left = 1, Anterior = 2, Posterior = 3,
  Superior = 4, Inferior = 5
}
 
enum  InteractionFlagType {
  None = 0, LookFromAxis, ZoomInFlag, ZoomOutFlag,
  CenterFlag, CameraInteractionFlag
}
 
enum  RASAxis { R = 0, A = 1, S = 2 }
 
enum  ScreenAxis { X = 0, Y = 1, Z = 2 }
 
typedef vtkMRMLTransformableNode Superclass
 
- Public Types inherited from vtkMRMLTransformableNode
enum  { TransformModifiedEvent = 15000 }
 TransformModifiedEvent is send when the parent transform is modidied. More...
 
typedef vtkMRMLStorableNode Superclass
 
- Public Types inherited from vtkMRMLStorableNode
typedef vtkMRMLNode Superclass
 
- Public Types inherited from vtkMRMLNode
enum  {
  HierarchyModifiedEvent = 16000, IDChangedEvent = 16001, ReferenceAddedEvent, ReferenceModifiedEvent,
  ReferenceRemovedEvent, ReferencedNodeModifiedEvent
}
 
typedef vtkObject Superclass
 

Public Member Functions

void Copy (vtkMRMLNode *node) override
 
Copy the node's attributes to this object More...
 
vtkMRMLNodeCreateNodeInstance () override
 MRMLNode methods. More...
 
const char * GetActiveTag ()
 
virtual vtkMatrix4x4 * GetAppliedTransform ()
 
virtual vtkCamera * GetCamera ()
 
vtkCamera More...
 
virtual const char * GetClassName ()
 
double * GetFocalPoint ()
 
void GetFocalPoint (double focalPoint[3])
 
virtual int GetInteracting ()
 
virtual unsigned int GetInteractionFlags ()
 
char * GetLayoutName ()
 
const char * GetNodeTagName () override
 
Get node XML tag name (like Volume, Model) More...
 
int GetParallelProjection ()
 
Set camera ParallelProjection flag More...
 
double GetParallelScale ()
 
Set camera Parallel Scale More...
 
double * GetPosition ()
 
void GetPosition (double position[3])
 
double GetViewAngle ()
 
double * GetViewUp ()
 
void GetViewUp (double viewUp[3])
 
virtual void InteractingOff ()
 
virtual void InteractingOn ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *, unsigned long, void *) override
 
alternative method to propagate events generated in Camera nodes More...
 
void ReadXMLAttributes (const char **atts) override
 
Read node attributes from XML file More...
 
virtual void Reset (vtkMRMLNode *defaultNode)
 
void Reset (bool resetRotation, bool resetTranslation=true, bool resetDistance=true, vtkRenderer *renderer=nullptr)
 
void ResetClippingRange ()
 Reset the clipping range just based on its position and focal point. More...
 
void RotateAround (RASAxis axis, bool clockWise)
 
void RotateAround (RASAxis axis, double angle=15.)
 15 degrees by default More...
 
void RotateTo (Direction position)
 
virtual void SetActiveTag (const char *)
 
virtual void SetAppliedTransform (vtkMatrix4x4 *appliedTransform)
 
void SetFocalPoint (double focalPoint[3])
 
void SetFocalPoint (double x, double y, double z)
 
void SetInteracting (int)
 
void SetInteractionFlags (unsigned int)
 
void SetLayoutName (const char *layoutName)
 
void SetParallelProjection (int parallelProjection)
 
Set camera ParallelProjection flag More...
 
void SetParallelScale (double scale)
 
Set camera Parallel Scale More...
 
void SetPosition (double position[3])
 
void SetPosition (double x, double y, double z)
 
void SetViewAngle (double viewAngle)
 
void SetViewUp (double viewUp[3])
 
void SetViewUp (double vx, double vy, double vz)
 
void TranslateAlong (ScreenAxis axis, bool positive)
 
 vtkMRMLCopyContentMacro (vtkMRMLCameraNode)
 
void WriteXML (ostream &of, int indent) override
 
Write this node's information to a MRML file in XML format. More...
 
- Public Member Functions inherited from vtkMRMLTransformableNode
virtual void ApplyTransform (vtkAbstractTransform *transform)
 
virtual void ApplyTransformMatrix (vtkMatrix4x4 *transformMatrix)
 
virtual bool CanApplyNonLinearTransforms () const
 
vtkMRMLTransformNodeGetParentTransformNode ()
 
Associated transform MRML node More...
 
const char * GetTransformNodeID ()
 Get referenced transform node id. More...
 
bool HardenTransform ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void ProcessMRMLEvents (vtkObject *, unsigned long, void *) override
 
alternative method to propagate events generated in Transform nodes More...
 
void ReadXMLAttributes (const char **atts) override
 
Read node attributes from XML file More...
 
bool SetAndObserveTransformNodeID (const char *transformNodeID)
 
virtual void TransformPointFromWorld (const double inWorld[3], double outLocal[3])
 
virtual void TransformPointFromWorld (const vtkVector3d &inWorld, vtkVector3d &outLocal)
 
virtual void TransformPointToWorld (const double inLocal[3], double outWorld[3])
 
virtual void TransformPointToWorld (const vtkVector3d &inLocal, vtkVector3d &outWorld)
 
void WriteXML (ostream &of, int indent) override
 
Write this node's information to a MRML file in XML format. More...
 
- Public Member Functions inherited from vtkMRMLStorableNode
void AddAndObserveStorageNodeID (const char *storageNodeID)
 
virtual bool AddDefaultStorageNode (const char *filename=nullptr)
 
void Copy (vtkMRMLNode *node) override
 Copy node contents from another node of the same type. Reimplemented to copy default sequence storage node class. More...
 
virtual vtkMRMLStorageNodeCreateDefaultSequenceStorageNode ()
 
virtual vtkMRMLStorageNodeCreateDefaultStorageNode ()
 
virtual std::string GetDefaultSequenceStorageNodeClassName ()
 
virtual std::string GetDefaultStorageNodeClassName (const char *filename=nullptr)
 
virtual bool GetModifiedSinceRead ()
 
vtkMRMLStorageNodeGetNthStorageNode (int n)
 
Get associated display MRML node More...
 
const char * GetNthStorageNodeID (int n)
 
int GetNumberOfStorageNodes ()
 
const char * GetSlicerDataType ()
 
vtkMRMLStorageNodeGetStorageNode ()
 
const char * GetStorageNodeID ()
 
virtual vtkTagTableGetUserTagTable ()
 Methods for user-specified metadata. More...
 
bool HasStorageNodeID (const char *storageNodeID)
 
Return true if storageNodeID is in the storage node ID list. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetAndObserveNthStorageNodeID (int n, const char *storageNodeID)
 
void SetAndObserveStorageNodeID (const char *storageNodeID)
 
String ID of the storage MRML node More...
 
virtual void SetDefaultSequenceStorageNodeClassName (std::string)
 
void SetSlicerDataType (const char *type)
 
virtual void StorableModified ()
 
void UpdateScene (vtkMRMLScene *scene) override
 
Finds the storage node and read the data More...
 
 vtkMRMLCopyContentMacro (vtkMRMLStorableNode)
 
- Public Member Functions inherited from vtkMRMLNode
vtkMRMLNodeAddAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Add and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeAddNodeReferenceID (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 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 ()
 
int GetCustomModifiedEventPending (int eventId)
 
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 ()
 
vtkMRMLNodeGetNodeReference (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...
 
vtkMRMLNodeGetNthNodeReference (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 vtkMRMLSceneGetScene ()
 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 const char * GetTypeDisplayName ()
 
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...
 
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 Reset (vtkMRMLNode *defaultNode)
 Reset node attributes to the initial state as defined in the constructor or the passed default node. 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)
 
vtkMRMLNodeSetAndObserveNodeReferenceID (const char *referenceRole, const char *referencedNodeID, vtkIntArray *events=nullptr)
 Set and observe a reference node from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetAndObserveNthNodeReferenceID (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...
 
vtkMRMLNodeSetNodeReferenceID (const char *referenceRole, const char *referencedNodeID)
 Set a reference to a node with specified nodeID from this node for a specific referenceRole. More...
 
vtkMRMLNodeSetNthNodeReferenceID (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...
 
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 int IsTypeOf (const char *type)
 
static vtkMRMLCameraNodeNew ()
 
static vtkMRMLCameraNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLTransformableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLTransformableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLStorableNode
static int IsTypeOf (const char *type)
 
static vtkMRMLStorableNodeSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkMRMLNode
static int IsTypeOf (const char *type)
 
static vtkMRMLNodeSafeDownCast (vtkObject *o)
 

Protected Member Functions

void operator= (const vtkMRMLCameraNode &)
 
void SetAndObserveCamera (vtkCamera *camera)
 
void SetCamera (vtkCamera *camera)
 
 vtkMRMLCameraNode ()
 
 vtkMRMLCameraNode (const vtkMRMLCameraNode &)
 
 ~vtkMRMLCameraNode () override
 
- Protected Member Functions inherited from vtkMRMLTransformableNode
virtual const char * GetTransformNodeReferenceMRMLAttributeName ()
 
virtual const char * GetTransformNodeReferenceRole ()
 
void OnNodeReferenceAdded (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is added (list size increased). More...
 
void OnNodeReferenceModified (vtkMRMLNodeReference *reference) override
 
Called when a node reference ID is modified. More...
 
void OnNodeReferenceRemoved (vtkMRMLNodeReference *reference) override
 
Called after a node reference ID is removed (list size decreased). More...
 
virtual void OnTransformNodeReferenceChanged (vtkMRMLTransformNode *transformNode)
 Called when transform node reference added/modified/removed. More...
 
void operator= (const vtkMRMLTransformableNode &)
 
 vtkMRMLTransformableNode ()
 
 vtkMRMLTransformableNode (const vtkMRMLTransformableNode &)
 
 ~vtkMRMLTransformableNode () override
 
- Protected Member Functions inherited from vtkMRMLStorableNode
virtual const char * GetStorageNodeReferenceMRMLAttributeName ()
 
virtual const char * GetStorageNodeReferenceRole ()
 
virtual vtkTimeStamp GetStoredTime ()
 
void operator= (const vtkMRMLStorableNode &)
 
 vtkMRMLStorableNode ()
 
 vtkMRMLStorableNode (const vtkMRMLStorableNode &)
 
 ~vtkMRMLStorableNode () 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...
 
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. More...
 
vtkMRMLNodeUpdateNodeReferenceEventObserver (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

vtkMatrix4x4 * AppliedTransform
 
vtkCamera * Camera {nullptr}
 
int Interacting
 
unsigned int InteractionFlags
 
std::string InternalActiveTag
 
- Protected Attributes inherited from vtkMRMLStorableNode
std::string DefaultSequenceStorageNodeClassName
 
std::string SlicerDataType
 
vtkTimeStamp StorableModifiedTime
 
vtkTagTableUserTagTable
 
- 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...
 
vtkObserverManagerMRMLObserverManager
 
char * Name {nullptr}
 
NodeReferenceEventsType NodeReferenceEvents
 
std::map< std::string, std::string > NodeReferenceMRMLAttributeNames
 
NodeReferencesType NodeReferences
 
int SaveWithScene {true}
 
vtkWeakPointer< vtkMRMLSceneScene
 
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, vtkSmartPointer< vtkIntArray > > NodeReferenceEventsType
 
typedef std::vector< vtkSmartPointer< vtkMRMLNodeReference > > NodeReferenceListType
 
typedef std::map< std::string, NodeReferenceListTypeNodeReferencesType
 
- Static Protected Member Functions inherited from vtkMRMLNode
static void MRMLCallback (vtkObject *caller, unsigned long eid, void *clientData, void *callData)
 
- Static Protected Attributes inherited from vtkMRMLTransformableNode
static const char * TransformNodeReferenceMRMLAttributeName
 
static const char * TransformNodeReferenceRole
 
- Static Protected Attributes inherited from vtkMRMLStorableNode
static const char * StorageNodeReferenceMRMLAttributeName
 
static const char * StorageNodeReferenceRole
 

Detailed Description

MRML node to represent camera node.

Camera node uses vtkCamera to store the state of the camera

Definition at line 29 of file vtkMRMLCameraNode.h.

Member Typedef Documentation

◆ Superclass

Definition at line 33 of file vtkMRMLCameraNode.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum


Events

Enumerator
LayoutNameModifiedEvent 
ActiveTagModifiedEvent 
CameraInteractionEvent 
ResetCameraClippingEvent 

Definition at line 167 of file vtkMRMLCameraNode.h.

◆ Direction

Enumerator
Right 
Left 
Anterior 
Posterior 
Superior 
Inferior 

Definition at line 178 of file vtkMRMLCameraNode.h.

◆ 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:

Enumerator
None 
LookFromAxis 
ZoomInFlag 
ZoomOutFlag 
CenterFlag 
CameraInteractionFlag 

Definition at line 240 of file vtkMRMLCameraNode.h.

◆ RASAxis

Enumerator

Definition at line 187 of file vtkMRMLCameraNode.h.

◆ ScreenAxis

Enumerator

Definition at line 193 of file vtkMRMLCameraNode.h.

Constructor & Destructor Documentation

◆ vtkMRMLCameraNode() [1/2]

vtkMRMLCameraNode::vtkMRMLCameraNode ( )
protected

◆ ~vtkMRMLCameraNode()

vtkMRMLCameraNode::~vtkMRMLCameraNode ( )
overrideprotected

◆ vtkMRMLCameraNode() [2/2]

vtkMRMLCameraNode::vtkMRMLCameraNode ( const vtkMRMLCameraNode )
protected

Member Function Documentation

◆ Copy()

void vtkMRMLCameraNode::Copy ( vtkMRMLNode node)
overridevirtual


Copy the node's attributes to this object

Reimplemented from vtkMRMLNode.

◆ CreateNodeInstance()

vtkMRMLNode* vtkMRMLCameraNode::CreateNodeInstance ( )
overridevirtual

MRMLNode methods.

Implements vtkMRMLTransformableNode.

◆ GetActiveTag()

const char* vtkMRMLCameraNode::GetActiveTag ( )

Deprecated. Use SetLayoutName instead. Set the camera active tag, i.e. the tag for which object (view) this camera is active.

◆ GetAppliedTransform()

virtual vtkMatrix4x4* vtkMRMLCameraNode::GetAppliedTransform ( )
virtual

This is the transform that was last applied to the position, focal point, and up vector (for any new transforms, the incremental difference is calculated and applied to the parameters)

◆ GetCamera()

virtual vtkCamera* vtkMRMLCameraNode::GetCamera ( )
virtual


vtkCamera

◆ GetClassName()

virtual const char* vtkMRMLCameraNode::GetClassName ( )
virtual

Reimplemented from vtkMRMLTransformableNode.

◆ GetFocalPoint() [1/2]

double* vtkMRMLCameraNode::GetFocalPoint ( )

Get the focal point of the camera in world coordinates.

See also
SetFocalPoint(), GetPosition(), GetViewUp()

◆ GetFocalPoint() [2/2]

void vtkMRMLCameraNode::GetFocalPoint ( double  focalPoint[3])

◆ GetInteracting()

virtual int vtkMRMLCameraNode::GetInteracting ( )
virtual

◆ GetInteractionFlags()

virtual unsigned int vtkMRMLCameraNode::GetInteractionFlags ( )
virtual

◆ GetLayoutName()

char* vtkMRMLCameraNode::GetLayoutName ( )

◆ GetNodeTagName()

const char* vtkMRMLCameraNode::GetNodeTagName ( )
inlineoverridevirtual


Get node XML tag name (like Volume, Model)

Implements vtkMRMLTransformableNode.

Definition at line 61 of file vtkMRMLCameraNode.h.

◆ GetParallelProjection()

int vtkMRMLCameraNode::GetParallelProjection ( )


Set camera ParallelProjection flag

◆ GetParallelScale()

double vtkMRMLCameraNode::GetParallelScale ( )


Set camera Parallel Scale

◆ GetPosition() [1/2]

double* vtkMRMLCameraNode::GetPosition ( )

Get the position of the camera in world coordinates.

See also
SetPosition(), GetFocalPoint(), GetViewUp()

◆ GetPosition() [2/2]

void vtkMRMLCameraNode::GetPosition ( double  position[3])

◆ GetViewAngle()

double vtkMRMLCameraNode::GetViewAngle ( )

Get the camera view angle

See also
SetViewAngle(), vtkCamera::GetViewAngle(), GetParallelScale(), GetParallelProjection()

◆ GetViewUp() [1/2]

double* vtkMRMLCameraNode::GetViewUp ( )

Get camera Up vector

See also
SetViewUp(), GetPosition(), GetFocalPoint()

◆ GetViewUp() [2/2]

void vtkMRMLCameraNode::GetViewUp ( double  viewUp[3])

◆ InteractingOff()

virtual void vtkMRMLCameraNode::InteractingOff ( )
virtual

◆ InteractingOn()

virtual void vtkMRMLCameraNode::InteractingOn ( )
virtual

◆ IsA()

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

Reimplemented from vtkMRMLTransformableNode.

◆ IsTypeOf()

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

◆ New()

static vtkMRMLCameraNode* vtkMRMLCameraNode::New ( )
static

◆ operator=()

void vtkMRMLCameraNode::operator= ( const vtkMRMLCameraNode )
protected

◆ PrintSelf()

void vtkMRMLCameraNode::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ ProcessMRMLEvents()

void vtkMRMLCameraNode::ProcessMRMLEvents ( vtkObject *  ,
unsigned  long,
void *   
)
overridevirtual


alternative method to propagate events generated in Camera nodes

Reimplemented from vtkMRMLNode.

◆ ReadXMLAttributes()

void vtkMRMLCameraNode::ReadXMLAttributes ( const char **  atts)
overridevirtual


Read node attributes from XML file

Reimplemented from vtkMRMLNode.

◆ Reset() [1/2]

virtual void vtkMRMLNode::Reset

Reset the camera If resetRotation is true, the camera rotates to the closest direction If resetTranslation is true, the focal point is moved to the center of the renderer props not changing the rotation. If resetDistance is true, the camera to moved to make sure the view contains the renderer bounds.

◆ Reset() [2/2]

void vtkMRMLCameraNode::Reset ( bool  resetRotation,
bool  resetTranslation = true,
bool  resetDistance = true,
vtkRenderer *  renderer = nullptr 
)

◆ ResetClippingRange()

void vtkMRMLCameraNode::ResetClippingRange ( )

Reset the clipping range just based on its position and focal point.

◆ RotateAround() [1/2]

void vtkMRMLCameraNode::RotateAround ( RASAxis  axis,
bool  clockWise 
)

Utility function that rotates of 15 degrees around an axis. Call RotateAround 6 times to make a right angle

◆ RotateAround() [2/2]

void vtkMRMLCameraNode::RotateAround ( RASAxis  axis,
double  angle = 15. 
)

15 degrees by default

◆ RotateTo()

void vtkMRMLCameraNode::RotateTo ( Direction  position)

Moves the camera toward a position. Keeps the same distance to the focal point.

◆ SafeDownCast()

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

◆ SetActiveTag()

virtual void vtkMRMLCameraNode::SetActiveTag ( const char *  )
virtual

◆ SetAndObserveCamera()

void vtkMRMLCameraNode::SetAndObserveCamera ( vtkCamera *  camera)
protected

◆ SetAppliedTransform()

virtual void vtkMRMLCameraNode::SetAppliedTransform ( vtkMatrix4x4 *  appliedTransform)
virtual

◆ SetCamera()

void vtkMRMLCameraNode::SetCamera ( vtkCamera *  camera)
protected

◆ SetFocalPoint() [1/2]

void vtkMRMLCameraNode::SetFocalPoint ( double  focalPoint[3])

Set the focal point of the camera in world coordinates. It is also the point around which the camera rotates around.

See also
GetFocalPoint(), SetPosition(), SetViewUp()

◆ SetFocalPoint() [2/2]

void vtkMRMLCameraNode::SetFocalPoint ( double  x,
double  y,
double  z 
)
inline

Definition at line 285 of file vtkMRMLCameraNode.h.

◆ SetInteracting()

void vtkMRMLCameraNode::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 vtkMRMLCameraNode::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().

◆ SetLayoutName()

void vtkMRMLCameraNode::SetLayoutName ( const char *  layoutName)

Name of the layout widget that this camera is used in. Must be unique between all the slice composite nodes because it is used as a singleton tag. Must be the same as the slice node. No name (i.e. "") by default. Typical names are numbers: "1", "2", ... to uniquely define the 3D view node.

See also
vtkMRMLViewNode::SetLayoutName

◆ SetParallelProjection()

void vtkMRMLCameraNode::SetParallelProjection ( int  parallelProjection)


Set camera ParallelProjection flag

◆ SetParallelScale()

void vtkMRMLCameraNode::SetParallelScale ( double  scale)


Set camera Parallel Scale

◆ SetPosition() [1/2]

void vtkMRMLCameraNode::SetPosition ( double  position[3])

Set the position of the camera in world coordinates. It is recommended to call ResetClippingRange() after calling this to ensure that all objects that should be visible are rendered.

See also
GetPosition(), SetFocalPoint(), SetViewUp(), ResetClippingRange()

◆ SetPosition() [2/2]

void vtkMRMLCameraNode::SetPosition ( double  x,
double  y,
double  z 
)
inline

Definition at line 278 of file vtkMRMLCameraNode.h.

◆ SetViewAngle()

void vtkMRMLCameraNode::SetViewAngle ( double  viewAngle)

Set the camera view angle

See also
GetViewAngle(), vtkCamera::SetViewAngle(), SetParallelScale(), SetParallelProjection()

◆ SetViewUp() [1/2]

void vtkMRMLCameraNode::SetViewUp ( double  viewUp[3])

Set camera Up vector

See also
GetViewUp(), SetPosition(), SetFocalPoint()

◆ SetViewUp() [2/2]

void vtkMRMLCameraNode::SetViewUp ( double  vx,
double  vy,
double  vz 
)
inline

Definition at line 292 of file vtkMRMLCameraNode.h.

◆ TranslateAlong()

void vtkMRMLCameraNode::TranslateAlong ( ScreenAxis  axis,
bool  positive 
)

Translate the camera and focal point of a 6th of the screen width. Call TranslateAround 6 times to not see what was on screen before.

◆ vtkMRMLCopyContentMacro()

vtkMRMLCameraNode::vtkMRMLCopyContentMacro ( vtkMRMLCameraNode  )

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

See also
vtkMRMLNode::CopyContent

◆ WriteXML()

void vtkMRMLCameraNode::WriteXML ( ostream &  of,
int  indent 
)
overridevirtual


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

Reimplemented from vtkMRMLNode.

Member Data Documentation

◆ AppliedTransform

vtkMatrix4x4* vtkMRMLCameraNode::AppliedTransform
protected

Definition at line 271 of file vtkMRMLCameraNode.h.

◆ Camera

vtkCamera* vtkMRMLCameraNode::Camera {nullptr}
protected

Definition at line 267 of file vtkMRMLCameraNode.h.

◆ Interacting

int vtkMRMLCameraNode::Interacting
protected

Definition at line 273 of file vtkMRMLCameraNode.h.

◆ InteractionFlags

unsigned int vtkMRMLCameraNode::InteractionFlags
protected

Definition at line 274 of file vtkMRMLCameraNode.h.

◆ InternalActiveTag

std::string vtkMRMLCameraNode::InternalActiveTag
protected

Definition at line 269 of file vtkMRMLCameraNode.h.


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