NTrace
GPU ray tracing framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Types | Public Member Functions | List of all members
FW::CameraControls Class Reference

#include <CameraControls.hpp>

Inherits FW::Window::Listener, and FW::CommonControls::StateObject.

Public Types

enum  Feature {
  Feature_AlignYButton = 1 << 0, Feature_AlignZButton = 1 << 1, Feature_KeepAlignToggle = 1 << 2, Feature_SpeedSlider = 1 << 3,
  Feature_FOVSlider = 1 << 4, Feature_NearSlider = 1 << 5, Feature_FarSlider = 1 << 6, Feature_StereoControls = 1 << 7,
  Feature_None = 0, Feature_All = (1 << 8) - 1, Feature_Default = Feature_All & ~Feature_StereoControls
}
 

Public Member Functions

 CameraControls (CommonControls *commonControls=NULL, U32 features=Feature_Default)
 
virtual ~CameraControls (void)
 
virtual bool handleEvent (const Window::Event &ev)
 
virtual void readState (StateDump &d)
 
virtual void writeState (StateDump &d) const
 
const Vec3f & getPosition (void) const
 
void setPosition (const Vec3f &v)
 
const Vec3f & getForward (void) const
 
void setForward (const Vec3f &v)
 
const Vec3f & getUp (void) const
 
void setUp (const Vec3f &v)
 
bool getKeepAligned (void) const
 
void setKeepAligned (bool v)
 
F32 getSpeed (void) const
 
void setSpeed (F32 v)
 
F32 getFOV (void) const
 
void setFOV (F32 v)
 
F32 getNear (void) const
 
void setNear (F32 v)
 
F32 getFar (void) const
 
void setFar (F32 v)
 
Mat3f getOrientation (void) const
 
Mat4f getCameraToWorld (void) const
 
Mat4f getWorldToCamera (void) const
 
Mat4f getCameraToClip (void) const
 
Mat4f getWorldToClip (void) const
 
Mat4f getCameraToLeftEye (void) const
 
Mat4f getCameraToRightEye (void) const
 
void setCameraToWorld (const Mat4f &m)
 
void setWorldToCamera (const Mat4f &m)
 
void initDefaults (void)
 
void initForMesh (const MeshBase *mesh)
 
String encodeSignature (void) const
 
void decodeSignature (const String &sig)
 
void print (void)
 
void addGUIControls (void)
 
void removeGUIControls (void)
 
void setEnableMovement (bool enable)
 
- Public Member Functions inherited from FW::Window::Listener
 Listener (void)
 
virtual ~Listener (void)
 
- Public Member Functions inherited from FW::CommonControls::StateObject
 StateObject (void)
 
virtual ~StateObject (void)
 

Detailed Description

Definition at line 40 of file CameraControls.hpp.

Member Enumeration Documentation

enum FW::CameraControls::Feature
Enumerator
Feature_AlignYButton 
Feature_AlignZButton 
Feature_KeepAlignToggle 
Feature_SpeedSlider 
Feature_FOVSlider 
Feature_NearSlider 
Feature_FarSlider 
Feature_StereoControls 
Feature_None 
Feature_All 
Feature_Default 

Definition at line 46 of file CameraControls.hpp.

Constructor & Destructor Documentation

CameraControls::CameraControls ( CommonControls *  commonControls = NULL,
U32  features = Feature_Default 
)

Definition at line 43 of file CameraControls.cpp.

CameraControls::~CameraControls ( void  )
virtual

Definition at line 62 of file CameraControls.cpp.

Member Function Documentation

void CameraControls::addGUIControls ( void  )

Definition at line 411 of file CameraControls.cpp.

void CameraControls::decodeSignature ( const String &  sig)

Definition at line 360 of file CameraControls.cpp.

String CameraControls::encodeSignature ( void  ) const

Definition at line 340 of file CameraControls.cpp.

Mat4f FW::CameraControls::getCameraToClip ( void  ) const
inline

Definition at line 92 of file CameraControls.hpp.

Mat4f FW::CameraControls::getCameraToLeftEye ( void  ) const
inline

Definition at line 94 of file CameraControls.hpp.

Mat4f FW::CameraControls::getCameraToRightEye ( void  ) const
inline

Definition at line 95 of file CameraControls.hpp.

Mat4f CameraControls::getCameraToWorld ( void  ) const

Definition at line 260 of file CameraControls.cpp.

F32 FW::CameraControls::getFar ( void  ) const
inline

Definition at line 86 of file CameraControls.hpp.

const Vec3f& FW::CameraControls::getForward ( void  ) const
inline

Definition at line 74 of file CameraControls.hpp.

F32 FW::CameraControls::getFOV ( void  ) const
inline

Definition at line 82 of file CameraControls.hpp.

bool FW::CameraControls::getKeepAligned ( void  ) const
inline

Definition at line 78 of file CameraControls.hpp.

F32 FW::CameraControls::getNear ( void  ) const
inline

Definition at line 84 of file CameraControls.hpp.

Mat3f CameraControls::getOrientation ( void  ) const

Definition at line 249 of file CameraControls.cpp.

const Vec3f& FW::CameraControls::getPosition ( void  ) const
inline

Definition at line 72 of file CameraControls.hpp.

F32 FW::CameraControls::getSpeed ( void  ) const
inline

Definition at line 80 of file CameraControls.hpp.

const Vec3f& FW::CameraControls::getUp ( void  ) const
inline

Definition at line 76 of file CameraControls.hpp.

Mat4f CameraControls::getWorldToCamera ( void  ) const

Definition at line 273 of file CameraControls.cpp.

Mat4f FW::CameraControls::getWorldToClip ( void  ) const
inline

Definition at line 93 of file CameraControls.hpp.

bool CameraControls::handleEvent ( const Window::Event &  ev)
virtual

Implements FW::Window::Listener.

Definition at line 68 of file CameraControls.cpp.

void CameraControls::initDefaults ( void  )

Definition at line 297 of file CameraControls.cpp.

void CameraControls::initForMesh ( const MeshBase *  mesh)

Definition at line 316 of file CameraControls.cpp.

void CameraControls::print ( void  )

Definition at line 398 of file CameraControls.cpp.

void CameraControls::readState ( StateDump &  d)
virtual

Implements FW::CommonControls::StateObject.

Definition at line 210 of file CameraControls.cpp.

void CameraControls::removeGUIControls ( void  )

Definition at line 445 of file CameraControls.cpp.

void CameraControls::setCameraToWorld ( const Mat4f &  m)

Definition at line 286 of file CameraControls.cpp.

void FW::CameraControls::setEnableMovement ( bool  enable)
inline

Definition at line 109 of file CameraControls.hpp.

void FW::CameraControls::setFar ( F32  v)
inline

Definition at line 87 of file CameraControls.hpp.

void FW::CameraControls::setForward ( const Vec3f &  v)
inline

Definition at line 75 of file CameraControls.hpp.

void FW::CameraControls::setFOV ( F32  v)
inline

Definition at line 83 of file CameraControls.hpp.

void FW::CameraControls::setKeepAligned ( bool  v)
inline

Definition at line 79 of file CameraControls.hpp.

void FW::CameraControls::setNear ( F32  v)
inline

Definition at line 85 of file CameraControls.hpp.

void FW::CameraControls::setPosition ( const Vec3f &  v)
inline

Definition at line 73 of file CameraControls.hpp.

void FW::CameraControls::setSpeed ( F32  v)
inline

Definition at line 81 of file CameraControls.hpp.

void FW::CameraControls::setUp ( const Vec3f &  v)
inline

Definition at line 77 of file CameraControls.hpp.

void FW::CameraControls::setWorldToCamera ( const Mat4f &  m)
inline

Definition at line 98 of file CameraControls.hpp.

void CameraControls::writeState ( StateDump &  d) const
virtual

Implements FW::CommonControls::StateObject.

Definition at line 230 of file CameraControls.cpp.

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