SLProject 4.0.000
SLSkybox Class Reference

Skybox node class with a SLBox mesh. More...

#include <SLSkybox.h>

Inheritance diagram for SLSkybox:
[legend]

Public Member Functions

 SLSkybox (SLAssetManager *assetMgr, SLstring shaderPath, SLstring cubeMapXPos, SLstring cubeMapXNeg, SLstring cubeMapYPos, SLstring cubeMapYNeg, SLstring cubeMapZPos, SLstring cubeMapZNeg, SLstring name="Default Skybox")
 Cubemap Constructor with cubemap images. More...
 
 SLSkybox (SLAssetManager *am, SLstring shaderPath, SLstring hdrImage, SLVec2i resolution, SLstring name="HDR Skybox")
 Draw the skybox with a cube map with the camera in its center. More...
 
 ~SLSkybox ()
 
SLGLTextureenvironmentCubemap ()
 
SLGLTextureirradianceCubemap ()
 
SLGLTextureroughnessCubemap ()
 
SLGLTexturebrdfLutTexture ()
 
SLfloat exposure ()
 
SLbool isHDR ()
 
void exposure (float exp)
 
void drawAroundCamera (SLSceneView *sv)
 Draw the skybox with a cube map with the camera in its center. More...
 
SLCol4f colorAtDir (const SLVec3f &dir)
 Returns the color in the skybox at the the specified direction dir. More...
 
- Public Member Functions inherited from SLNode
 SLNode (const SLstring &name="Node")
 
 SLNode (SLMesh *mesh, const SLstring &name="Node")
 
 SLNode (SLMesh *mesh, const SLVec3f &translation, const SLstring &name)
 
 ~SLNode () override
 
virtual void cull3DRec (SLSceneView *sv)
 
virtual void cullChildren3D (SLSceneView *sv)
 
virtual void cull2DRec (SLSceneView *sv)
 
virtual bool hitRec (SLRay *ray)
 
virtual void statsRec (SLNodeStats &stats)
 
virtual SLNodecopyRec ()
 
virtual SLAABBoxupdateAABBRec (SLbool updateAlsoAABBinOS)
 
virtual void dumpRec ()
 
void setDrawBitsRec (SLuint bit, SLbool state)
 
void setPrimitiveTypeRec (SLGLPrimitiveType primitiveType)
 
virtual void addMesh (SLMesh *mesh)
 
virtual void drawMesh (SLSceneView *sv)
 Draws the single mesh. More...
 
bool removeMesh ()
 Returns true if a mesh was assigned and set it to nullptr. More...
 
bool removeMesh (SLMesh *mesh)
 Returns true if the passed mesh was assigned and sets it to nullptr. More...
 
SLint numChildren ()
 
void addChild (SLNode *child)
 
bool insertChild (SLNode *insertC, SLNode *afterC)
 
void deleteChildren ()
 
bool deleteChild ()
 
bool deleteChild (SLNode *child)
 
bool deleteChild (const SLstring &name)
 
bool removeChild (SLNode *child)
 remove child from vector of children. Removes false if not found, else true. More...
 
template<typename T >
T * find (const SLstring &name="", SLbool findRecursive=true)
 
template<typename T >
T * findChild (const SLstring &name="", SLbool findRecursive=true)
 
template<typename T >
deque< T * > findChildren (const SLstring &name="", SLbool findRecursive=true, SLbool canContain=false)
 
deque< SLNode * > findChildren (const SLMesh *mesh, SLbool findRecursive=true)
 
deque< SLNode * > findChildren (SLuint drawbit, SLbool findRecursive=true)
 
SLVec3f translationOS () const
 
SLVec3f forwardOS () const
 
SLVec3f rightOS () const
 
SLVec3f upOS () const
 
SLVec3f axisXOS () const
 
SLVec3f axisYOS () const
 
SLVec3f axisZOS () const
 
SLVec3f translationWS () const
 
SLVec3f forwardWS () const
 
SLVec3f rightWS () const
 
SLVec3f upWS () const
 
SLVec3f axisXWS () const
 
SLVec3f axisYWS () const
 
SLVec3f axisZWS () const
 
void translation (const SLVec3f &pos, SLTransformSpace relativeTo=TS_parent)
 
void translation (SLfloat x, SLfloat y, SLfloat z, SLTransformSpace relativeTo=TS_parent)
 
void rotation (const SLQuat4f &rot, SLTransformSpace relativeTo=TS_parent)
 
void rotation (SLfloat angleDeg, const SLVec3f &axis, SLTransformSpace relativeTo=TS_parent)
 
void scaling (SLfloat s)
 
void scaling (SLfloat x, SLfloat y, SLfloat z)
 
void scaling (const SLVec3f &scaling)
 
void lookAt (SLfloat targetX, SLfloat targetY, SLfloat targetZ, SLfloat upX=0, SLfloat upY=1, SLfloat upZ=0, SLTransformSpace relativeTo=TS_world)
 
void lookAt (const SLVec3f &target, const SLVec3f &up=SLVec3f::AXISY, SLTransformSpace relativeTo=TS_world)
 
void translate (const SLVec3f &vec, SLTransformSpace relativeTo=TS_object)
 
void translate (SLfloat x, SLfloat y, SLfloat z, SLTransformSpace relativeTo=TS_object)
 
void rotate (const SLQuat4f &rot, SLTransformSpace relativeTo=TS_object)
 
void rotate (SLfloat angleDeg, const SLVec3f &axis, SLTransformSpace relativeTo=TS_object)
 
void rotate (SLfloat angleDeg, SLfloat x, SLfloat y, SLfloat z, SLTransformSpace relativeTo=TS_object)
 
void rotateAround (const SLVec3f &point, SLVec3f &axis, SLfloat angleDeg, SLTransformSpace relativeTo=TS_world)
 
void scale (SLfloat s)
 
void scale (SLfloat x, SLfloat y, SLfloat z)
 
void scale (const SLVec3f &scale)
 
void scaleToCenter (SLfloat maxDim)
 
void setInitialState ()
 
void resetToInitialState ()
 
void parent (SLNode *p)
 
void entityID (SLint entityID)
 
void om (const SLMat4f &mat)
 
void animation (SLAnimation *a)
 
void castsShadows (SLbool castsShadows)
 
virtual void needUpdate ()
 
void needWMUpdate ()
 
void needAABBUpdate ()
 
void isSelected (bool isSelected)
 
void minLodCoverage (SLfloat minLodCoverage)
 
void levelForSM (SLubyte lfsm)
 
void onUpdateCB (function< void()> callbackFunc)
 
SLNodeparent ()
 
SLint depth () const
 
SLint entityID () const
 
const SLMat4fom ()
 
const SLMat4finitialOM ()
 
const SLMat4fupdateAndGetWM () const
 
const SLMat4fupdateAndGetWMI () const
 
SLDrawBitsdrawBits ()
 
SLbool drawBit (SLuint bit)
 
SLAABBoxaabb ()
 
SLAnimationanimation ()
 
SLbool castsShadows ()
 
SLMeshmesh ()
 
SLVNodechildren ()
 
const SLAnimSkeletonskeleton ()
 Returns the first skeleton found in the meshes. More...
 
void updateRec ()
 
virtual void doUpdate ()
 
bool updateMeshSkins (const std::function< void(SLMesh *)> &cbInformNodes)
 Update all skinned meshes recursively. More...
 
void updateMeshAccelStructs ()
 
void updateMeshMat (std::function< void(SLMaterial *m)> setMat, bool recursive)
 Updates the mesh material recursively with a material lambda. More...
 
void setMeshMat (SLMaterial *mat, bool recursive)
 Set the mesh material recursively. More...
 
bool isSelected ()
 
SLfloat minLodCoverage ()
 
SLubyte levelForSM ()
 
- Public Member Functions inherited from SLObject
 SLObject (const SLstring &Name="", const SLstring &url="")
 
virtual ~SLObject ()
 
void name (const SLstring &Name)
 
void url (const SLstring &url)
 
const SLstringname () const
 
const SLstringurl () const
 
- Public Member Functions inherited from SLEventHandler
 SLEventHandler ()
 
virtual ~SLEventHandler ()
 
virtual SLbool onMouseDown (const SLMouseButton button, const SLint x, const SLint y, const SLKey mod)
 
virtual SLbool onMouseUp (const SLMouseButton button, const SLint x, const SLint y, const SLKey mod)
 
virtual SLbool onMouseMove (const SLMouseButton button, const SLint x, const SLint y, const SLKey mod)
 
virtual SLbool onDoubleClick (const SLMouseButton button, const SLint x, const SLint y, const SLKey mod)
 
virtual SLbool onMouseWheel (const SLint delta, const SLKey mod)
 
virtual SLbool onTouch2Down (const SLint x1, const SLint y1, const SLint x2, const SLint y2)
 
virtual SLbool onTouch2Move (const SLint x1, const SLint y1, const SLint x2, const SLint y2)
 
virtual SLbool onTouch2Up (const SLint x1, const SLint y1, const SLint x2, const SLint y2)
 
virtual SLbool onTouch3Down (const SLint x1, const SLint y1)
 
virtual SLbool onTouch3Move (const SLint x1, const SLint y1)
 
virtual SLbool onTouch3Up (const SLint x1, const SLint y1)
 
virtual SLbool onKeyPress (const SLKey key, const SLKey mod)
 
virtual SLbool onKeyRelease (const SLKey key, const SLKey mod)
 
virtual SLbool onRotationPYR (const SLfloat pitchRAD, const SLfloat yawRAD, const SLfloat rollRAD)
 
void mouseRotationFactor (SLfloat rf)
 
SLfloat mouseRotationFactor ()
 

Private Member Functions

void build ()
 Builds all texture for HDR image based lighting. More...
 

Private Attributes

SLGLTexture_environmentCubemap
 
SLGLTexture_irradianceCubemap
 
SLGLTexture_roughnessCubemap
 
SLGLTexture_brdfLutTexture
 
SLGLTexture_hdrTexture
 
SLfloat _exposure
 
SLbool _isHDR
 flag for HDR skyboxes More...
 
SLbool _isBuilt
 flag for late HDR skybox building More...
 

Additional Inherited Members

- Static Public Attributes inherited from SLNode
static SLuint numWMUpdates = 0
 NO. of calls to updateWMRec per frame. More...
 
static unsigned int instanceIndex = 0
 ??? More...
 
- Protected Attributes inherited from SLNode
SLNode_parent
 pointer to the parent node More...
 
SLVNode _children
 vector of children nodes More...
 
SLMesh_mesh
 pointer to a single mesh More...
 
SLint _depth
 depth of the node in a scene tree More...
 
SLint _entityID
 ID in the SLVEntity graph for Data Oriented Design. More...
 
SLMat4f _om
 object matrix for local transforms More...
 
SLMat4f _initialOM
 the initial om state More...
 
SLMat4f _wm
 world matrix for world transform More...
 
SLMat4f _wmI
 inverse world matrix More...
 
SLbool _isWMUpToDate
 is the WM of this node still valid More...
 
SLbool _isWMIUpToDate
 is the inverse WM of this node still valid More...
 
SLbool _isAABBUpToDate
 is the saved aabb still valid More...
 
bool _castsShadows
 flag if meshes of node should cast shadows More...
 
bool _isSelected
 flag if node and one or more of its meshes are selected More...
 
SLDrawBits _drawBits
 node level drawing flags More...
 
SLAABBox _aabb
 axis aligned bounding box More...
 
SLAnimation_animation
 animation of the node More...
 
SLfloat _minLodCoverage
 Min. LOD coverage for visibility (0.0 < _minLodCoverage < 1.0) More...
 
SLubyte _levelForSM
 Level of LOD to use for shadow mapping (0 = the visible one will be drawn) More...
 
function< void()> _onUpdateCB
 Optional lambda callback once per update. More...
 
- Protected Attributes inherited from SLObject
SLstring _name
 name of an object More...
 
SLstring _url
 uniform resource locator More...
 
- Protected Attributes inherited from SLEventHandler
SLfloat _mouseRotationFactor
 Mouse rotation sensibility. More...
 
SLfloat _keyboardDeltaPos
 Delta dist. for keyboard translation. More...
 

Detailed Description

Skybox node class with a SLBox mesh.

The skybox instance is a node with a SLBox mesh with inwards pointing normals. It gets drawn in SLSceneView::draw3DGL with frozen depth buffer and a special cubemap shader. The box is always with the active camera in its center. It has to be created in SLScene::onLoad and assigned to the skybox pointer of SLSceneView. See the Skybox shader example.

Constructor & Destructor Documentation

◆ SLSkybox() [1/2]

SLSkybox::SLSkybox ( SLAssetManager assetMgr,
SLstring  shaderPath,
SLstring  cubeMapXPos,
SLstring  cubeMapXNeg,
SLstring  cubeMapYPos,
SLstring  cubeMapYNeg,
SLstring  cubeMapZPos,
SLstring  cubeMapZNeg,
SLstring  name = "Default Skybox" 
)

Cubemap Constructor with cubemap images.

All resources allocated are stored in the SLScene vectors for textures, materials, programs and meshes and get deleted at scene destruction.

◆ SLSkybox() [2/2]

SLSkybox::SLSkybox ( SLAssetManager am,
SLstring  shaderPath,
SLstring  hdrImage,
SLVec2i  resolution,
SLstring  name = "HDR Skybox" 
)

Draw the skybox with a cube map with the camera in its center.

This constructor generates a cube map skybox from a HDR Image and also all the textures needed for image based lighting and store them in the textures of the material of this sky box.

◆ ~SLSkybox()

SLSkybox::~SLSkybox ( )
inline

Member Function Documentation

◆ brdfLutTexture()

SLGLTexture * SLSkybox::brdfLutTexture ( )
inline

◆ build()

void SLSkybox::build ( )
private

Builds all texture for HDR image based lighting.

◆ colorAtDir()

SLCol4f SLSkybox::colorAtDir ( const SLVec3f dir)

Returns the color in the skybox at the the specified direction dir.

◆ drawAroundCamera()

void SLSkybox::drawAroundCamera ( SLSceneView sv)

Draw the skybox with a cube map with the camera in its center.

◆ environmentCubemap()

SLGLTexture * SLSkybox::environmentCubemap ( )
inline

◆ exposure() [1/2]

SLfloat SLSkybox::exposure ( )
inline

◆ exposure() [2/2]

void SLSkybox::exposure ( float  exp)
inline

◆ irradianceCubemap()

SLGLTexture * SLSkybox::irradianceCubemap ( )
inline

◆ isHDR()

SLbool SLSkybox::isHDR ( )
inline

◆ roughnessCubemap()

SLGLTexture * SLSkybox::roughnessCubemap ( )
inline

Member Data Documentation

◆ _brdfLutTexture

SLGLTexture* SLSkybox::_brdfLutTexture
private

◆ _environmentCubemap

SLGLTexture* SLSkybox::_environmentCubemap
private

◆ _exposure

SLfloat SLSkybox::_exposure
private

◆ _hdrTexture

SLGLTexture* SLSkybox::_hdrTexture
private

◆ _irradianceCubemap

SLGLTexture* SLSkybox::_irradianceCubemap
private

◆ _isBuilt

SLbool SLSkybox::_isBuilt
private

flag for late HDR skybox building

◆ _isHDR

SLbool SLSkybox::_isHDR
private

flag for HDR skyboxes

◆ _roughnessCubemap

SLGLTexture* SLSkybox::_roughnessCubemap
private

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