Terminus
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
terminus::SkyBox Class Reference

The SkyBox class renders an environment map in the form of a cube map on a screen aligned quad in the background. More...

#include <skybox.h>

Inheritance diagram for terminus::SkyBox:
terminus::AbstractGraphicsObject

Public Member Functions

 SkyBox (World &world)
 
void localRenderSetup (QOpenGLFunctions &gl, Program &program) const override
 override this method to customize the rendering process More...
 
void localRenderCleanup (QOpenGLFunctions &gl, Program &program) const override
 override this method to customize the rendering process More...
 
- Public Member Functions inherited from terminus::AbstractGraphicsObject
 AbstractGraphicsObject (World &world)
 
virtual ~AbstractGraphicsObject ()
 
virtual void update () final
 update object hierarchy beginning at this object More...
 
virtual void render (QOpenGLFunctions &gl) final
 render object hierarchy beginning at this object More...
 
virtual void bindCamera (Camera *camera)
 binds a camera to track this object More...
 
virtual void unbindCamera (Camera *camera)
 release a camera so that it wont track this object any longer More...
 
virtual void onBindCamera ()
 override this method to perform specific actions once a camera has been bound More...
 
virtual void onUnbindCamera ()
 override this method to perform specific actions once a camera has been released More...
 
virtual void adjustCamera ()
 override this method to adjust the parameters of a bound camera according to this objects own state More...
 
virtual void moveEvent (QVector3D movement)
 override this method to react to move events received by a bound camera More...
 
virtual void rotateEvent (QVector2D rotation)
 override this method to react to rotate events received by a bound camera More...
 
const QVector3D & minBB () const
 
const QVector3D & maxBB () const
 
QVector3D worldUp ()
 
QVector3D worldFront ()
 
QVector3D worldSide ()
 
QVector3D position () const
 
QQuaternion rotation () const
 
QVector3D scale () const
 
QMatrix4x4 modelMatrix () const
 
QMatrix4x4 modelMatrixInverted () const
 

Protected Member Functions

void allocateCubeMap (QOpenGLFunctions &gl) const
 
void deallocateCubeMap (QOpenGLFunctions &gl) const
 
- Protected Member Functions inherited from terminus::AbstractGraphicsObject
virtual void localUpdate ()
 override this method to update this objects state More...
 
virtual void localRender (QOpenGLFunctions &gl) const
 this method contains the default render code using m_geometry, m_program and m_material More...
 
virtual bool localRenderEnabled () const
 override this method to disable or enable rendering conditionally More...
 
virtual void doForAllChildren (std::function< void(AbstractGraphicsObject &)> callback)
 override this method to make child objects known More...
 
void setPosition (const QVector3D &position)
 sets the position and invalidates the model matrices More...
 
void setRotation (const QQuaternion &rotation)
 sets the rotation and invalidates the model matrices More...
 
void setScale (const QVector3D &scale)
 sets the scale and invalidates the model matrices More...
 
void setScale (float scale)
 sets the scale uniformly on all three axes and invalidates the model matrices More...
 
QVector3D worldToModel (const QVector3D &vWorld)
 
QVector3D modelToWorld (const QVector3D &vModel)
 
void dispose ()
 remove this object from the world and delete it as soon as it is safe to do so More...
 

Protected Attributes

bool m_cubeMapOnGPU
 
std::unique_ptr< QImage > m_imageNX
 
std::unique_ptr< QImage > m_imagePX
 
std::unique_ptr< QImage > m_imageNY
 
std::unique_ptr< QImage > m_imagePY
 
std::unique_ptr< QImage > m_imageNZ
 
std::unique_ptr< QImage > m_imagePZ
 
GLuint m_cubeMap
 
- Protected Attributes inherited from terminus::AbstractGraphicsObject
Worldm_world
 
bool m_validState
 
Cameram_camera
 
std::shared_ptr< std::unique_ptr< Program > > m_program
 
std::shared_ptr< std::unique_ptr< Geometry > > m_geometry
 
std::shared_ptr< std::unique_ptr< Material > > m_material
 
QVector3D m_position
 
QQuaternion m_rotation
 
QVector3D m_scale
 
bool m_modelMatrixChanged
 
QMatrix4x4 m_modelMatrix
 
bool m_modelMatrixInvertedChanged
 
QMatrix4x4 m_modelMatrixInverted
 

Detailed Description

The SkyBox class renders an environment map in the form of a cube map on a screen aligned quad in the background.

Constructor & Destructor Documentation

terminus::SkyBox::SkyBox ( World world)

Member Function Documentation

void terminus::SkyBox::allocateCubeMap ( QOpenGLFunctions &  gl) const
protected
void terminus::SkyBox::deallocateCubeMap ( QOpenGLFunctions &  gl) const
protected
void terminus::SkyBox::localRenderCleanup ( QOpenGLFunctions &  gl,
Program program 
) const
overridevirtual

override this method to customize the rendering process

Parameters
gl
program- still bound

Here is the right place to clean up rendering states set in localRenderSetup().

Reimplemented from terminus::AbstractGraphicsObject.

void terminus::SkyBox::localRenderSetup ( QOpenGLFunctions &  gl,
Program program 
) const
overridevirtual

override this method to customize the rendering process

Parameters
gl
program- already bound

Here is the right place to set additional uniforms and to bind textures &c.

Reimplemented from terminus::AbstractGraphicsObject.

Member Data Documentation

GLuint terminus::SkyBox::m_cubeMap
mutableprotected
bool terminus::SkyBox::m_cubeMapOnGPU
mutableprotected
std::unique_ptr<QImage> terminus::SkyBox::m_imageNX
protected
std::unique_ptr<QImage> terminus::SkyBox::m_imageNY
protected
std::unique_ptr<QImage> terminus::SkyBox::m_imageNZ
protected
std::unique_ptr<QImage> terminus::SkyBox::m_imagePX
protected
std::unique_ptr<QImage> terminus::SkyBox::m_imagePY
protected
std::unique_ptr<QImage> terminus::SkyBox::m_imagePZ
protected

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