Free Electron
Public Member Functions | List of all members
fe::ext::CameraI Class Referenceabstract

viewing position More...

#include <CameraI.h>

Inheritance diagram for fe::ext::CameraI:
Inheritance graph
[legend]

Public Member Functions

virtual void setCameraMatrix (const SpatialTransform &matrix)=0
 Set camera transform. More...
 
virtual const SpatialTransformcameraMatrix (void) const =0
 Get camera transform. More...
 
virtual void setFov (Vector2 a_fov)=0
 Set perspective Field of View (degrees) More...
 
virtual Vector2 fov (void) const =0
 Get perspective Field of View (degrees) More...
 
virtual void setPlanes (Real nearplane, Real farplane)=0
 Set distance clipping planes. More...
 
virtual void getPlanes (Real &nearplane, Real &farplane)=0
 Get distance clipping planes. More...
 
virtual void setOrtho (Real a_zoom, const Vector2 &a_center)=0
 Set clipping planes. More...
 
virtual void getOrtho (Real &a_zoom, Vector2 &a_center) const =0
 Get clipping planes. More...
 
virtual void setRasterSpace (BWORD a_rasterSpace)=0
 choose drawing to 2D pixel coordinates More...
 
virtual BWORD rasterSpace (void) const =0
 Get raster space mode (on/off) More...
 
- Public Member Functions inherited from fe::Component
const Stringname (void) const
 Return the components chosen name. More...
 
const String verboseName (void) const
 Return the annotated chosen name. More...
 
void setName (const String &name)
 Rename the component to anything you want. More...
 
hp< Registryregistry (void) const
 Get the Registry that created this component. More...
 
void adjoin (sp< Component > spComponent)
 Tie this component's lifetime to another. More...
 
sp< Componentcreate (const String &implementation, BWORD quiet=FALSE) const
 Convienience function to registry()->create() More...
 
void disjoin (void)
 Untie component from Hub, if connected. More...
 
String factoryName (void)
 
void setLibrary (sp< Library > spLibrary)
 Store a reference to the library used to instantiate this component. More...
 
sp< Librarylibrary (void)
 Get the library that created the component. More...
 
void setFactoryIndex (I32 a_factoryIndex)
 Set the library's factory index. More...
 
I32 factoryIndex (void)
 Get the library's factory index. More...
 
void setSingleton (BWORD set)
 Specify whether component is a singleton. More...
 
BWORD isSingleton (void)
 Return whether component is a singleton. More...
 
virtual void acquire (void)
 Specialized reference increment. More...
 
virtual void release (void)
 Specialized reference decrement. More...
 
- Public Member Functions inherited from fe::Handled< Component >
const hp< Component > & getHandle (void) const
 Get a safe handle to this object. More...
 
- Public Member Functions inherited from fe::Protectable
virtual I32 protection (void) const
 
virtual void protect (void)
 
virtual void unprotect (void)
 
virtual Protectableclone (Protectable *pInstance=NULL)
 
- Public Member Functions inherited from fe::Counted
virtual void acquire (int &rCount)
 Increment the reference count (and get the count) More...
 
virtual void abandon (void)
 Decrement the reference count. More...
 
int count (void) const
 Return the count of references. More...
 
void setName (const String &)
 
void trackReference (void *pReference, String what)
 
void untrackReference (void *pReference)
 
void registerRegion (void *pT, U32 bytes)
 
- Public Member Functions inherited from fe::Initialized
void initializeAll (void)
 
void setActive (bool a_active)
 

Additional Inherited Members

- Static Public Member Functions inherited from fe::Counted
static String reportTracker (void)
 
static U32 trackerCount (void)
 
- Protected Types inherited from fe::Initialized
typedef void(* InitializeFunction) (Initialized *)
 
- Protected Member Functions inherited from fe::Handled< Component >
void abandonHandle (void)
 
- Protected Member Functions inherited from fe::Counted
int releaseInternal (void)
 Decrement the reference count. More...
 
void suppressReport (void)
 
- Protected Member Functions inherited from fe::Initialized
void addInitializer (InitializeFunction function)
 

Detailed Description

viewing position

Member Function Documentation

◆ cameraMatrix()

virtual const SpatialTransform& fe::ext::CameraI::cameraMatrix ( void  ) const
pure virtual

Get camera transform.

Implemented in fe::ext::SurfaceDrone, and fe::ext::CameraEditable.

◆ fov()

virtual Vector2 fe::ext::CameraI::fov ( void  ) const
pure virtual

Get perspective Field of View (degrees)

Implemented in fe::ext::SurfaceDrone, and fe::ext::CameraEditable.

◆ getOrtho()

virtual void fe::ext::CameraI::getOrtho ( Real &  a_zoom,
Vector2 a_center 
) const
pure virtual

Get clipping planes.

Implemented in fe::ext::CameraEditable.

◆ getPlanes()

virtual void fe::ext::CameraI::getPlanes ( Real &  nearplane,
Real &  farplane 
)
pure virtual

Get distance clipping planes.

Implemented in fe::ext::CameraEditable.

◆ rasterSpace()

virtual BWORD fe::ext::CameraI::rasterSpace ( void  ) const
pure virtual

Get raster space mode (on/off)

Implemented in fe::ext::CameraEditable.

◆ setCameraMatrix()

virtual void fe::ext::CameraI::setCameraMatrix ( const SpatialTransform matrix)
pure virtual

Set camera transform.

The camera transform is the inverse of the transform to the viewpoint.

Implemented in fe::ext::CameraEditable.

◆ setFov()

virtual void fe::ext::CameraI::setFov ( Vector2  a_fov)
pure virtual

Set perspective Field of View (degrees)

Implemented in fe::ext::CameraEditable.

◆ setOrtho()

virtual void fe::ext::CameraI::setOrtho ( Real  a_zoom,
const Vector2 a_center 
)
pure virtual

Set clipping planes.

Implemented in fe::ext::CameraEditable.

◆ setPlanes()

virtual void fe::ext::CameraI::setPlanes ( Real  nearplane,
Real  farplane 
)
pure virtual

Set distance clipping planes.

Implemented in fe::ext::CameraEditable.

◆ setRasterSpace()

virtual void fe::ext::CameraI::setRasterSpace ( BWORD  a_rasterSpace)
pure virtual

choose drawing to 2D pixel coordinates

Does not apply the cameraMatrix to the render system, but still allows it to be used for ViewI::project() and ViewI::unproject().

Implemented in fe::ext::CameraEditable.


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