OSG  3.4.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::CameraView Class Reference

#include <CameraView.h>

Inheritance diagram for osg::CameraView:
Inheritance graph
[legend]
Collaboration diagram for osg::CameraView:
Collaboration graph
[legend]

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
PositionAttitudeTransform
asPositionAttitudeTransform () 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)
 
virtual bool insertChild (unsigned int index, Node *child)
 
virtual bool removeChild (Node *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)
 
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
 
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 CameraasCamera ()
 
virtual const CameraasCamera () 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)
 
CallbackgetUpdateCallback ()
 
const CallbackgetUpdateCallback () const
 
void addUpdateCallback (Callback *nc)
 
void removeUpdateCallback (Callback *nc)
 
unsigned int getNumChildrenRequiringUpdateTraversal () const
 
void setEventCallback (Callback *nc)
 
CallbackgetEventCallback ()
 
const CallbackgetEventCallback () const
 
void addEventCallback (Callback *nc)
 
void removeEventCallback (Callback *nc)
 
unsigned int getNumChildrenRequiringEventTraversal () const
 
void setCullCallback (Callback *nc)
 
CallbackgetCullCallback ()
 
const CallbackgetCullCallback () const
 
void addCullCallback (Callback *nc)
 
void removeCullCallback (Callback *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)
 
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)
 
ComputeBoundingSphereCallbackgetComputeBoundingSphereCallback ()
 
const
ComputeBoundingSphereCallback
getComputeBoundingSphereCallback () 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 StateAttributeasStateAttribute ()
 
virtual const StateAttributeasStateAttribute () const
 
virtual UniformasUniform ()
 
virtual const UniformasUniform () 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)
 
osg::UserDataContainergetUserDataContainer ()
 
const osg::UserDataContainergetUserDataContainer () const
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 
virtual void setUserData (Referenced *obj)
 
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 setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 
static bool getThreadSafeReferenceCounting ()
 
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.

Definition at line 29 of file CameraView.h.

Member Enumeration Documentation

Enumerator
UNCONSTRAINED 
HORIZONTAL 
VERTICAL 

Definition at line 66 of file CameraView.h.

Constructor & Destructor Documentation

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

Definition at line 34 of file CameraView.h.

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

Definition at line 94 of file CameraView.h.

Member Function Documentation

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

Reimplemented from osg::Transform.

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

Reimplemented from osg::Transform.

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

Get the attitude of the camera view.

Definition at line 55 of file CameraView.h.

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

Get the field of view.

Definition at line 64 of file CameraView.h.

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

Get the field of view mode.

Definition at line 77 of file CameraView.h.

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

Get the focal length of the camera.

Definition at line 85 of file CameraView.h.

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

Get the position of the camera view.

Definition at line 49 of file CameraView.h.

osg::CameraView::META_Node ( osg  ,
CameraView   
)
void osg::CameraView::setAttitude ( const Quat quat)
inline

Set the attitude of the camera view.

Definition at line 52 of file CameraView.h.

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.

Definition at line 61 of file CameraView.h.

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.

Definition at line 74 of file CameraView.h.

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.

Definition at line 82 of file CameraView.h.

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

Set the position of the camera view.

Definition at line 46 of file CameraView.h.

Member Data Documentation

Quat osg::CameraView::_attitude
protected

Definition at line 97 of file CameraView.h.

double osg::CameraView::_fieldOfView
protected

Definition at line 98 of file CameraView.h.

FieldOfViewMode osg::CameraView::_fieldOfViewMode
protected

Definition at line 99 of file CameraView.h.

double osg::CameraView::_focalLength
protected

Definition at line 100 of file CameraView.h.

Vec3d osg::CameraView::_position
protected

Definition at line 96 of file CameraView.h.


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