Scene engine/physics connector. More...

#include <tdme/engine/SceneConnector.h>

Collaboration diagram for SceneConnector:

Static Public Member Functions
static float	getRenderGroupsPartitionWidth ()

static void	setRenderGroupsPartitionWidth (float renderNodesPartitionWidth)
	Set render groups partition size / width. More...

static float	getRenderGroupsPartitionHeight ()

static void	setRenderGroupsPartitionHeight (float renderNodesPartitionHeight)
	Set render groups partition size / height. More...

static float	getRenderGroupsPartitionDepth ()

static void	setRenderGroupsPartitionDepth (float renderNodesPartitionDepth)
	Set render groups partition size / depth. More...

static void	setRenderGroupsReduceBy (int reduceBy)
	Set render groups reduce objects by a given factor. More...

static int	getRenderGroupsReduceBy ()

static int	getRenderGroupsLodLevels ()

static void	setRenderGroupsLodLevels (int lodLevels)
	Set render groups LOD levels. More...

static float	getRenderGroupsLod2MinDistance ()

static void	setRenderGroupsLod2MinDistance (float minDistance)
	Set render groups LOD2 minumum distance. More...

static float	getRenderGroupsLod3MinDistance ()

static void	setRenderGroupsLod3MinDistance (float minDistance)
	Set render groups LOD3 minumum distance. More...

static int	getRenderGroupsLod2ReduceBy ()

static void	setRenderGroupsLod2ReduceBy (int reduceBy)
	Set render groups LOD2 reduce by factor. More...

static int	getRenderGroupsLod3ReduceBy ()

static void	setRenderGroupsLod3ReduceBy (int reduceBy)
	Set render groups LOD3 reduce by factor. More...

static bool	isEnableEarlyZRejection ()

static void	setEnableEarlyZRejection (bool enableEarlyZRejection)
	Enable/disable early z rejection, in scene loading case its used for render groups and terrain. More...

static void	setLights (Engine engine, Scene scene, const Vector3 &translation=Vector3(0.0f, 0.0f, 0.0f))
	Set lights from scene. More...

static Entity *	createParticleSystem (PrototypeParticleSystem *particleSystem, const string &id, bool enableDynamicShadows=true)
	Create particle system. More...

static Entity *	createEmpty (const string &id, const Transformations &transformations)
	Create engine entity. More...

static Entity *	createEntity (Prototype prototype, const string &id, const Transformations &transformations, int instances=1, Entity parentEntity=nullptr)
	Create engine entity. More...

static Entity *	createEntity (SceneEntity sceneEntity, const Vector3 &translation=Vector3(0.0f, 0.0f, 0.0f), int instances=1, Entity parentEntity=nullptr)
	Create engine entity. More...

static void	addScene (Engine engine, Scene scene, bool addEmpties, bool addTrigger, bool addEnvironmentMapping, bool pickable, bool enable=true, const Vector3 &translation=Vector3(0.0f, 0.0f, 0.0f), ProgressCallback *progressCallback=nullptr)
	Add scene to engine. More...

static Body *	createBody (World world, Prototype prototype, const string &id, const Transformations &transformations, uint16_t collisionTypeId=0, int index=-1, PrototypePhysics_BodyType *overrideType=nullptr)
	Create rigid body. More...

static Body *	createBody (World world, SceneEntity sceneEntity, const Vector3 &translation=Vector3(0.0f, 0.0f, 0.0f), uint16_t collisionTypeId=0, int index=-1, PrototypePhysics_BodyType *overrideType=nullptr)
	Create rigid body. More...

static void	addScene (World world, Scene scene, bool enable=true, const Vector3 &translation=Vector3(0.0f, 0.0f, 0.0f), ProgressCallback *progressCallback=nullptr)
	Add scene to physics world. More...

static void	disableScene (Engine engine, Scene scene)
	Disable scene in engine. More...

static void	disableScene (World world, Scene scene)
	Disable scene in physics world. More...

static void	enableScene (Engine engine, Scene scene, const Vector3 &translation=Vector3(0.0f, 0.0f, 0.0f))
	Enable disabled scene in engine. More...

static void	enableScene (World world, Scene scene, const Vector3 &translation=Vector3(0.0f, 0.0f, 0.0f))
	Enable disabled scene in physics world. More...

static void	resetEngine (Engine engine, Scene scene)
	Reset engine regarding given scene. More...

static void	addSounds (Audio audio, Prototype prototype, const string &id, const int poolSize=1)
	Add scene entity sounds into given audio instance associated with given id. More...

Static Public Attributes
static constexpr int32_t	RIGIDBODY_TYPEID_STATIC { 1 }

static constexpr int32_t	RIGIDBODY_TYPEID_DYNAMIC { 2 }

static constexpr int32_t	RIGIDBODY_TYPEID_COLLISION { 4 }

static constexpr int32_t	RIGIDBODY_TYPEID_TRIGGER { 8 }

static STATIC_DLL_IMPEXT float	renderGroupsPartitionWidth = 64.0f

static STATIC_DLL_IMPEXT float	renderGroupsPartitionHeight = 64.0f

static STATIC_DLL_IMPEXT float	renderGroupsPartitionDepth = 64.0f

static STATIC_DLL_IMPEXT int	renderGroupsReduceBy = 1

static STATIC_DLL_IMPEXT int	renderGroupsLODLevels = 3

static STATIC_DLL_IMPEXT float	renderGroupsLOD2MinDistance = 25.0

static STATIC_DLL_IMPEXT float	renderGroupsLOD3MinDistance = 50.0

static STATIC_DLL_IMPEXT int	renderGroupsLOD2ReduceBy = 4

static STATIC_DLL_IMPEXT int	renderGroupsLOD3ReduceBy = 16

static STATIC_DLL_IMPEXT bool	enableEarlyZRejection = false

Static Private Attributes
static STATIC_DLL_IMPEXT Model *	emptyModel = nullptr

Detailed Description

Scene engine/physics connector.

Author: Andreas Drewke

Version: $Id$

Definition at line 36 of file SceneConnector.h.

Member Function Documentation

◆ addScene() [1/2]

void addScene	(	Engine *	engine,
		Scene *	scene,
		bool	addEmpties,
		bool	addTrigger,
		bool	addEnvironmentMapping,
		bool	pickable,
		bool	enable = `true`,
		const Vector3 &	translation = `Vector3(0.0f, 0.0f, 0.0f)`,
		ProgressCallback *	progressCallback = `nullptr`
	)

static

Add scene to engine.

Parameters

engine	engine
scene	scene
addEmpties	add empties
addTrigger	add trigger
addEnvironmentMapping	add environment mapping
pickable	pickable
enable	enable
translation	translation
progressCallback	progress callback

Definition at line 504 of file SceneConnector.cpp.

◆ addScene() [2/2]

void addScene	(	World *	world,
		Scene *	scene,
		bool	enable = `true`,
		const Vector3 &	translation = `Vector3(0.0f, 0.0f, 0.0f)`,
		ProgressCallback *	progressCallback = `nullptr`
	)

static

Add scene to physics world.

Parameters

world	world
scene	scene
enable	enable
translation	translation
progressCallback	progress callback

Definition at line 914 of file SceneConnector.cpp.

◆ addSounds()

void addSounds	(	Audio *	audio,
		Prototype *	prototype,
		const string &	id,
		const int	poolSize = `1`
	)

static

Add scene entity sounds into given audio instance associated with given id.

Parameters

audio	audio instance to load sounds into
prototype	scene entity
id	audio entity id
poolSize	pool size, which is optional if you want to use a pool for each sound

Definition at line 1262 of file SceneConnector.cpp.

◆ createBody() [1/2]

Body * createBody	(	World *	world,
		Prototype *	prototype,
		const string &	id,
		const Transformations &	transformations,
		uint16_t	collisionTypeId = `0`,
		int	index = `-1`,
		PrototypePhysics_BodyType *	overrideType = `nullptr`
	)

static

Create rigid body.

Parameters

world	world
prototype	prototype
id	id
transformations	transformations
collisionTypeId	collision type id or 0 for default
index	use a optional index or all bounding volumes
overrideType	override physics type if required

Returns: rigid body

Definition at line 806 of file SceneConnector.cpp.

◆ createBody() [2/2]

Body * createBody	(	World *	world,
		SceneEntity *	sceneEntity,
		const Vector3 &	translation = `Vector3(0.0f, 0.0f, 0.0f)`,
		uint16_t	collisionTypeId = `0`,
		int	index = `-1`,
		PrototypePhysics_BodyType *	overrideType = `nullptr`
	)

static

Create rigid body.

Parameters

world	world
sceneEntity	scene entity
translation	translation
collisionTypeId	collision type id or 0 for default
index	use a optional index or all bounding volumes
overrideType	override physics type if required

Returns: rigid body

Definition at line 904 of file SceneConnector.cpp.

◆ createEmpty()

Entity * createEmpty	(	const string &	id,
		const Transformations &	transformations
	)

static

Create engine entity.

Parameters

id	id
transformations	transformations

Returns: entity

Definition at line 306 of file SceneConnector.cpp.

◆ createEntity() [1/2]

Entity * createEntity	(	Prototype *	prototype,
		const string &	id,
		const Transformations &	transformations,
		int	instances = `1`,
		Entity *	parentEntity = `nullptr`
	)

static

Create engine entity.

Parameters

prototype	prototype
id	id
transformations	transformations
instances	instances which applies only for skinned objects
parentEntity	parent entity

Returns: entity

Definition at line 318 of file SceneConnector.cpp.

◆ createEntity() [2/2]

Entity * createEntity	(	SceneEntity *	sceneEntity,
		const Vector3 &	translation = `Vector3(0.0f, 0.0f, 0.0f)`,
		int	instances = `1`,
		Entity *	parentEntity = `nullptr`
	)

static

Create engine entity.

Parameters

sceneEntity	scene object
translation	translation
instances	instances which applies only for skinned objects
parentEntity	parent entity

Returns: entity

Definition at line 494 of file SceneConnector.cpp.

◆ createParticleSystem()

Entity * createParticleSystem	(	PrototypeParticleSystem *	particleSystem,
		const string &	id,
		bool	enableDynamicShadows = `true`
	)

static

Create particle system.

Parameters

particleSystem	prototype particle system
id	id
enableDynamicShadows	enable dynamic shadows

Returns: engine particle system entity

Definition at line 205 of file SceneConnector.cpp.

◆ disableScene() [1/2]

void disableScene	(	Engine *	engine,
		Scene *	scene
	)

static

Disable scene in engine.

Parameters

engine	engine
scene	scene

Definition at line 1019 of file SceneConnector.cpp.

◆ disableScene() [2/2]

void disableScene	(	World *	world,
		Scene *	scene
	)

static

Disable scene in physics world.

Parameters

world	world
scene	scene

Definition at line 1083 of file SceneConnector.cpp.

◆ enableScene() [1/2]

void enableScene	(	Engine *	engine,
		Scene *	scene,
		const Vector3 &	translation = `Vector3(0.0f, 0.0f, 0.0f)`
	)

static

Enable disabled scene in engine.

Parameters

engine	engine
scene	scene
translation	translation

Definition at line 1121 of file SceneConnector.cpp.

◆ enableScene() [2/2]

void enableScene	(	World *	world,
		Scene *	scene,
		const Vector3 &	translation = `Vector3(0.0f, 0.0f, 0.0f)`
	)

static

Enable disabled scene in physics world.

Parameters

world	world
scene	scene
translation	translation

Definition at line 1191 of file SceneConnector.cpp.

◆ getRenderGroupsLod2MinDistance()

static float getRenderGroupsLod2MinDistance ( )

inlinestatic

Returns: render groups LOD2 minumum distance

Definition at line 136 of file SceneConnector.h.

◆ getRenderGroupsLod2ReduceBy()

static int getRenderGroupsLod2ReduceBy ( )

inlinestatic

Returns: render groups LOD2 reduce by factor

Definition at line 166 of file SceneConnector.h.

◆ getRenderGroupsLod3MinDistance()

static float getRenderGroupsLod3MinDistance ( )

inlinestatic

Returns: render groups LOD3 minumum distance

Definition at line 151 of file SceneConnector.h.

◆ getRenderGroupsLod3ReduceBy()

static int getRenderGroupsLod3ReduceBy ( )

inlinestatic

Returns: render groups LOD3 reduce by factor

Definition at line 181 of file SceneConnector.h.

◆ getRenderGroupsLodLevels()

static int getRenderGroupsLodLevels ( )

inlinestatic

Returns: render groups LOD levels

Definition at line 121 of file SceneConnector.h.

◆ getRenderGroupsPartitionDepth()

static float getRenderGroupsPartitionDepth ( )

inlinestatic

Returns: render groups partition size / depth

Definition at line 91 of file SceneConnector.h.

◆ getRenderGroupsPartitionHeight()

static float getRenderGroupsPartitionHeight ( )

inlinestatic

Returns: render groups partition size / height

Definition at line 76 of file SceneConnector.h.

◆ getRenderGroupsPartitionWidth()

static float getRenderGroupsPartitionWidth ( )

inlinestatic

Returns: render groups partition size / width

Definition at line 61 of file SceneConnector.h.

◆ getRenderGroupsReduceBy()

static int getRenderGroupsReduceBy ( )

inlinestatic

Returns: render groups objects reduce by factor

Definition at line 114 of file SceneConnector.h.

◆ isEnableEarlyZRejection()

static bool isEnableEarlyZRejection ( )

inlinestatic

Returns: If early z rejection is enabled, in scene loading case its used for render groups and terrain

Definition at line 196 of file SceneConnector.h.

◆ resetEngine()

void resetEngine	(	Engine *	engine,
		Scene *	scene
	)

static

Reset engine regarding given scene.

Parameters

engine	engine
scene	scene

Definition at line 1237 of file SceneConnector.cpp.

◆ setEnableEarlyZRejection()

static void setEnableEarlyZRejection ( bool enableEarlyZRejection )

inlinestatic

Enable/disable early z rejection, in scene loading case its used for render groups and terrain.

Parameters

enableEarlyZRejection enable early z rejection

Definition at line 204 of file SceneConnector.h.

◆ setLights()

void setLights	(	Engine *	engine,
		Scene *	scene,
		const Vector3 &	translation = `Vector3(0.0f, 0.0f, 0.0f)`
	)

static

Set lights from scene.

Parameters

engine	engine
scene	scene
translation	translation

Definition at line 177 of file SceneConnector.cpp.

◆ setRenderGroupsLod2MinDistance()

static void setRenderGroupsLod2MinDistance ( float minDistance )

inlinestatic

Set render groups LOD2 minumum distance.

Parameters

minDistance render groups LOD2 minumum distance

Definition at line 144 of file SceneConnector.h.

◆ setRenderGroupsLod2ReduceBy()

static void setRenderGroupsLod2ReduceBy ( int reduceBy )

inlinestatic

Set render groups LOD2 reduce by factor.

Parameters

reduceBy render groups LOD2 reduce by factor

Definition at line 174 of file SceneConnector.h.

◆ setRenderGroupsLod3MinDistance()

static void setRenderGroupsLod3MinDistance ( float minDistance )

inlinestatic

Set render groups LOD3 minumum distance.

Parameters

minDistance render groups LOD3 minumum distance

Definition at line 159 of file SceneConnector.h.

◆ setRenderGroupsLod3ReduceBy()

static void setRenderGroupsLod3ReduceBy ( int reduceBy )

inlinestatic

Set render groups LOD3 reduce by factor.

Parameters

reduceBy render groups LOD3 reduce by factor

Definition at line 189 of file SceneConnector.h.

◆ setRenderGroupsLodLevels()

static void setRenderGroupsLodLevels ( int lodLevels )

inlinestatic

Set render groups LOD levels.

Parameters

lodLevels render groups LOD levels

Definition at line 129 of file SceneConnector.h.

◆ setRenderGroupsPartitionDepth()

static void setRenderGroupsPartitionDepth ( float renderNodesPartitionDepth )

inlinestatic

Set render groups partition size / depth.

Parameters

renderNodesPartitionDepth render groups partition size / depth

Definition at line 99 of file SceneConnector.h.

◆ setRenderGroupsPartitionHeight()

static void setRenderGroupsPartitionHeight ( float renderNodesPartitionHeight )

inlinestatic

Set render groups partition size / height.

Parameters

renderNodesPartitionDepth render groups partition size / height

Definition at line 84 of file SceneConnector.h.

◆ setRenderGroupsPartitionWidth()

static void setRenderGroupsPartitionWidth ( float renderNodesPartitionWidth )

inlinestatic

Set render groups partition size / width.

Parameters

renderNodesPartitionDepth render groups partition size / width

Definition at line 69 of file SceneConnector.h.

◆ setRenderGroupsReduceBy()

static void setRenderGroupsReduceBy ( int reduceBy )

inlinestatic

Set render groups reduce objects by a given factor.

Parameters

reduceBy render groups objects reduce by factor

Definition at line 107 of file SceneConnector.h.

Member Data Documentation

◆ emptyModel

Model * emptyModel = nullptr

staticprivate

Definition at line 350 of file SceneConnector.h.

◆ enableEarlyZRejection

bool enableEarlyZRejection = false

static

Definition at line 54 of file SceneConnector.h.

◆ renderGroupsLOD2MinDistance

float renderGroupsLOD2MinDistance = 25.0

static

Definition at line 50 of file SceneConnector.h.

◆ renderGroupsLOD2ReduceBy

int renderGroupsLOD2ReduceBy = 4

static

Definition at line 52 of file SceneConnector.h.

◆ renderGroupsLOD3MinDistance

float renderGroupsLOD3MinDistance = 50.0

static

Definition at line 51 of file SceneConnector.h.

◆ renderGroupsLOD3ReduceBy

int renderGroupsLOD3ReduceBy = 16

static

Definition at line 53 of file SceneConnector.h.

◆ renderGroupsLODLevels

int renderGroupsLODLevels = 3

static

Definition at line 49 of file SceneConnector.h.

◆ renderGroupsPartitionDepth

float renderGroupsPartitionDepth = 64.0f

static

Definition at line 47 of file SceneConnector.h.

◆ renderGroupsPartitionHeight

float renderGroupsPartitionHeight = 64.0f

static

Definition at line 46 of file SceneConnector.h.

◆ renderGroupsPartitionWidth

float renderGroupsPartitionWidth = 64.0f

static

Definition at line 45 of file SceneConnector.h.

◆ renderGroupsReduceBy

int renderGroupsReduceBy = 1

static

Definition at line 48 of file SceneConnector.h.

◆ RIGIDBODY_TYPEID_COLLISION

constexpr int32_t RIGIDBODY_TYPEID_COLLISION { 4 }

staticconstexpr

Definition at line 42 of file SceneConnector.h.

◆ RIGIDBODY_TYPEID_DYNAMIC

constexpr int32_t RIGIDBODY_TYPEID_DYNAMIC { 2 }

staticconstexpr

Definition at line 41 of file SceneConnector.h.

◆ RIGIDBODY_TYPEID_STATIC

constexpr int32_t RIGIDBODY_TYPEID_STATIC { 1 }

staticconstexpr

Definition at line 40 of file SceneConnector.h.

◆ RIGIDBODY_TYPEID_TRIGGER

constexpr int32_t RIGIDBODY_TYPEID_TRIGGER { 8 }

staticconstexpr

Definition at line 43 of file SceneConnector.h.

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

/home/andreas/Development/drewke.net/tdme2/src/tdme/engine/SceneConnector.h
/home/andreas/Development/drewke.net/tdme2/src/tdme/engine/SceneConnector.cpp

Static Public Member Functions

Static Public Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ addScene() [1/2]

◆ addScene() [2/2]

◆ addSounds()

◆ createBody() [1/2]

◆ createBody() [2/2]

◆ createEmpty()

◆ createEntity() [1/2]

◆ createEntity() [2/2]

◆ createParticleSystem()

◆ disableScene() [1/2]

◆ disableScene() [2/2]

◆ enableScene() [1/2]

◆ enableScene() [2/2]

◆ getRenderGroupsLod2MinDistance()

◆ getRenderGroupsLod2ReduceBy()

◆ getRenderGroupsLod3MinDistance()

◆ getRenderGroupsLod3ReduceBy()

◆ getRenderGroupsLodLevels()

◆ getRenderGroupsPartitionDepth()

◆ getRenderGroupsPartitionHeight()

◆ getRenderGroupsPartitionWidth()

◆ getRenderGroupsReduceBy()

◆ isEnableEarlyZRejection()

◆ resetEngine()

◆ setEnableEarlyZRejection()

◆ setLights()

◆ setRenderGroupsLod2MinDistance()

◆ setRenderGroupsLod2ReduceBy()

◆ setRenderGroupsLod3MinDistance()

◆ setRenderGroupsLod3ReduceBy()

◆ setRenderGroupsLodLevels()

◆ setRenderGroupsPartitionDepth()

◆ setRenderGroupsPartitionHeight()

◆ setRenderGroupsPartitionWidth()

◆ setRenderGroupsReduceBy()

Member Data Documentation

◆ emptyModel

◆ enableEarlyZRejection

◆ renderGroupsLOD2MinDistance

◆ renderGroupsLOD2ReduceBy

◆ renderGroupsLOD3MinDistance

◆ renderGroupsLOD3ReduceBy

◆ renderGroupsLODLevels

◆ renderGroupsPartitionDepth

◆ renderGroupsPartitionHeight

◆ renderGroupsPartitionWidth

◆ renderGroupsReduceBy

◆ RIGIDBODY_TYPEID_COLLISION

◆ RIGIDBODY_TYPEID_DYNAMIC

◆ RIGIDBODY_TYPEID_STATIC

◆ RIGIDBODY_TYPEID_TRIGGER