Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

osg::CameraBase Class Reference

Camera Base Class. More...

#include <OSGCameraBase.h>

Inheritance diagram for osg::CameraBase:

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

Collaboration graph
[legend]
List of all members.

Public Types

enum  { BeaconFieldId = Inherited::NextFieldId, NearFieldId = BeaconFieldId + 1, FarFieldId = NearFieldId + 1, NextFieldId = FarFieldId + 1 }

Public Methods

Get
virtual FieldContainerTypegetType (void)
virtual const FieldContainerTypegetType (void) const
virtual UInt32 getContainerSize (void) const
Field Get
virtual SFNodePtrgetSFBeacon (void)
virtual SFReal32getSFNear (void)
virtual SFReal32getSFFar (void)
virtual NodePtrgetBeacon (void)
virtual const NodePtrgetBeacon (void) const
virtual Real32getNear (void)
virtual const Real32getNear (void) const
virtual Real32getFar (void)
virtual const Real32getFar (void) const
Field Set
virtual void setBeacon (const NodePtr &value)
virtual void setNear (const Real32 &value)
virtual void setFar (const Real32 &value)
Sync
virtual void executeSync (FieldContainer &other, const BitVector &whichField)
Binary Access
virtual UInt32 getBinSize (const BitVector &whichField)
virtual void copyToBin (BinaryDataHandler &pMem, const BitVector &whichField)
virtual void copyFromBin (BinaryDataHandler &pMem, const BitVector &whichField)

Static Public Methods

Class Get
FieldContainerTypegetClassType (void)
 access the type of the class

UInt32 getClassTypeId (void)
 access the numerical type of the class


Static Public Attributes

const osg::BitVector BeaconFieldMask
const osg::BitVector NearFieldMask
const osg::BitVector FarFieldMask

Protected Methods

Constructors
 CameraBase (void)
 Constructor.

 CameraBase (const CameraBase &source)
 Copy Constructor.

Destructors
virtual ~CameraBase (void)
 Destructor.

Sync
void executeSyncImpl (CameraBase *pOther, const BitVector &whichField)

Protected Attributes

Fields
SFNodePtr _sfBeacon
SFReal32 _sfNear
SFReal32 _sfFar

Private Types

typedef AttachmentContainer Inherited

Private Methods

void operator= (const CameraBase &source)

Static Private Attributes

FieldDescription_desc []
 Camera description.

FieldContainerType _type
 Camera type.


Friends

class FieldContainer

Detailed Description

Camera Base Class.


Member Typedef Documentation

typedef AttachmentContainer osg::CameraBase::Inherited [private]
 

Reimplemented from osg::AttachmentContainer.

Reimplemented in osg::Camera, osg::CameraDecorator, osg::CameraDecoratorBase, osg::MatrixCamera, osg::MatrixCameraBase, osg::PerspectiveCamera, osg::PerspectiveCameraBase, osg::ProjectionCameraDecorator, osg::ProjectionCameraDecoratorBase, osg::ShearedStereoCameraDecorator, osg::ShearedStereoCameraDecoratorBase, osg::StereoCameraDecorator, osg::StereoCameraDecoratorBase, osg::TileCameraDecorator, and osg::TileCameraDecoratorBase.


Member Enumeration Documentation

anonymous enum
 

Enumeration values:
BeaconFieldId 
NearFieldId 
FarFieldId 
NextFieldId 


Constructor & Destructor Documentation

CameraBase::CameraBase void    [protected]
 

Constructor.

CameraBase::CameraBase const CameraBase &    source [protected]
 

Copy Constructor.

CameraBase::~CameraBase void    [protected, virtual]
 

Destructor.


Member Function Documentation

osg::FieldContainerType & osg::CameraBase::getClassType void    [inline, static]
 

access the type of the class

Reimplemented from osg::FieldContainer.

Reimplemented in osg::CameraDecoratorBase, osg::MatrixCameraBase, osg::PerspectiveCameraBase, osg::ProjectionCameraDecoratorBase, osg::ShearedStereoCameraDecoratorBase, osg::StereoCameraDecoratorBase, and osg::TileCameraDecoratorBase.

osg::UInt32 osg::CameraBase::getClassTypeId void    [inline, static]
 

access the numerical type of the class

Reimplemented from osg::FieldContainer.

Reimplemented in osg::CameraDecoratorBase, osg::MatrixCameraBase, osg::PerspectiveCameraBase, osg::ProjectionCameraDecoratorBase, osg::ShearedStereoCameraDecoratorBase, osg::StereoCameraDecoratorBase, and osg::TileCameraDecoratorBase.

FieldContainerType & CameraBase::getType void    [virtual]
 

Reimplemented from osg::FieldContainer.

Reimplemented in osg::CameraDecoratorBase, osg::MatrixCameraBase, osg::PerspectiveCameraBase, osg::ProjectionCameraDecoratorBase, osg::ShearedStereoCameraDecoratorBase, osg::StereoCameraDecoratorBase, and osg::TileCameraDecoratorBase.

const FieldContainerType & CameraBase::getType void    const [virtual]
 

Reimplemented from osg::FieldContainer.

Reimplemented in osg::CameraDecoratorBase, osg::MatrixCameraBase, osg::PerspectiveCameraBase, osg::ProjectionCameraDecoratorBase, osg::ShearedStereoCameraDecoratorBase, osg::StereoCameraDecoratorBase, and osg::TileCameraDecoratorBase.

UInt32 CameraBase::getContainerSize void    const [virtual]
 

Implements osg::FieldContainer.

Reimplemented in osg::CameraDecoratorBase, osg::MatrixCameraBase, osg::PerspectiveCameraBase, osg::ProjectionCameraDecoratorBase, osg::ShearedStereoCameraDecoratorBase, osg::StereoCameraDecoratorBase, and osg::TileCameraDecoratorBase.

OSG_SYSTEMLIB_DLLMAPPING SFNodePtr * CameraBase::getSFBeacon void    [virtual]
 

Reimplemented in osg::CameraDecoratorBase.

OSG_SYSTEMLIB_DLLMAPPING SFReal32 * CameraBase::getSFNear void    [virtual]
 

Reimplemented in osg::CameraDecoratorBase.

OSG_SYSTEMLIB_DLLMAPPING SFReal32 * CameraBase::getSFFar void    [virtual]
 

Reimplemented in osg::CameraDecoratorBase.

OSG_SYSTEMLIB_DLLMAPPING NodePtr & CameraBase::getBeacon void    [virtual]
 

Reimplemented in osg::CameraDecoratorBase.

OSG_SYSTEMLIB_DLLMAPPING const NodePtr & CameraBase::getBeacon void    const [virtual]
 

Reimplemented in osg::CameraDecoratorBase.

OSG_SYSTEMLIB_DLLMAPPING Real32 & CameraBase::getNear void    [virtual]
 

Reimplemented in osg::CameraDecoratorBase.

OSG_SYSTEMLIB_DLLMAPPING const Real32 & CameraBase::getNear void    const [virtual]
 

Reimplemented in osg::CameraDecoratorBase.

OSG_SYSTEMLIB_DLLMAPPING Real32 & CameraBase::getFar void    [virtual]
 

Reimplemented in osg::CameraDecoratorBase.

OSG_SYSTEMLIB_DLLMAPPING const Real32 & CameraBase::getFar void    const [virtual]
 

Reimplemented in osg::CameraDecoratorBase.

OSG_SYSTEMLIB_DLLMAPPING void CameraBase::setBeacon const NodePtr   value [virtual]
 

Reimplemented in osg::CameraDecoratorBase.

OSG_SYSTEMLIB_DLLMAPPING void CameraBase::setNear const Real32   value [virtual]
 

Reimplemented in osg::CameraDecoratorBase.

OSG_SYSTEMLIB_DLLMAPPING void CameraBase::setFar const Real32   value [virtual]
 

Reimplemented in osg::CameraDecoratorBase.

void CameraBase::executeSync FieldContainer   other,
const BitVector   whichField
[virtual]
 

Reimplemented from osg::AttachmentContainer.

Reimplemented in osg::CameraDecoratorBase, osg::MatrixCameraBase, osg::PerspectiveCameraBase, osg::ProjectionCameraDecoratorBase, osg::ShearedStereoCameraDecoratorBase, osg::StereoCameraDecoratorBase, and osg::TileCameraDecoratorBase.

UInt32 CameraBase::getBinSize const BitVector   whichField [virtual]
 

Reimplemented from osg::AttachmentContainer.

Reimplemented in osg::CameraDecoratorBase, osg::MatrixCameraBase, osg::PerspectiveCameraBase, osg::ProjectionCameraDecoratorBase, osg::ShearedStereoCameraDecoratorBase, osg::StereoCameraDecoratorBase, and osg::TileCameraDecoratorBase.

void CameraBase::copyToBin BinaryDataHandler   pMem,
const BitVector   whichField
[virtual]
 

Reimplemented from osg::AttachmentContainer.

Reimplemented in osg::CameraDecoratorBase, osg::MatrixCameraBase, osg::PerspectiveCameraBase, osg::ProjectionCameraDecoratorBase, osg::ShearedStereoCameraDecoratorBase, osg::StereoCameraDecoratorBase, and osg::TileCameraDecoratorBase.

void CameraBase::copyFromBin BinaryDataHandler   pMem,
const BitVector   whichField
[virtual]
 

Reimplemented from osg::AttachmentContainer.

Reimplemented in osg::CameraDecoratorBase, osg::MatrixCameraBase, osg::PerspectiveCameraBase, osg::ProjectionCameraDecoratorBase, osg::ShearedStereoCameraDecoratorBase, osg::StereoCameraDecoratorBase, and osg::TileCameraDecoratorBase.

void CameraBase::executeSyncImpl CameraBase *    pOther,
const BitVector   whichField
[protected]
 

void osg::CameraBase::operator= const CameraBase &    source [private]
 


Friends And Related Function Documentation

friend class FieldContainer [friend]
 

Reimplemented from osg::AttachmentContainer.

Reimplemented in osg::Camera, osg::CameraDecorator, osg::CameraDecoratorBase, osg::MatrixCamera, osg::MatrixCameraBase, osg::PerspectiveCamera, osg::PerspectiveCameraBase, osg::ProjectionCameraDecorator, osg::ProjectionCameraDecoratorBase, osg::ShearedStereoCameraDecorator, osg::ShearedStereoCameraDecoratorBase, osg::StereoCameraDecorator, osg::StereoCameraDecoratorBase, osg::TileCameraDecorator, and osg::TileCameraDecoratorBase.


Member Data Documentation

const osg::BitVector CameraBase::BeaconFieldMask [static]
 

Initial value:

 
    (1 << CameraBase::BeaconFieldId)

const osg::BitVector CameraBase::NearFieldMask [static]
 

Initial value:

 
    (1 << CameraBase::NearFieldId)

const osg::BitVector CameraBase::FarFieldMask [static]
 

Initial value:

 
    (1 << CameraBase::FarFieldId)

NodePtr CameraBase::_sfBeacon [protected]
 

The object that define's the camera's coordinate system. The camera is positioned at the origin of the system and looks doen the negative z-axis (OpenGL-style).

Real32 CameraBase::_sfNear [protected]
 

The near distance of the camera.

Real32 CameraBase::_sfFar [protected]
 

The far distance of the camera.

FieldDescription * CameraBase::_desc [static, private]
 

Initial value:

 
{
    new FieldDescription(SFNodePtr::getClassType(), 
                     "beacon", 
                     BeaconFieldId, BeaconFieldMask,
                     false,
                     (FieldAccessMethod) &CameraBase::getSFBeacon),
    new FieldDescription(SFReal32::getClassType(), 
                     "near", 
                     NearFieldId, NearFieldMask,
                     false,
                     (FieldAccessMethod) &CameraBase::getSFNear),
    new FieldDescription(SFReal32::getClassType(), 
                     "far", 
                     FarFieldId, FarFieldMask,
                     false,
                     (FieldAccessMethod) &CameraBase::getSFFar)
}
Camera description.

Reimplemented from osg::AttachmentContainer.

Reimplemented in osg::CameraDecoratorBase, osg::MatrixCameraBase, osg::PerspectiveCameraBase, osg::ProjectionCameraDecoratorBase, osg::ShearedStereoCameraDecoratorBase, osg::StereoCameraDecoratorBase, and osg::TileCameraDecoratorBase.

FieldContainerType CameraBase::_type [static, private]
 

Camera type.

Reimplemented from osg::AttachmentContainer.

Reimplemented in osg::CameraDecoratorBase, osg::MatrixCameraBase, osg::PerspectiveCameraBase, osg::ProjectionCameraDecoratorBase, osg::ShearedStereoCameraDecoratorBase, osg::StereoCameraDecoratorBase, and osg::TileCameraDecoratorBase.


The documentation for this class was generated from the following files:
Generated on Wed Jul 3 16:30:04 2002 for OpenSG by doxygen1.2.16