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

#include <SLSkybox.h>

Inheritance diagram for SLSkybox:

Public Member Functions
	SLSkybox (SLAssetManager *assetMgr, SLstring shaderPath, SLstring cubeMapXPos, SLstring cubeMapXNeg, SLstring cubeMapYPos, SLstring cubeMapYNeg, SLstring cubeMapZPos, SLstring cubeMapZNeg, SLstring name="Default Skybox")
	Construct a new SLSkybox::SLSkybox object with 6 images for all sides. More...

	SLSkybox (SLAssetManager *am, SLstring shaderPath, SLstring hdrImage, SLVec2i resolution, SLstring name="HDR Skybox")
	Constructor for a cube map skybox from a HDR Image. More...

	~SLSkybox ()

SLGLTexture *	environmentCubemap ()

SLGLTexture *	irradianceCubemap ()

SLGLTexture *	roughnessCubemap ()

SLGLTexture *	brdfLutTexture ()

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")
	Construct a new SLNode::SLNode object. More...

	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)
	Initializer function to call SLNode::cull3DRec recursively. More...

virtual void	cull2DRec (SLSceneView *sv)

virtual bool	hitRec (SLRay *ray)

virtual void	statsRec (SLNodeStats &stats)

virtual SLNode *	copyRec ()

virtual SLAABBox &	updateAABBRec (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)

SLNode *	parent ()

SLint	depth () const

SLint	entityID () const

const SLMat4f &	om ()

const SLMat4f &	initialOM ()

const SLMat4f &	updateAndGetWM () const

const SLMat4f &	updateAndGetWMI () const

SLDrawBits *	drawBits ()

SLbool	drawBit (SLuint bit)

SLAABBox *	aabb ()

SLAnimation *	animation ()

SLbool	castsShadows ()

SLMesh *	mesh ()

SLVNode &	children ()

const SLAnimSkeleton *	skeleton ()
	Returns the first skeleton found in the meshes. More...

void	updateRec ()

virtual void	doUpdate ()

bool	updateMeshSkins (bool forceCPUSkinning, 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 SLstring &	name () const

const SLstring &	url () 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.

Definition at line 28 of file SLSkybox.h.

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"`
	)

Construct a new SLSkybox::SLSkybox object with 6 images for all sides.

It is important that during instantiation NO OpenGL functions (gl*) get called because this constructor will be most probably called in a parallel thread from within a SLScene::assemble function. All objects that get rendered have to do their OpenGL initialization when they are used the first time during rendering in the main thread.

Parameters

assetMgr	Asset manager that will own the skybox mesh
shaderPath	Path to the shader files
cubeMapXPos	Texture image file for the positive X side
cubeMapXNeg	Texture image file for the negative X side
cubeMapYPos	Texture image file for the positive Y side
cubeMapYNeg	Texture image file for the negative Y side
cubeMapZPos	Texture image file for the positive Z side
cubeMapZNeg	Texture image file for the negative Z side
name	Name of the skybox

Definition at line 37 of file SLSkybox.cpp.

                                          : SLNode(name)
 {
     assert(assetMgr &&
            "SLSkybox: asset manager is currently mandatory for sky-boxes! "
            "Alternatively the live-time of the box has to be managed in the sky-box!");
  
     // Set HDR flag to false, this is a normal SkyBox
     _isHDR              = false;
     _isBuilt            = true;
     _environmentCubemap = nullptr;
     _irradianceCubemap  = nullptr;
     _roughnessCubemap   = nullptr;
     _brdfLutTexture     = nullptr;
     _hdrTexture         = nullptr;
     _exposure           = 1.0f;
  
     // Create texture, material and program
     _environmentCubemap = new SLGLTexture(assetMgr,
                                           cubeMapXPos,
                                           cubeMapXNeg,
                                           cubeMapYPos,
                                           cubeMapYNeg,
                                           cubeMapZPos,
                                           cubeMapZNeg);
  
     SLMaterial* matCubeMap = new SLMaterial(assetMgr, "matCubeMap");
     matCubeMap->addTexture(_environmentCubemap);
  
     SLGLProgram* sp = new SLGLProgramGeneric(assetMgr,
                                              shaderPath + "SkyBox.vert",
                                              shaderPath + "SkyBox.frag");
     matCubeMap->program(sp);
  
     // Create a box with max. point at min. parameter and vice versa.
     // Like this the boxes normals will point to the inside.
     addMesh(new SLBox(assetMgr,
                       10,
                       10,
                       10,
                       -10,
                       -10,
                       -10,
                       "box",
                       matCubeMap));
 }

◆ SLSkybox() [2/2]

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

Constructor for a cube map skybox from a HDR Image.

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.

Construct a new SLSkybox::SLSkybox object with an HDR image

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.

Remarks: It is important that during instantiation NO OpenGL functions (gl*) get called because this constructor will be most probably called in a parallel thread from within an SLScene::registerAssetsToLoad or SLScene::assemble function. All objects that get rendered have to do their OpenGL initialization when they are used the first time during rendering in the main thread.

Parameters

assetMgr	Asset manager that will own the skybox mesh
shaderPath	Path to the shader files
hdrImage	HDR texture image file
resolution	Resolution of the texture objects for image based lighting
name	Name of the skybox

Definition at line 113 of file SLSkybox.cpp.

                                          : SLNode(name)
 {
     // Set HDR flag to true, this is a HDR SkyBox
     _isHDR    = true;
     _isBuilt  = false;
     _exposure = 1.0f;
  
     // Create shader program for the background
     SLGLProgram* backgroundShader = new SLGLProgramGeneric(am,
                                                            shaderPath + "PBR_SkyboxHDR.vert",
                                                            shaderPath + "PBR_SkyboxHDR.frag");
  
     // The HDR texture is only used to create the environment,
     // the irradiance and the roughness cubemaps
     _hdrTexture = new SLGLTexture(am,
                                   hdrImage,
                                   GL_LINEAR,
                                   GL_LINEAR,
                                   TT_hdr,
                                   GL_CLAMP_TO_EDGE,
                                   GL_CLAMP_TO_EDGE);
  
     // The environment cubemap is used for the rendering of the skybox
     _environmentCubemap = new SLGLTextureIBL(am,
                                              shaderPath,
                                              _hdrTexture,
                                              resolution,
                                              TT_environmentCubemap,
                                              GL_TEXTURE_CUBE_MAP,
                                              true, // read back environment for ray tracing
                                              GL_LINEAR_MIPMAP_LINEAR);
  
     // The irradiance cubemap is used for the ambient indirect light of PBR materials
     _irradianceCubemap = new SLGLTextureIBL(am,
                                             shaderPath,
                                             _environmentCubemap,
                                             SLVec2i(32, 32),
                                             TT_irradianceCubemap,
                                             GL_TEXTURE_CUBE_MAP);
  
     // The roughness cubemap is used for the blurred reflections on PBR materials
     _roughnessCubemap = new SLGLTextureIBL(am,
                                            shaderPath,
                                            _environmentCubemap,
                                            SLVec2i(128, 128),
                                            TT_roughnessCubemap,
                                            GL_TEXTURE_CUBE_MAP);
  
     // The BRDF lookup texture is used for the specular gloss reflection calculation
     _brdfLutTexture = new SLGLTextureIBL(am,
                                          shaderPath,
                                          nullptr,
                                          SLVec2i(512, 512),
                                          TT_brdfLUT,
                                          GL_TEXTURE_2D);
  
     // Create the material of the sky box and store there the other texture to be used for other materials
     SLMaterial* envMaterial = new SLMaterial(am, "matCubeMap");
     envMaterial->addTexture(_environmentCubemap);
     envMaterial->program(backgroundShader);
     envMaterial->skybox(this);
  
     // Create the box for the sky box
     addMesh(new SLBox(am,
                       10,
                       10,
                       10,
                       -10,
                       -10,
                       -10,
                       "box",
                       envMaterial));
 }

◆ ~SLSkybox()

SLSkybox::~SLSkybox ( )

inline

Definition at line 47 of file SLSkybox.h.

47 { ; }

Member Function Documentation

◆ brdfLutTexture()

SLGLTexture* SLSkybox::brdfLutTexture ( )

inline

Definition at line 53 of file SLSkybox.h.

53 { return _brdfLutTexture; }

◆ build()

void SLSkybox::build ( )

private

Builds all texture for HDR image based lighting.

Definition at line 193 of file SLSkybox.cpp.

 {
     _hdrTexture->build(0);
     _environmentCubemap->build(0);
     _irradianceCubemap->build(2);
     _roughnessCubemap->build(3);
     _brdfLutTexture->build(4);
     _isBuilt = true;
 }

◆ colorAtDir()

SLCol4f SLSkybox::colorAtDir ( const SLVec3f & dir )

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

Definition at line 237 of file SLSkybox.cpp.

 {
     if (_mesh && _mesh->mat())
     {
         SLMaterial* mat = _mesh->mat();
  
         if (!mat->textures(TT_diffuse).empty())
         {
             if (mat->textures(TT_diffuse)[0]->images().size() == 6)
             {
                 SLGLTexture* tex = mat->textures(TT_diffuse)[0];
                 return tex->getTexelf(dir);
             }
         }
  
         if (!mat->textures(TT_environmentCubemap).empty())
         {
             if (mat->textures(TT_environmentCubemap)[0]->images().size() == 6)
             {
                 SLGLTexture* tex = mat->textures(TT_environmentCubemap)[0];
                 return tex->getTexelf(dir);
             }
         }
     }
  
     return SLCol4f::BLACK;
 }

◆ drawAroundCamera()

void SLSkybox::drawAroundCamera ( SLSceneView * sv )

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

Definition at line 204 of file SLSkybox.cpp.

 {
     assert(sv && "No SceneView passed to SLSkybox::drawAroundCamera");
  
     SLGLState* stateGL = SLGLState::instance();
  
     if (_isHDR && !_isBuilt)
         build();
  
     // Put skybox at the cameras position
     translation(sv->camera()->translationWS());
  
     // Apply world transform
     stateGL->modelMatrix = updateAndGetWM();
  
     // Freeze depth buffer
     stateGL->depthMask(false);
  
     // Change depth buffer comparisons for HDR SkyBoxes
     if (_isHDR)
         stateGL->depthFunc(GL_LEQUAL);
  
     // Draw the box
     drawMesh(sv);
  
     // Change back the depth buffer comparisons
     stateGL->depthFunc(GL_LESS);
  
     // Unlock depth buffer
     stateGL->depthMask(true);
 }

◆ environmentCubemap()

SLGLTexture* SLSkybox::environmentCubemap ( )

inline

Definition at line 50 of file SLSkybox.h.

50 { return _environmentCubemap; }

◆ exposure() [1/2]

SLfloat SLSkybox::exposure ( )

inline

Definition at line 54 of file SLSkybox.h.

54 { return _exposure; }

◆ exposure() [2/2]

void SLSkybox::exposure ( float exp )

inline

Definition at line 58 of file SLSkybox.h.

58 { _exposure = exp; }

◆ irradianceCubemap()

SLGLTexture* SLSkybox::irradianceCubemap ( )

inline

Definition at line 51 of file SLSkybox.h.

51 { return _irradianceCubemap; }

◆ isHDR()

SLbool SLSkybox::isHDR ( )

inline

Definition at line 55 of file SLSkybox.h.

55 { return _isHDR; }

◆ roughnessCubemap()

SLGLTexture* SLSkybox::roughnessCubemap ( )

inline

Definition at line 52 of file SLSkybox.h.

52 { return _roughnessCubemap; }

Member Data Documentation

◆ _brdfLutTexture

SLGLTexture* SLSkybox::_brdfLutTexture

private

Definition at line 68 of file SLSkybox.h.

◆ _environmentCubemap

SLGLTexture* SLSkybox::_environmentCubemap

private

Definition at line 65 of file SLSkybox.h.

◆ _exposure

SLfloat SLSkybox::_exposure

private

Definition at line 70 of file SLSkybox.h.

◆ _hdrTexture

SLGLTexture* SLSkybox::_hdrTexture

private

Definition at line 69 of file SLSkybox.h.

◆ _irradianceCubemap

SLGLTexture* SLSkybox::_irradianceCubemap

private

Definition at line 66 of file SLSkybox.h.

◆ _isBuilt

SLbool SLSkybox::_isBuilt

private

flag for late HDR skybox building

Definition at line 72 of file SLSkybox.h.

◆ _isHDR

SLbool SLSkybox::_isHDR

private

flag for HDR skyboxes

Definition at line 71 of file SLSkybox.h.

◆ _roughnessCubemap

SLGLTexture* SLSkybox::_roughnessCubemap

private

Definition at line 67 of file SLSkybox.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SLSkybox() [1/2]

◆ SLSkybox() [2/2]

◆ ~SLSkybox()

Member Function Documentation

◆ brdfLutTexture()

◆ build()

◆ colorAtDir()

◆ drawAroundCamera()

◆ environmentCubemap()

◆ exposure() [1/2]

◆ exposure() [2/2]

◆ irradianceCubemap()

◆ isHDR()

◆ roughnessCubemap()

Member Data Documentation

◆ _brdfLutTexture

◆ _environmentCubemap

◆ _exposure

◆ _hdrTexture

◆ _irradianceCubemap

◆ _isBuilt

◆ _isHDR

◆ _roughnessCubemap