openscenegraph
osg::CameraView Class Reference

#include <CameraView>

Inheritance diagram for osg::CameraView:
osg::Transform osg::Group osg::Node osg::Object osg::Referenced

Public Types

enum  FieldOfViewMode { UNCONSTRAINED , HORIZONTAL , VERTICAL }
Public Types inherited from osg::Transform
enum  ReferenceFrame { RELATIVE_RF , ABSOLUTE_RF , ABSOLUTE_RF_INHERIT_VIEWPOINT }
Public Types inherited from osg::Node
typedef std::vector< Group * > ParentList
typedef unsigned int NodeMask
typedef std::vector< std::string > DescriptionList
Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC , STATIC , UNSPECIFIED }

Public Member Functions

 CameraView ()
 CameraView (const CameraView &pat, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, CameraView)
void setPosition (const Vec3d &pos)
const Vec3dgetPosition () const
void setAttitude (const Quat &quat)
const QuatgetAttitude () const
void setFieldOfView (double fieldOfView)
double getFieldOfView () const
void setFieldOfViewMode (FieldOfViewMode mode)
FieldOfViewMode getFieldOfViewMode () const
void setFocalLength (double focalLength)
double getFocalLength () const
virtual bool computeLocalToWorldMatrix (Matrix &matrix, NodeVisitor *nv) const
virtual bool computeWorldToLocalMatrix (Matrix &matrix, NodeVisitor *nv) const
Public Member Functions inherited from osg::Transform
 Transform ()
 Transform (const Transform &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, Transform)
virtual TransformasTransform ()
virtual const TransformasTransform () const
virtual MatrixTransformasMatrixTransform ()
virtual const MatrixTransformasMatrixTransform () const
virtual PositionAttitudeTransformasPositionAttitudeTransform ()
virtual const PositionAttitudeTransformasPositionAttitudeTransform () const
virtual AutoTransformasAutoTransform ()
virtual const AutoTransformasAutoTransform () const
void setReferenceFrame (ReferenceFrame rf)
ReferenceFrame getReferenceFrame () const
virtual BoundingSphere computeBound () const
Public Member Functions inherited from osg::Group
 Group ()
 Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 META_Node (osg, Group)
virtual GroupasGroup ()
virtual const GroupasGroup () const
virtual void traverse (NodeVisitor &nv)
virtual bool addChild (Node *child)
template<class T>
bool addChild (const ref_ptr< T > &child)
virtual bool insertChild (unsigned int index, Node *child)
template<class T>
bool insertChild (unsigned int index, const ref_ptr< T > &child)
virtual bool removeChild (Node *child)
template<class T>
bool removeChild (const ref_ptr< T > &child)
bool removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
virtual bool removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
virtual bool replaceChild (Node *origChild, Node *newChild)
template<class T, class R>
bool replaceChild (const ref_ptr< T > &origChild, const ref_ptr< R > &newChild)
virtual unsigned int getNumChildren () const
virtual bool setChild (unsigned int i, Node *node)
NodegetChild (unsigned int i)
const NodegetChild (unsigned int i) const
bool containsNode (const Node *node) const
template<class T>
bool containsNode (const ref_ptr< T > &node) const
unsigned int getChildIndex (const Node *node) const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void resizeGLObjectBuffers (unsigned int maxSize)
virtual void releaseGLObjects (osg::State *=0) const
Public Member Functions inherited from osg::Node
 Node ()
 Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const
virtual Objectclone (const CopyOp &copyop) const
virtual bool isSameKindAs (const Object *obj) const
virtual const char * libraryName () const
virtual const char * className () const
virtual NodeasNode ()
virtual const NodeasNode () const
virtual DrawableasDrawable ()
virtual const DrawableasDrawable () const
virtual GeometryasGeometry ()
virtual const GeometryasGeometry () const
virtual SwitchasSwitch ()
virtual const SwitchasSwitch () const
virtual GeodeasGeode ()
virtual const GeodeasGeode () const
virtual osgTerrain::TerrainasTerrain ()
virtual const osgTerrain::TerrainasTerrain () const
virtual void accept (NodeVisitor &nv)
virtual void ascend (NodeVisitor &nv)
const ParentListgetParents () const
ParentList getParents ()
GroupgetParent (unsigned int i)
const GroupgetParent (unsigned int i) const
unsigned int getNumParents () const
NodePathList getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
MatrixList getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void setUpdateCallback (Callback *nc)
template<class T>
void setUpdateCallback (const ref_ptr< T > &nc)
CallbackgetUpdateCallback ()
const CallbackgetUpdateCallback () const
void addUpdateCallback (Callback *nc)
template<class T>
void addUpdateCallback (const ref_ptr< T > &nc)
void removeUpdateCallback (Callback *nc)
template<class T>
void removeUpdateCallback (const ref_ptr< T > &nc)
unsigned int getNumChildrenRequiringUpdateTraversal () const
void setEventCallback (Callback *nc)
template<class T>
void setEventCallback (const ref_ptr< T > &nc)
CallbackgetEventCallback ()
const CallbackgetEventCallback () const
void addEventCallback (Callback *nc)
template<class T>
void addEventCallback (const ref_ptr< T > &nc)
void removeEventCallback (Callback *nc)
template<class T>
void removeEventCallback (const ref_ptr< T > &nc)
unsigned int getNumChildrenRequiringEventTraversal () const
void setCullCallback (Callback *nc)
template<class T>
void setCullCallback (const ref_ptr< T > &nc)
CallbackgetCullCallback ()
const CallbackgetCullCallback () const
void addCullCallback (Callback *nc)
template<class T>
void addCullCallback (const ref_ptr< T > &nc)
void removeCullCallback (Callback *nc)
template<class T>
void removeCullCallback (const ref_ptr< T > &nc)
void setCullingActive (bool active)
bool getCullingActive () const
unsigned int getNumChildrenWithCullingDisabled () const
bool isCullingActive () const
unsigned int getNumChildrenWithOccluderNodes () const
bool containsOccluderNodes () const
void setNodeMask (NodeMask nm)
NodeMask getNodeMask () const
void setStateSet (osg::StateSet *stateset)
template<class T>
void setStateSet (const osg::ref_ptr< T > &stateset)
osg::StateSetgetOrCreateStateSet ()
osg::StateSetgetStateSet ()
const osg::StateSetgetStateSet () const
void setDescriptions (const DescriptionList &descriptions)
DescriptionListgetDescriptions ()
const DescriptionListgetDescriptions () const
const std::string & getDescription (unsigned int i) const
std::string & getDescription (unsigned int i)
unsigned int getNumDescriptions () const
void addDescription (const std::string &desc)
void setInitialBound (const osg::BoundingSphere &bsphere)
const BoundingSpheregetInitialBound () const
void dirtyBound ()
const BoundingSpheregetBound () const
void setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
template<class T>
void setComputeBoundingSphereCallback (const ref_ptr< T > &callback)
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
const ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback () const
Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
std::string getCompoundClassName () const
virtual NodeVisitorasNodeVisitor ()
virtual const NodeVisitorasNodeVisitor () const
virtual StateSetasStateSet ()
virtual const StateSetasStateSet () const
virtual StateAttributeasStateAttribute ()
virtual const StateAttributeasStateAttribute () const
virtual UniformasUniform ()
virtual const UniformasUniform () const
virtual CameraasCamera ()
virtual const CameraasCamera () const
virtual CallbackasCallback ()
virtual const CallbackasCallback () const
virtual CallbackObjectasCallbackObject ()
virtual const CallbackObjectasCallbackObject () const
virtual UserDataContainerasUserDataContainer ()
virtual const UserDataContainerasUserDataContainer () const
virtual ValueObjectasValueObject ()
virtual const ValueObjectasValueObject () const
virtual ImageasImage ()
virtual const ImageasImage () const
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
virtual void computeDataVariance ()
void setUserDataContainer (osg::UserDataContainer *udc)
template<class T>
void setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
template<class T>
void setUserData (const ref_ptr< T > &ud)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () const
template<typename T>
bool getUserValue (const std::string &name, T &value) const
template<typename T>
void setUserValue (const std::string &name, const T &value)
template<typename T>
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

Protected Member Functions

virtual ~CameraView ()
Protected Member Functions inherited from osg::Transform
virtual ~Transform ()
Protected Member Functions inherited from osg::Group
virtual ~Group ()
virtual void childRemoved (unsigned int, unsigned int)
virtual void childInserted (unsigned int)
Protected Member Functions inherited from osg::Node
virtual ~Node ()
void addParent (osg::Group *parent)
void removeParent (osg::Group *parent)
void setNumChildrenRequiringUpdateTraversal (unsigned int num)
void setNumChildrenRequiringEventTraversal (unsigned int num)
void setNumChildrenWithCullingDisabled (unsigned int num)
void setNumChildrenWithOccluderNodes (unsigned int num)
Protected Member Functions inherited from osg::Object
virtual ~Object ()
Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
void deleteUsingDeleteHandler () const

Protected Attributes

Vec3d _position
Quat _attitude
double _fieldOfView
FieldOfViewMode _fieldOfViewMode
double _focalLength
Protected Attributes inherited from osg::Transform
ReferenceFrame _referenceFrame
Protected Attributes inherited from osg::Group
NodeList _children
Protected Attributes inherited from osg::Node
BoundingSphere _initialBound
ref_ptr< ComputeBoundingSphereCallback_computeBoundCallback
BoundingSphere _boundingSphere
bool _boundingSphereComputed
ParentList _parents
ref_ptr< Callback_updateCallback
unsigned int _numChildrenRequiringUpdateTraversal
ref_ptr< Callback_eventCallback
unsigned int _numChildrenRequiringEventTraversal
ref_ptr< Callback_cullCallback
bool _cullingActive
unsigned int _numChildrenWithCullingDisabled
unsigned int _numChildrenWithOccluderNodes
NodeMask _nodeMask
ref_ptr< StateSet_stateset
Protected Attributes inherited from osg::Object
std::string _name
DataVariance _dataVariance
osg::UserDataContainer_userDataContainer
Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount

Additional Inherited Members

Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()

Detailed Description

CameraView - is a Transform that is used to specify camera views from within the scene graph. The application must attach a camera to a CameraView via the NodePath from the top of the scene graph to the CameraView node itself, and accumulate the view matrix from this NodePath.

Member Enumeration Documentation

◆ FieldOfViewMode

Enumerator
UNCONSTRAINED 
HORIZONTAL 
VERTICAL 

Constructor & Destructor Documentation

◆ CameraView() [1/2]

osg::CameraView::CameraView ( )

Referenced by CameraView(), and META_Node().

◆ CameraView() [2/2]

osg::CameraView::CameraView ( const CameraView & pat,
const CopyOp & copyop = CopyOp::SHALLOW_COPY )
inline

◆ ~CameraView()

virtual osg::CameraView::~CameraView ( )
inlineprotectedvirtual

Member Function Documentation

◆ computeLocalToWorldMatrix()

virtual bool osg::CameraView::computeLocalToWorldMatrix ( Matrix & matrix,
NodeVisitor * nv ) const
virtual

Reimplemented from osg::Transform.

◆ computeWorldToLocalMatrix()

virtual bool osg::CameraView::computeWorldToLocalMatrix ( Matrix & matrix,
NodeVisitor * nv ) const
virtual

Reimplemented from osg::Transform.

◆ getAttitude()

const Quat & osg::CameraView::getAttitude ( ) const
inline

Get the attitude of the camera view.

References _attitude.

◆ getFieldOfView()

double osg::CameraView::getFieldOfView ( ) const
inline

Get the field of view.

References _fieldOfView.

◆ getFieldOfViewMode()

FieldOfViewMode osg::CameraView::getFieldOfViewMode ( ) const
inline

Get the field of view mode.

References _fieldOfViewMode.

◆ getFocalLength()

double osg::CameraView::getFocalLength ( ) const
inline

Get the focal length of the camera.

References _focalLength.

◆ getPosition()

const Vec3d & osg::CameraView::getPosition ( ) const
inline

Get the position of the camera view.

References _position.

◆ META_Node()

osg::CameraView::META_Node ( osg ,
CameraView  )

References CameraView().

◆ setAttitude()

void osg::CameraView::setAttitude ( const Quat & quat)
inline

Set the attitude of the camera view.

References _attitude, and osg::Node::dirtyBound().

◆ setFieldOfView()

void osg::CameraView::setFieldOfView ( double fieldOfView)
inline

Set the field of view. The camera's field of view can be constrained to either the horizontal or vertical axis of the camera, or unconstrained in which case the camera/application are left to choose an appropriate field of view. The default value if 60 degrees.

References _fieldOfView.

◆ setFieldOfViewMode()

void osg::CameraView::setFieldOfViewMode ( FieldOfViewMode mode)
inline

Set the field of view mode - controlling how the field of view of the camera is constrained by the CameraView settings.

References _fieldOfViewMode.

◆ setFocalLength()

void osg::CameraView::setFocalLength ( double focalLength)
inline

Set the focal length of the camera. A focal length of 0.0 indicates that the camera/application should determine the focal length. The default value is 0.0.

References _focalLength.

◆ setPosition()

void osg::CameraView::setPosition ( const Vec3d & pos)
inline

Set the position of the camera view.

References _position, and osg::Node::dirtyBound().

Member Data Documentation

◆ _attitude

Quat osg::CameraView::_attitude
protected

◆ _fieldOfView

double osg::CameraView::_fieldOfView
protected

◆ _fieldOfViewMode

FieldOfViewMode osg::CameraView::_fieldOfViewMode
protected

◆ _focalLength

double osg::CameraView::_focalLength
protected

◆ _position

Vec3d osg::CameraView::_position
protected

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