SLScene Class Reference

The SLScene class represents the top level instance holding the scene structure. More...

#include <SLScene.h>

Inherits SLObject.

Inherited by AppDemoScene2Dand3DText, AppDemoSceneAnimNode, AppDemoSceneAnimNodeMass, AppDemoSceneAnimNodeMass2, AppDemoSceneAnimSkinned, AppDemoSceneAnimSkinnedMass, AppDemoSceneAnimSkinnedMass2, AppDemoSceneEmpty, AppDemoSceneErlebARAugustaTmpTht, AppDemoSceneErlebARAventicumAmphitheater, AppDemoSceneErlebARAventicumCigognier, AppDemoSceneErlebARAventicumTheater, AppDemoSceneErlebARBernChristoffel, AppDemoSceneErlebARBielBFH, AppDemoSceneErlebARSutz, AppDemoSceneFigure, AppDemoSceneFrustum, AppDemoSceneGLTF, AppDemoSceneJansUniverse, AppDemoSceneLargeModel, AppDemoSceneLevelOfDetail, AppDemoSceneLotsOfNodes, AppDemoSceneMeshLoad, AppDemoSceneMinimal, AppDemoSceneParticleComplexFire, AppDemoSceneParticleDustStorm, AppDemoSceneParticleFountain, AppDemoSceneParticleMany, AppDemoSceneParticleRingOfFire, AppDemoSceneParticleSimple, AppDemoSceneParticleSun, AppDemoScenePointClouds, AppDemoSceneRTDoF, AppDemoSceneRTLens, AppDemoSceneRTMuttenzerBox, AppDemoSceneRTSpheres, AppDemoSceneRevolver, AppDemoSceneRobot, AppDemoSceneShaderBlinn, AppDemoSceneShaderBump, AppDemoSceneShaderCook, AppDemoSceneShaderEarth, AppDemoSceneShaderIBL, AppDemoSceneShaderParallax, AppDemoSceneShaderSkybox, AppDemoSceneShaderWave, AppDemoSceneShadowBasic, AppDemoSceneShadowCascaded, AppDemoSceneShadowLightPoint, AppDemoSceneShadowLightSpot, AppDemoSceneShadowLightTypes, AppDemoSceneSuzanne, AppDemoSceneTextureBlend, AppDemoSceneTextureCompression, AppDemoSceneTextureFilter, AppDemoSceneVideoSensorAR, AppDemoSceneVideoTexture, AppDemoSceneVideoTrackAruco, AppDemoSceneVideoTrackChessboard, AppDemoSceneVideoTrackFace, AppDemoSceneVideoTrackFeatures, AppDemoSceneVideoTrackMediapipe, AppDemoSceneVideoTrackWAI, AppDemoSceneVolumeRayCast, AppDemoSceneVolumeRayCastLighted, AppDemoSceneZFighting, AppMinimalScene, and AppNodeScene.

Public Member Functions
	SLScene (const SLstring &name)
	~SLScene () override
void	initOculus (SLstring shaderDir)
virtual void	registerAssetsToLoad (SLAssetLoader &al)
	All assets the should be loaded in parallel must be registered in here. More...
virtual void	assemble (SLAssetManager *am, SLSceneView *sv)
	After parallel loading of the assets the scene gets assembled in here. More...
void	root3D (SLNode *root3D)
void	root2D (SLNode *root2D)
void	skybox (SLSkybox *skybox)
void	stopAnimations (SLbool stop)
void	info (SLstring i)
void	loadTimeMS (SLfloat loadTimeMS)
SLAnimManager &	animManager ()
SLAssetManager *	assetManager ()
SLNode *	root3D ()
SLNode *	root2D ()
SLSkybox *	skybox ()
SLstring &	info ()
SLfloat	elapsedTimeMS () const
SLfloat	elapsedTimeSec () const
SLVEventHandler &	eventHandlers ()
SLfloat	loadTimeMS () const
SLVLight &	lights ()
SLfloat	fps () const
AvgFloat &	frameTimesMS ()
AvgFloat &	updateTimesMS ()
AvgFloat &	updateAnimTimesMS ()
AvgFloat &	updateAABBTimesMS ()
AvgFloat &	updateDODTimesMS ()
SLNode *	singleNodeSelected ()
	Returns the node if only one is selected. See also SLMesh::selectNodeMesh. More...
SLMesh *	singleMeshFullSelected ()
	Returns the node if only one is selected. See also SLMesh::selectNodeMesh. More...
SLVNode &	selectedNodes ()
SLVMesh &	selectedMeshes ()
SLbool	stopAnimations () const
SLint	numSceneCameras ()
	Returns the number of camera nodes in the scene. More...
SLCamera *	nextCameraInScene (SLCamera *activeSVCam)
	Returns the next camera in the scene if there is one. More...
bool	onUpdate (bool renderTypeIsRT, bool voxelsAreShown, bool forceCPUSkinning)
	Updates animations and AABBs. More...
void	init (SLAssetManager *am)
virtual void	unInit ()
void	selectNodeMesh (SLNode *nodeToSelect, SLMesh *meshToSelect)
	Handles the full mesh selection from double-clicks. More...
void	deselectAllNodesAndMeshes ()
	Deselects all nodes and its meshes. More...
SLGLOculus *	oculus ()
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

Protected Attributes
SLVLight	_lights
	Vector of all lights. More...
SLVEventHandler	_eventHandlers
	Vector of all event handler. More...
SLAnimManager	_animManager
	Animation manager instance. More...
SLAssetManager *	_assetManager
	Pointer to the external assetManager. More...
SLNode *	_root3D
	Root node for 3D scene. More...
SLNode *	_root2D
	Root node for 2D scene displayed in ortho projection. More...
SLSkybox *	_skybox
	pointer to skybox More...
SLstring	_info
	scene info string More...
SLVNode	_selectedNodes
	Vector of selected nodes. See SLMesh::selectNodeMesh. More...
SLVMesh	_selectedMeshes
	Vector of selected meshes. See SLMesh::selectNodeMesh. More...
SLfloat	_loadTimeMS
	time to load scene in ms More...
SLfloat	_frameTimeMS
	Last frame time in ms. More...
SLfloat	_lastUpdateTimeMS
	Last time after update in ms. More...
SLfloat	_fps
	Averaged no. of frames per second. More...
AvgFloat	_frameTimesMS
	Averaged total time per frame in ms. More...
AvgFloat	_updateTimesMS
	Averaged time for update in ms. More...
AvgFloat	_updateAABBTimesMS
	Averaged time for update the nodes AABB in ms. More...
AvgFloat	_updateAnimTimesMS
	Averaged time for update the animations in ms. More...
AvgFloat	_updateDODTimesMS
	Averaged time for update the SLEntities graph. More...
SLbool	_stopAnimations
	Global flag for stopping all animations. More...
std::unique_ptr< SLGLOculus >	_oculus
	Oculus Rift interface. More...
Protected Attributes inherited from SLObject
SLstring	_name
	name of an object More...
SLstring	_url
	uniform resource locator More...

Friends
class	SLNode

Detailed Description

The SLScene class represents the top level instance holding the scene structure.

The SLScene class holds everything that is common for all sceneviews such as the pointer (_root3D) to the root node of the scene. The scene loading happens in 3 steps:
1) Registering all expensive assets to load in registerAssetsToLoad.
2) Parallel loading of assets in threads with SLAssetLoader::loadAll.
3) Assembling the scene in assemble.
To load a scene you must therefore inherit from this class and override the methods registerAssetsToLoad and assemble.

Definition at line 46 of file SLScene.h.

Constructor & Destructor Documentation

SLScene()

SLScene::SLScene

(

const SLstring &

name

)

The constructor of the scene. There will be only one scene for an application and it gets constructed in the C-interface function slCreateScene in SLInterface.cpp that is called by the platform and UI-toolkit dependent window initialization. As examples you can see it in:

• app_demo_slproject/glfw: glfwMain.cpp in function main()
• app-demo/android: Java_ch_fhnw_comgRT_glES2Lib_onInit()
• app_demo_slproject/ios: ViewController.m in method viewDidLoad()
• _old/app-Demo-Qt: qtGLWidget::initializeGL()
• _old/app-Viewer-Qt: qtGLWidget::initializeGL()

Definition at line 39 of file SLScene.cpp.

  : SLObject(name),
    _loadTimeMS(0.0f),
    _frameTimesMS(60, 0.0f),
    _updateTimesMS(60, 0.0f),
    _updateAABBTimesMS(60, 0.0f),
    _updateAnimTimesMS(60, 0.0f),
    _updateDODTimesMS(60, 0.0f)
{
    _assetManager     = nullptr;
    _root3D           = nullptr;
    _root2D           = nullptr;
    _skybox           = nullptr;
    _info             = "";
    _stopAnimations   = false;
    _fps              = 0;
    _frameTimeMS      = 0;
    _lastUpdateTimeMS = 0;
}

~SLScene()

SLScene::~SLScene ( )

override

The destructor does the final total deallocation of all global resources. The destructor is called in slTerminate.

Definition at line 62 of file SLScene.cpp.

{
    unInit();
 
    SL_LOG_DEBUG("Destructor       : ~SLScene");
    SL_LOG_DEBUG("------------------------------------------------------------------");
}

Member Function Documentation

animManager()

SLAnimManager& SLScene::animManager ( )

inline

Definition at line 97 of file SLScene.h.

{ return _animManager; }

assemble()

virtual void SLScene::assemble ( SLAssetManager *  am, SLSceneView *  sv  )

inlinevirtual

After parallel loading of the assets the scene gets assembled in here.

Remarks

All scene-specific assets have to be loaded async by overriding SLScene::registerAssetsToLoad and SLScene::assemble. Async loading and assembling means that it happens in a parallel thread and that in there are no OpenGL calls allowed. OpenGL calls are only allowed in the main thread. It is important that all object instantiations within SLScene::assemble do NOT call any OpenGL functions (gl*) because they happen in a parallel thread. All objects that get rendered have to do their initialization when they are used the first time during rendering in the main thread.

Reimplemented in AppNodeScene, AppMinimalScene, AppDemoSceneZFighting, AppDemoSceneVolumeRayCastLighted, AppDemoSceneVolumeRayCast, AppDemoSceneVideoTrackWAI, AppDemoSceneVideoTrackMediapipe, AppDemoSceneVideoTrackFeatures, AppDemoSceneVideoTrackFace, AppDemoSceneVideoTrackChessboard, AppDemoSceneVideoTrackAruco, AppDemoSceneVideoTexture, AppDemoSceneVideoSensorAR, AppDemoSceneTextureFilter, AppDemoSceneTextureCompression, AppDemoSceneTextureBlend, AppDemoSceneSuzanne, AppDemoSceneShadowLightTypes, AppDemoSceneShadowLightSpot, AppDemoSceneShadowLightPoint, AppDemoSceneShadowCascaded, AppDemoSceneShadowBasic, AppDemoSceneShaderWave, AppDemoSceneShaderSkybox, AppDemoSceneShaderParallax, AppDemoSceneShaderIBL, AppDemoSceneShaderEarth, AppDemoSceneShaderCook, AppDemoSceneShaderBump, AppDemoSceneShaderBlinn, AppDemoSceneRTSpheres, AppDemoSceneRTMuttenzerBox, AppDemoSceneRTLens, AppDemoSceneRTDoF, AppDemoSceneRobot, AppDemoSceneRevolver, AppDemoScenePointClouds, AppDemoSceneParticleSun, AppDemoSceneParticleSimple, AppDemoSceneParticleRingOfFire, AppDemoSceneParticleMany, AppDemoSceneParticleFountain, AppDemoSceneParticleDustStorm, AppDemoSceneParticleComplexFire, AppDemoSceneMinimal, AppDemoSceneMeshLoad, AppDemoSceneLotsOfNodes, AppDemoSceneLevelOfDetail, AppDemoSceneLargeModel, AppDemoSceneJansUniverse, AppDemoSceneGLTF, AppDemoSceneFrustum, AppDemoSceneFigure, AppDemoSceneErlebARSutz, AppDemoSceneErlebARBielBFH, AppDemoSceneErlebARBernChristoffel, AppDemoSceneErlebARAventicumTheater, AppDemoSceneErlebARAventicumCigognier, AppDemoSceneErlebARAventicumAmphitheater, AppDemoSceneErlebARAugustaTmpTht, AppDemoSceneEmpty, AppDemoSceneAnimSkinnedMass2, AppDemoSceneAnimSkinnedMass, AppDemoSceneAnimSkinned, AppDemoSceneAnimNodeMass2, AppDemoSceneAnimNodeMass, AppDemoSceneAnimNode, and AppDemoScene2Dand3DText.

Definition at line 75 of file SLScene.h.

{}

assetManager()

SLAssetManager* SLScene::assetManager ( )

inline

Definition at line 98 of file SLScene.h.

{ return _assetManager; }

deselectAllNodesAndMeshes()

void SLScene::deselectAllNodesAndMeshes

(

)

Deselects all nodes and its meshes.

Definition at line 338 of file SLScene.cpp.

{
    for (auto sn : _selectedNodes)
        sn->isSelected(false);
    _selectedNodes.clear();
 
    for (auto sm : _selectedMeshes)
    {
        sm->deselectPartialSelection();
        sm->isSelected(false);
    }
    _selectedMeshes.clear();
}

elapsedTimeMS()

SLfloat SLScene::elapsedTimeMS ( ) const

inline

Definition at line 103 of file SLScene.h.

{ return _frameTimeMS; }

elapsedTimeSec()

SLfloat SLScene::elapsedTimeSec ( ) const

inline

Definition at line 104 of file SLScene.h.

{ return _frameTimeMS * 0.001f; }

eventHandlers()

SLVEventHandler& SLScene::eventHandlers ( )

inline

Definition at line 105 of file SLScene.h.

{ return _eventHandlers; }

fps()

SLfloat SLScene::fps ( ) const

inline

Definition at line 108 of file SLScene.h.

{ return _fps; }

frameTimesMS()

AvgFloat& SLScene::frameTimesMS ( )

inline

Definition at line 109 of file SLScene.h.

{ return _frameTimesMS; }

info() [1/2]

SLstring& SLScene::info ( )

inline

Definition at line 102 of file SLScene.h.

{ return _info; }

info() [2/2]

void SLScene::info ( SLstring  i )

inline

Definition at line 93 of file SLScene.h.

{ _info = std::move(i); }

init()

void SLScene::init

(

SLAssetManager *

am

)

The scene init is called before a new scene is assembled.

Definition at line 72 of file SLScene.cpp.

{
    assert(am && "No asset manager passed to scene");
 
    unInit();
 
    _assetManager = am;
 
    // reset global light settings
    SLLight::gamma = 1.0f;
    SLLight::globalAmbient.set(0.15f, 0.15f, 0.15f, 1.0f);
 
    // Reset timing variables
    _frameTimesMS.init(20, 0.0f);
    _updateTimesMS.init(60, 0.0f);
    _updateAnimTimesMS.init(60, 0.0f);
    _updateAABBTimesMS.init(60, 0.0f);
    _updateDODTimesMS.init(60, 0.0f);
}

initOculus()

void SLScene::initOculus

(

SLstring

shaderDir

)

Definition at line 391 of file SLScene.cpp.

{
    _oculus = std::make_unique<SLGLOculus>(shaderDir);
    _oculus->init();
}

lights()

SLVLight& SLScene::lights ( )

inline

Definition at line 107 of file SLScene.h.

{ return _lights; }

loadTimeMS() [1/2]

SLfloat SLScene::loadTimeMS ( ) const

inline

Definition at line 106 of file SLScene.h.

{ return _loadTimeMS; }

loadTimeMS() [2/2]

void SLScene::loadTimeMS ( SLfloat  loadTimeMS )

inline

Definition at line 94 of file SLScene.h.

{ _loadTimeMS = loadTimeMS; }

nextCameraInScene()

SLCamera * SLScene::nextCameraInScene

(

SLCamera *

activeSVCam

)

Returns the next camera in the scene if there is one.

Definition at line 361 of file SLScene.cpp.

{
    if (!_root3D) return nullptr;
 
    deque<SLCamera*> cams = _root3D->findChildren<SLCamera>();
 
    if (cams.empty()) return nullptr;
    if (cams.size() == 1) return cams[0];
 
    SLint activeIndex = 0;
    for (SLulong i = 0; i < cams.size(); ++i)
    {
        if (cams[i] == activeSVCam)
        {
            activeIndex = (SLint)i;
            break;
        }
    }
 
    // find next camera, that is not of type SLKeyframeCamera
    // and if allowAsActiveCam is deactivated
    do
    {
        activeIndex = activeIndex > cams.size() - 2 ? 0 : ++activeIndex;
    } while (dynamic_cast<SLKeyframeCamera*>(cams[(uint)activeIndex]) &&
             !dynamic_cast<SLKeyframeCamera*>(cams[(uint)activeIndex])->allowAsActiveCam());
 
    return cams[(uint)activeIndex];
}

numSceneCameras()

SLint SLScene::numSceneCameras

(

)

Returns the number of camera nodes in the scene.

Definition at line 353 of file SLScene.cpp.

{
    if (!_root3D) return 0;
    deque<SLCamera*> cams = _root3D->findChildren<SLCamera>();
    return (SLint)cams.size();
}

oculus()

SLGLOculus* SLScene::oculus ( )

inline

Definition at line 140 of file SLScene.h.

{ return _oculus.get(); }

onUpdate()

bool SLScene::onUpdate	(	bool	renderTypeIsRT,
		bool	voxelsAreShown,
		bool	forceCPUSkinning
	)

Updates animations and AABBs.

Updates different updatables in the scene after all views got painted:
1) Calculate frame time
2) Update all animations
3) Update AABBs

Returns

true if really something got updated

Definition at line 124 of file SLScene.cpp.

{
    PROFILE_FUNCTION();
 
    /////////////////////////////
    // 1) Calculate frame time //
    /////////////////////////////
 
    // Calculate the elapsed time for the animation
    // todo: If slowdown on idle is enabled the delta time will be wrong!
    _frameTimeMS      = GlobalTimer::timeMS() - _lastUpdateTimeMS;
    _lastUpdateTimeMS = GlobalTimer::timeMS();
 
    // Calculate the frames per second metric
    _frameTimesMS.set(_frameTimeMS);
    SLfloat averagedFrameTimeMS = _frameTimesMS.average();
    if (averagedFrameTimeMS > 0.001f)
        _fps = 1 / _frameTimesMS.average() * 1000.0f;
    else
        _fps = 0.0f;
 
    SLfloat startUpdateMS = GlobalTimer::timeMS();
 
    SLbool sceneHasChanged = false;
 
    //////////////////////////////
    // 2) Update all animations //
    //////////////////////////////
 
    SLfloat startAnimUpdateMS = GlobalTimer::timeMS();
 
    if (_root3D)
        _root3D->updateRec();
    if (_root2D)
        _root2D->updateRec();
 
    // Update node animations
    sceneHasChanged |= !_stopAnimations && _animManager.update(elapsedTimeSec());
 
    // Do software skinning on all changed skeletons. Update any out of date acceleration structure for RT or if they're being rendered.
    if (_root3D)
    {
        if (renderTypeIsRT || voxelsAreShown)
            forceCPUSkinning = true;
 
        // we use a lambda to inform nodes that share a mesh that the mesh got updated (so we don't have to transfer the root node)
        sceneHasChanged |= _root3D->updateMeshSkins(forceCPUSkinning, [&](SLMesh* mesh)
                                                    {
            SLVNode nodes = _root3D->findChildren(mesh, true);
            for (auto* node : nodes)
                node->needAABBUpdate(); });
 
        if (renderTypeIsRT || voxelsAreShown)
            _root3D->updateMeshAccelStructs();
    }
 
    _updateAnimTimesMS.set(GlobalTimer::timeMS() - startAnimUpdateMS);
 
    /////////////////////
    // 3) Update AABBs //
    /////////////////////
 
    // The updateAABBRec call won't generate any overhead if nothing changed
    SLfloat startAAABBUpdateMS = GlobalTimer::timeMS();
    SLNode::numWMUpdates       = 0;
    if (_root3D)
        _root3D->updateAABBRec(renderTypeIsRT);
    if (_root2D)
        _root2D->updateAABBRec(renderTypeIsRT);
    _updateAABBTimesMS.set(GlobalTimer::timeMS() - startAAABBUpdateMS);
 
#ifdef SL_USE_ENTITIES
    SLfloat startDODUpdateMS = GlobalTimer::timeMS();
    if (entities.size())
    {
        SLMat4f root;
        entities.updateWMRec(0, root);
    }
    _updateDODTimesMS.set(GlobalTimer::timeMS() - startDODUpdateMS);
#endif
 
    // Finish total updateRec time
    SLfloat updateTimeMS = GlobalTimer::timeMS() - startUpdateMS;
    _updateTimesMS.set(updateTimeMS);
 
    // SL_LOG("SLScene::onUpdate");
    return sceneHasChanged;
}

registerAssetsToLoad()

virtual void SLScene::registerAssetsToLoad ( SLAssetLoader &  al )

inlinevirtual

All assets the should be loaded in parallel must be registered in here.

All scene specific assets have to be registered for async loading in here.

Remarks

All scene sspecific assets have to be loaded async by overriding SLScene::registerAssetsToLoad and SLScene::assemble. Async loading and assembling means that it happens in a parallel thread and that in there are no OpenGL calls allowed. OpenGL calls are only allowed in the main thread.

Reimplemented in AppNodeScene, AppMinimalScene, AppDemoSceneZFighting, AppDemoSceneVolumeRayCastLighted, AppDemoSceneVolumeRayCast, AppDemoSceneVideoTrackWAI, AppDemoSceneVideoTrackMediapipe, AppDemoSceneVideoTrackFeatures, AppDemoSceneVideoTrackFace, AppDemoSceneVideoTrackChessboard, AppDemoSceneVideoTrackAruco, AppDemoSceneVideoTexture, AppDemoSceneVideoSensorAR, AppDemoSceneTextureFilter, AppDemoSceneTextureCompression, AppDemoSceneTextureBlend, AppDemoSceneSuzanne, AppDemoSceneShadowLightTypes, AppDemoSceneShadowLightSpot, AppDemoSceneShadowLightPoint, AppDemoSceneShadowCascaded, AppDemoSceneShadowBasic, AppDemoSceneShaderWave, AppDemoSceneShaderSkybox, AppDemoSceneShaderParallax, AppDemoSceneShaderIBL, AppDemoSceneShaderEarth, AppDemoSceneShaderCook, AppDemoSceneShaderBump, AppDemoSceneShaderBlinn, AppDemoSceneRTSpheres, AppDemoSceneRTMuttenzerBox, AppDemoSceneRTLens, AppDemoSceneRTDoF, AppDemoSceneRobot, AppDemoSceneRevolver, AppDemoScenePointClouds, AppDemoSceneParticleSun, AppDemoSceneParticleSimple, AppDemoSceneParticleRingOfFire, AppDemoSceneParticleMany, AppDemoSceneParticleFountain, AppDemoSceneParticleDustStorm, AppDemoSceneParticleComplexFire, AppDemoSceneMinimal, AppDemoSceneMeshLoad, AppDemoSceneLotsOfNodes, AppDemoSceneLevelOfDetail, AppDemoSceneLargeModel, AppDemoSceneJansUniverse, AppDemoSceneGLTF, AppDemoSceneFrustum, AppDemoSceneFigure, AppDemoSceneErlebARSutz, AppDemoSceneErlebARBielBFH, AppDemoSceneErlebARBernChristoffel, AppDemoSceneErlebARAventicumTheater, AppDemoSceneErlebARAventicumCigognier, AppDemoSceneErlebARAventicumAmphitheater, AppDemoSceneErlebARAugustaTmpTht, AppDemoSceneEmpty, AppDemoSceneAnimSkinnedMass2, AppDemoSceneAnimSkinnedMass, AppDemoSceneAnimSkinned, AppDemoSceneAnimNodeMass2, AppDemoSceneAnimNodeMass, AppDemoSceneAnimNode, and AppDemoScene2Dand3DText.

Definition at line 63 of file SLScene.h.

{}

root2D() [1/2]

SLNode* SLScene::root2D ( )

inline

Definition at line 100 of file SLScene.h.

{ return _root2D; }

root2D() [2/2]

void SLScene::root2D ( SLNode *  root2D )

inline

Definition at line 90 of file SLScene.h.

{ _root2D = root2D; }

root3D() [1/2]

SLNode* SLScene::root3D ( )

inline

Definition at line 99 of file SLScene.h.

{ return _root3D; }

root3D() [2/2]

void SLScene::root3D ( SLNode *  root3D )

inline

Definition at line 78 of file SLScene.h.

    {
        _root3D = root3D;
 
#ifdef SL_USE_ENTITIES
        SLint rootEntityID = SLScene::entities.getEntityID(root3D);
        if (rootEntityID == INT32_MIN && root3D)
            SLScene::entities.addChildEntity(-1, SLEntity(root3D));
        else if (rootEntityID > -1)
            SL_EXIT_MSG("Root node exists already with another ID among the entities");
#endif
    }

selectedMeshes()

SLVMesh& SLScene::selectedMeshes ( )

inline

Definition at line 125 of file SLScene.h.

{ return _selectedMeshes; }

selectedNodes()

SLVNode& SLScene::selectedNodes ( )

inline

Definition at line 124 of file SLScene.h.

{ return _selectedNodes; }

selectNodeMesh()

void SLScene::selectNodeMesh	(	SLNode *	nodeToSelect,
		SLMesh *	meshToSelect
	)

Handles the full mesh selection from double-clicks.

There are two different selection modes: Full or partial mesh selection.
The full selection is done by double-clicking a mesh. Multiple meshes can be selected with SHIFT-double-clicking. The full selection is handled in SLScene::selectNodeMesh. The selected nodes are stored in SLScene::_selectedNodes and the fully or partially selected meshes are stored in SLScene::_selectedMeshes. The SLNode::isSelected and SLMesh::isSelected show if a node or mesh is selected. A node can be selected with or without a mesh. If a mesh is selected, its node is always also selected. A node without mesh can only be selected in the scenegraph window. To avoid a node from selection you can set its drawing bit SL_DB_NOTSELECTABLE. You should transform a node or mesh and show the properties of a node or mesh if only a single node and single full mesh is selected. To get them call SLScene::singleNodeSelected() or SLScene::singleMeshFullSelected().
For partial mesh selection see SLMesh::handleRectangleSelection.

Definition at line 234 of file SLScene.cpp.

{
    // Case 1: Both are nullptr, so unselect all
    if (!nodeToSelect && !meshToSelect)
    {
        deselectAllNodesAndMeshes();
        return;
    }
 
    if (nodeToSelect && nodeToSelect->drawBit(SL_DB_NOTSELECTABLE))
    {
        SL_LOG("Node is not selectable: %s", nodeToSelect->name().c_str());
        return;
    }
 
    // Case 2: mesh without node selected: This is not allowed
    if (!nodeToSelect && meshToSelect)
        SL_EXIT_MSG("SLScene::selectNodeMesh: No node or mesh to select.");
 
    // Search in _selectedNodes vector
    auto foundNode = find(_selectedNodes.begin(),
                          _selectedNodes.end(),
                          nodeToSelect);
 
    // Case 3: Node without mesh selected
    if (nodeToSelect && !meshToSelect)
    {
        if (foundNode == _selectedNodes.end())
        {
            nodeToSelect->isSelected(true);
            _selectedNodes.push_back(nodeToSelect);
        }
        return;
    }
 
    // Search in _selectedMeshes vector
    auto foundMesh = find(_selectedMeshes.begin(),
                          _selectedMeshes.end(),
                          meshToSelect);
 
    // Case 4: nodeToSelect and meshToSelect are not yet selected: so we select them
    if (foundNode == _selectedNodes.end() && foundMesh == _selectedMeshes.end())
    {
        nodeToSelect->isSelected(true);
        _selectedNodes.push_back(nodeToSelect);
        meshToSelect->isSelected(true);
        meshToSelect->deselectPartialSelection();
        _selectedMeshes.push_back(meshToSelect);
        return;
    }
 
    // Case 5: nodeToSelect is already selected but not the mesh: So select only the mesh
    if (*foundNode == nodeToSelect && foundMesh == _selectedMeshes.end())
    {
        nodeToSelect->isSelected(true);
        meshToSelect->isSelected(true);
        meshToSelect->deselectPartialSelection();
        _selectedMeshes.push_back(meshToSelect);
        return;
    }
 
    // Case 6: nodeToSelect is not selected but the mesh is selected (from another node)
    if (foundNode == _selectedNodes.end() && *foundMesh == meshToSelect)
    {
        nodeToSelect->isSelected(true);
        _selectedNodes.push_back(nodeToSelect);
        meshToSelect->isSelected(true);
        meshToSelect->deselectPartialSelection();
        _selectedMeshes.push_back(meshToSelect);
        return;
    }
 
    // Case 7: Both are already selected, so we unselect them.
    if (nodeToSelect && *foundNode == nodeToSelect && *foundMesh == meshToSelect)
    {
        // Check if other mesh from same node is selected
        bool otherMeshIsSelected = false;
 
        SLMesh* nm = nodeToSelect->mesh();
        for (auto sm : _selectedMeshes)
        {
            if (nm == sm && nm != meshToSelect)
            {
                otherMeshIsSelected = true;
                goto endLoop;
            }
        }
 
    endLoop:
        if (!otherMeshIsSelected)
        {
            nodeToSelect->isSelected(false);
            _selectedNodes.erase(foundNode);
        }
        meshToSelect->deselectPartialSelection();
        meshToSelect->isSelected(false);
        _selectedMeshes.erase(foundMesh);
        return;
    }
 
    SL_EXIT_MSG("SLScene::selectNodeMesh: We should not get here.");
}

singleMeshFullSelected()

SLMesh* SLScene::singleMeshFullSelected ( )

inline

Returns the node if only one is selected. See also SLMesh::selectNodeMesh.

Definition at line 119 of file SLScene.h.

                                      { return (_selectedNodes.size() == 1 &&
                                               _selectedMeshes.size() == 1 &&
                                               _selectedMeshes[0]->IS32.empty())
                                                 ? _selectedMeshes[0]
                                                 : nullptr; }

singleNodeSelected()

SLNode* SLScene::singleNodeSelected ( )

inline

Returns the node if only one is selected. See also SLMesh::selectNodeMesh.

Definition at line 116 of file SLScene.h.

{ return _selectedNodes.size() == 1 ? _selectedNodes[0] : nullptr; }

skybox() [1/2]

SLSkybox* SLScene::skybox ( )

inline

Definition at line 101 of file SLScene.h.

{ return _skybox; }

skybox() [2/2]

void SLScene::skybox ( SLSkybox *  skybox )

inline

Definition at line 91 of file SLScene.h.

{ _skybox = skybox; }

stopAnimations() [1/2]

SLbool SLScene::stopAnimations ( ) const

inline

Definition at line 127 of file SLScene.h.

{ return _stopAnimations; }

stopAnimations() [2/2]

void SLScene::stopAnimations ( SLbool  stop )

inline

Definition at line 92 of file SLScene.h.

{ _stopAnimations = stop; }

unInit()

void SLScene::unInit ( )

virtual

The scene uninitializing clears the scenegraph (_root3D) and all global global resources such as materials, textures & custom shaders loaded with the scene. The standard shaders, the fonts and the 2D-GUI elements remain. They are destructed at process end.

Definition at line 97 of file SLScene.cpp.

{
    // delete entire scene graph
    delete _root3D;
    _root3D = nullptr;
    delete _root2D;
    _root2D = nullptr;
    _skybox = nullptr;
 
    // clear light pointers
    _lights.clear();
 
    _eventHandlers.clear();
    _animManager.clear();
 
    _selectedMeshes.clear();
    _selectedNodes.clear();
}

updateAABBTimesMS()

AvgFloat& SLScene::updateAABBTimesMS ( )

inline

Definition at line 112 of file SLScene.h.

{ return _updateAABBTimesMS; }

updateAnimTimesMS()

AvgFloat& SLScene::updateAnimTimesMS ( )

inline

Definition at line 111 of file SLScene.h.

{ return _updateAnimTimesMS; }

updateDODTimesMS()

AvgFloat& SLScene::updateDODTimesMS ( )

inline

Definition at line 113 of file SLScene.h.

{ return _updateDODTimesMS; }

updateTimesMS()

AvgFloat& SLScene::updateTimesMS ( )

inline

Definition at line 110 of file SLScene.h.

{ return _updateTimesMS; }

Friends And Related Function Documentation

SLNode

friend class SLNode

friend

Definition at line 48 of file SLScene.h.

Member Data Documentation

_animManager

SLAnimManager SLScene::_animManager

protected

Animation manager instance.

Definition at line 149 of file SLScene.h.

_assetManager

SLAssetManager* SLScene::_assetManager

protected

Pointer to the external assetManager.

Definition at line 150 of file SLScene.h.

_eventHandlers

SLVEventHandler SLScene::_eventHandlers

protected

Vector of all event handler.

Definition at line 148 of file SLScene.h.

_fps

SLfloat SLScene::_fps

protected

Averaged no. of frames per second.

Definition at line 162 of file SLScene.h.

_frameTimeMS

SLfloat SLScene::_frameTimeMS

protected

Last frame time in ms.

Definition at line 160 of file SLScene.h.

_frameTimesMS

AvgFloat SLScene::_frameTimesMS

protected

Averaged total time per frame in ms.

Definition at line 165 of file SLScene.h.

_info

SLstring SLScene::_info

protected

scene info string

Definition at line 155 of file SLScene.h.

_lastUpdateTimeMS

SLfloat SLScene::_lastUpdateTimeMS

protected

Last time after update in ms.

Definition at line 161 of file SLScene.h.

_lights

SLVLight SLScene::_lights

protected

Vector of all lights.

Definition at line 147 of file SLScene.h.

_loadTimeMS

SLfloat SLScene::_loadTimeMS

protected

time to load scene in ms

Definition at line 159 of file SLScene.h.

_oculus

std::unique_ptr<SLGLOculus> SLScene::_oculus

protected

Oculus Rift interface.

Definition at line 173 of file SLScene.h.

_root2D

SLNode* SLScene::_root2D

protected

Root node for 2D scene displayed in ortho projection.

Definition at line 153 of file SLScene.h.

_root3D

SLNode* SLScene::_root3D

protected

Root node for 3D scene.

Definition at line 152 of file SLScene.h.

_selectedMeshes

SLVMesh SLScene::_selectedMeshes

protected

Vector of selected meshes. See SLMesh::selectNodeMesh.

Definition at line 157 of file SLScene.h.

_selectedNodes

SLVNode SLScene::_selectedNodes

protected

Vector of selected nodes. See SLMesh::selectNodeMesh.

Definition at line 156 of file SLScene.h.

_skybox

SLSkybox* SLScene::_skybox

protected

pointer to skybox

Definition at line 154 of file SLScene.h.

_stopAnimations

SLbool SLScene::_stopAnimations

protected

Global flag for stopping all animations.

Definition at line 171 of file SLScene.h.

_updateAABBTimesMS

AvgFloat SLScene::_updateAABBTimesMS

protected

Averaged time for update the nodes AABB in ms.

Definition at line 167 of file SLScene.h.

_updateAnimTimesMS

AvgFloat SLScene::_updateAnimTimesMS

protected

Averaged time for update the animations in ms.

Definition at line 168 of file SLScene.h.

_updateDODTimesMS

AvgFloat SLScene::_updateDODTimesMS

protected

Averaged time for update the SLEntities graph.

Definition at line 169 of file SLScene.h.

_updateTimesMS

AvgFloat SLScene::_updateTimesMS

protected

Averaged time for update in ms.

Definition at line 166 of file SLScene.h.

---

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

• SLScene.h
• SLScene.cpp