Skylicht::CScene Class Reference

This object class manages all other objects, it represents the data of a scene. More...

#include <Scene/CScene.h>

Inheritance diagram for Skylicht::CScene:

Public Member Functions
void	releaseScene ()
void	setName (const wchar_t *lpName)
void	setName (const char *lpName)
const char *	getNameA ()
const wchar_t *	getName ()
void	setVisibleAllZone (bool b)
void	updateAddRemoveObject ()
void	updateIndexSearchObject ()
virtual CGameObject *	searchObjectInChild (const wchar_t *name)
virtual CGameObject *	searchObjectInChildByID (const char *id)
virtual CEntity *	searchEntityInChildByID (const char *id)
u32	searchObjectByCullingLayer (ArrayGameObject &result, u32 mask)
virtual CZone *	createZone ()
virtual void	removeZone (CGameObject *zone)
CEntityManager *	getEntityManager ()
int	getZoneCount ()
CZone *	getZone (int i)
ArrayZone *	getAllZone ()
void	bringToNext (CZone *object, CZone *target, bool behind)
CZone *	getZoneBefore (CZone *object)
void	registerEvent (const char *name, IEventReceiver *pEvent)
void	unRegisterEvent (IEventReceiver *pEvent)
virtual bool	OnEvent (const SEvent &event)
	Called if an event happened.
virtual void	update ()
CObjectSerializable *	createSerializable ()
void	loadSerializable (CObjectSerializable *object)
Public Member Functions inherited from irr::IEventReceiver
virtual	~IEventReceiver ()
	Destructor.

Protected Types
typedef std::pair< std::string, IEventReceiver * >	eventType

Protected Attributes
std::wstring	m_name
std::string	m_namec
ArrayZone	m_zones
CEntityManager *	m_entityManager
std::vector< eventType >	m_eventReceivers

Detailed Description

This object class manages all other objects, it represents the data of a scene.

A scene can be constructed programmatically, or you can use an Skylicht-Editor to create and arrange objects.

The image shows a scene built with Skylicht-Editor.

When a scene is created in the editor and saved as a .scene file, you can use CSceneImporter to load all the data back into CScene.

CScene* scene = new CScene();
 
// declare component used in scene
// see: SampleScene/Demo.txt
USE_COMPONENT(CBoxCollider);
USE_COMPONENT(CCube);
USE_COMPONENT(CDirectionalLight);
USE_COMPONENT(CIndirectLighting);
USE_COMPONENT(CLightProbes);
USE_COMPONENT(CPlane);
USE_COMPONENT(CReflectionProbe);
USE_COMPONENT(CRenderMesh);
USE_COMPONENT(CRigidbody);
USE_COMPONENT(CSkySun);
USE_COMPONENT(CStaticPlaneCollider);
USE_COMPONENT(CTransformEuler);
...
 
CSceneImporter::beginImportScene(scene, "SampleScene/Demo.scene");
 
bool finished = false;
char log[512];
do
{
    finished = CSceneImporter::updateLoadScene())
    sprintf(log, "Loading: %d%%", (int)(CSceneImporter::getLoadingPercent() * 100.0f));
    os::Printer::log(log);
}
while (!finished);

Additionally, in some cases, you can manually create a scene using code, as shown below:

CScene *scene = new CScene();
CZone *zone = scene->createZone();
 
// Example add canvas
CGameObject* guiObj = zone->createEmptyObject();
CCanvas* canvas = guiObj->addComponent<CCanvas>();
 
// Example add camera
CGameObject* camObj = zone->createEmptyObject();
camObj->addComponent<CCamera>();
camObj->addComponent<CEditorCamera>()->setMoveSpeed(2.0f);
camObj->addComponent<CFpsMoveCamera>()->setMoveSpeed(1.0f);
 
// call update method for all objects
scene->update();

See also

CGameObject, CContainerObject, CZone, CSceneImporter

To render the scene to screen, you first need to set up the Render Pipeline, and then call render method from the Pipeline.

See also

CShadowMapRP, CDeferredRP, CForwardRP, CPostProcessorRP

Member Function Documentation

OnEvent()

virtual bool Skylicht::CScene::OnEvent ( const SEvent & event )

virtual

Called if an event happened.

Please take care that you should only return 'true' when you want to prevent Irrlicht from processing the event any further. So 'true' does mean that an event is completely done. Therefore your return value for all unprocessed events should be 'false'.

Returns

True if the event was processed.

Implements irr::IEventReceiver.

---

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

• Scene/CScene.h