Object 3D to be used with engine class. More...

#include <tdme/engine/Object3D.h>

Inheritance diagram for Object3D:

Collaboration diagram for Object3D:

Public Member Functions
	Object3D (const string &id, Model *model, int instances)
	Public constructor. More...

	Object3D (const string &id, Model *model)
	Public constructor. More...

void	setNeedsPreRender (bool needsPreRender)
	Set up if this object3d instance needs a preRender() call each frame. More...

EntityType	getEntityType () override

void	setEngine (Engine *engine) override
	Set up engine. More...

void	setRenderer (Renderer *renderer) override
	Set up renderer. More...

void	initialize () override
	Initiates this object 3d. More...

void	dispose () override
	Dispose this object 3d. More...

bool	isEnabled () override

void	setEnabled (bool enabled) override
	Enable/disable rendering. More...

bool	isFrustumCulling () override

void	setFrustumCulling (bool frustumCulling) override
	Set frustum culling. More...

void	fromTransformations (const Transformations &transformations) override
	Set up this transformations from given transformations. More...

void	update () override
	Update transformations. More...

BoundingBox *	getBoundingBox () override

BoundingBox *	getBoundingBoxTransformed () override

const Color4 &	getEffectColorAdd () const override
	The effect color will be added to fragment color. More...

void	setEffectColorAdd (const Color4 &effectColorAdd) override
	Set effect color that will be added to fragment color. More...

const Color4 &	getEffectColorMul () const override
	The effect color will be multiplied with fragment color. More...

void	setEffectColorMul (const Color4 &effectColorMul) override
	Set effect color that will be multiplied with fragment color. More...

const string &	getId () override

bool	isContributesShadows () override

void	setContributesShadows (bool contributesShadows) override
	Enable/disable contributes shadows. More...

bool	isReceivesShadows () override

void	setReceivesShadows (bool receivesShadows) override
	Enable/disable receives shadows. More...

bool	isPickable () override

void	setPickable (bool pickable) override
	Set this object pickable. More...

const Vector3 &	getTranslation () const override

void	setTranslation (const Vector3 &translation) override
	Set translation. More...

const Vector3 &	getScale () const override

void	setScale (const Vector3 &scale) override
	Set scale. More...

const Vector3 &	getPivot () const override

void	setPivot (const Vector3 &pivot) override
	Set pivot. More...

const int	getRotationCount () const override

Rotation &	getRotation (const int idx) override
	Get rotation at given index. More...

void	addRotation (const Vector3 &axis, const float angle) override
	Add rotation. More...

void	removeRotation (const int idx) override
	Remove rotation. More...

const Vector3 &	getRotationAxis (const int idx) const override

void	setRotationAxis (const int idx, const Vector3 &axis) override
	Set rotation axis. More...

const float	getRotationAngle (const int idx) const override

void	setRotationAngle (const int idx, const float angle) override

const Quaternion &	getRotationsQuaternion () const override

const Matrix4x4 &	getTransformationsMatrix () const override

const Transformations &	getTransformations () const override

RenderPass	getRenderPass () const override

void	setRenderPass (RenderPass renderPass) override
	Set render pass. More...

const string &	getShader ()

void	setShader (const string &id)
	Set shader. More...

uint8_t	getUniqueShaderId ()

const string &	getDistanceShader ()

uint8_t	getUniqueDistanceShaderId ()

void	setDistanceShader (const string &id)
	Set distance shader. More...

float	getDistanceShaderDistance ()

void	setDistanceShaderDistance (float distanceShaderDistance)
	Set distance shader distance. More...

const string &	getReflectionEnvironmentMappingId ()

void	setReflectionEnvironmentMappingId (const string &reflectionEnvironmentMappingId)

bool	hasReflectionEnvironmentMappingPosition ()

const Vector3 &	getReflectionEnvironmentMappingPosition ()

void	setReflectionEnvironmentMappingPosition (const Vector3 &reflectionEnvironmentMappingPosition)
	Set reflection environment mapping position. More...

void	unsetReflectionEnvironmentMappingPosition ()
	Unset reflection environment mapping position. More...

Engine::EffectPass	getExcludeFromEffectPass () const

void	setExcludeEffectPass (Engine::EffectPass effectPass)
	Set exclude from effect pass. More...

bool	isEnableEarlyZRejection () const

void	setEnableEarlyZRejection (bool enableEarlyZRejection)
	Enable/disable early z rejection. More...

bool	isDisableDepthTest () const

void	setDisableDepthTest (bool disableDepthTest)
	Set disable depth test. More...

const ShaderParameter	getShaderParameter (const string &parameterName)
	Returns shader parameter for given parameter name, if the value does not exist, the default will be returned. More...

void	setShaderParameter (const string &parameterName, const ShaderParameter &parameterValue)
	Set shader parameter for given parameter name. More...

const ShaderParameter	getDistanceShaderParameter (const string &parameterName)
	Returns distance shader parameter for given parameter name, if the value does not exist, the default will be returned. More...

void	setDistanceShaderParameter (const string &parameterName, const ShaderParameter &parameterValue)
	Set distance shader parameter for given parameter name. More...

Public Member Functions inherited from Object3DInternal
	Object3DInternal (const string &id, Model *model, int instances)
	Public constructor. More...

virtual	~Object3DInternal ()
	Destructor. More...

const string &	getId ()

bool	isEnabled ()

void	setEnabled (bool enabled)
	Enable/disable rendering. More...

bool	isPickable ()

void	setPickable (bool pickable)
	Set this object pickable. More...

bool	isContributesShadows ()

void	setContributesShadows (bool contributesShadows)
	Enable/disable contributes shadows. More...

bool	isReceivesShadows ()

void	setReceivesShadows (bool receivesShadows)
	Enable/disable receives shadows. More...

const Color4 &	getEffectColorMul () const
	The effect color will be multiplied with fragment color. More...

void	setEffectColorMul (const Color4 &effectColorMul)
	The effect color that will be multiplied with fragment color. More...

const Color4 &	getEffectColorAdd () const
	The effect color will be added to fragment color. More...

void	setEffectColorAdd (const Color4 &effectColorAdd)
	The effect color will be added to fragment color. More...

BoundingBox *	getBoundingBox ()

BoundingBox *	getBoundingBoxTransformed ()
	Retrieves bounding sphere with transformations applied. More...

void	bindDiffuseTexture (int32_t textureId, const string &nodeId=string(), const string &facesEntityId=string())
	Bind a texture to a node and faces entity. More...

void	bindDiffuseTexture (FrameBuffer *frameBuffer, const string &nodeId=string(), const string &facesEntityId=string())
	Bind frame buffer color texture to a node and faces entity of this object. More...

void	unbindDiffuseTexture (const string &nodeId=string(), const string &facesEntityId=string())
	Unbind dynamic texture to a node and faces entity of this object. More...

void	setTextureMatrix (const Matrix2D3x3 &textureMatrix, const string &nodeId=string(), const string &facesEntityId=string())
	Set texture matrix. More...

void	initialize () override
	Initiates this object3d. More...

void	dispose () override
	Disposes this object3d. More...

void	fromTransformations (const Transformations &transformations)

void	update ()

void	setNodeTransformationsMatrix (const string &id, const Matrix4x4 &matrix)

void	unsetNodeTransformationsMatrix (const string &id)

Public Member Functions inherited from Object3DBase
Model *	getModel ()

virtual void	computeTransformations (int contextIdx, int64_t lastFrameAtTime, int64_t currentFrameAtTime)
	Pre render step, computes transformations. More...

int	getNodeCount () const

void	getTriangles (vector< Triangle > &triangles, int nodeIdx=-1)
	Retrieves list of triangles of all or given nodes. More...

Object3DBase_TransformedFacesIterator *	getTransformedFacesIterator ()

Object3DNodeMesh *	getMesh (const string &nodeId)
	Returns object3d node mesh object. More...

virtual void	initialize ()
	Initiates this object3d. More...

virtual void	dispose ()
	Disposes this object3d. More...

int	getInstances ()

int	getCurrentInstance ()

void	setCurrentInstance (int currentInstance)
	Set current instance. More...

bool	getInstanceEnabled ()

void	setInstanceEnabled (bool enabled)
	Set current instance enabled. More...

void	setAnimation (const string &id, float speed=1.0f)
	Sets up a base animation to play. More...

void	setAnimationSpeed (float speed)
	Set up animation speed. More...

void	addOverlayAnimation (const string &id)
	Overlays a animation above the base animation. More...

void	removeOverlayAnimation (const string &id)
	Removes a overlay animation. More...

void	removeOverlayAnimationsFinished ()
	Removes all finished overlay animations. More...

void	removeOverlayAnimations ()
	Removes all overlay animations. More...

const string	getAnimation ()

float	getAnimationTime ()
	Returns current base animation time. More...

bool	hasOverlayAnimation (const string &id)
	Returns if there is currently running a overlay animation with given id. More...

float	getOverlayAnimationTime (const string &id)
	Returns current overlay animation time. More...

const Matrix4x4	getNodeTransformationsMatrix (const string &id)
	Returns transformation matrix for given node. More...

void	setNodeTransformationsMatrix (const string &id, const Matrix4x4 &matrix)
	Set transformation matrix for given node. More...

void	unsetNodeTransformationsMatrix (const string &id)
	Unset transformation matrix for given node. More...

const Matrix4x4 &	getTransformationsMatrix () const

Public Member Functions inherited from Entity
virtual EntityType	getEntityType ()=0

virtual void	setEngine (Engine *engine)=0
	Set up engine. More...

virtual void	setRenderer (Renderer *renderer)=0
	Set up renderer. More...

virtual const string &	getId ()=0

virtual bool	isEnabled ()=0

virtual void	setEnabled (bool enabled)=0
	Enable/disable rendering. More...

virtual bool	isFrustumCulling ()=0

virtual void	setFrustumCulling (bool frustumCulling)=0
	Set frustum culling. More...

virtual bool	isPickable ()=0

virtual void	setPickable (bool pickable)=0
	Set this object pickable. More...

virtual bool	isContributesShadows ()=0

virtual void	setContributesShadows (bool contributesShadows)=0
	Enable/disable contributes shadows. More...

virtual bool	isReceivesShadows ()=0

virtual void	setReceivesShadows (bool receivesShadows)=0
	Enable/disable receives shadows. More...

virtual const Color4 &	getEffectColorMul () const =0
	The effect color will be multiplied with fragment color. More...

virtual void	setEffectColorMul (const Color4 &effectColorMul)=0
	Set effect color that will be multiplied with fragment color. More...

virtual const Color4 &	getEffectColorAdd () const =0
	The effect color will be added to fragment color. More...

virtual void	setEffectColorAdd (const Color4 &effectColorAdd)=0
	Set effect color that will be added to fragment color. More...

virtual void	initialize ()=0
	Initiates this object 3d. More...

virtual void	dispose ()=0
	Dispose this object 3d. More...

virtual BoundingBox *	getBoundingBox ()=0

virtual BoundingBox *	getBoundingBoxTransformed ()=0

virtual const Vector3 &	getTranslation () const =0

virtual void	setTranslation (const Vector3 &translation)=0
	Set translation. More...

virtual const Vector3 &	getScale () const =0

virtual void	setScale (const Vector3 &scale)=0
	Set scale. More...

virtual const Vector3 &	getPivot () const =0

virtual void	setPivot (const Vector3 &pivot)=0
	Set pivot. More...

virtual const int	getRotationCount () const =0

virtual Rotation &	getRotation (const int idx)=0
	Get rotation at given index. More...

virtual void	addRotation (const Vector3 &axis, const float angle)=0
	Add rotation. More...

virtual void	removeRotation (int idx)=0
	Remove rotation. More...

virtual const Vector3 &	getRotationAxis (const int idx) const =0

virtual void	setRotationAxis (const int idx, const Vector3 &axis)=0
	Set rotation axis. More...

virtual const float	getRotationAngle (const int idx) const =0

virtual void	setRotationAngle (const int idx, const float angle)=0

virtual const Quaternion &	getRotationsQuaternion () const =0

virtual const Matrix4x4 &	getTransformationsMatrix () const =0

virtual void	fromTransformations (const Transformations &transformations)=0
	Set up this transformations from given transformations. More...

virtual void	update ()=0
	Update transformations. More...

virtual const Transformations &	getTransformations () const =0

virtual RenderPass	getRenderPass () const =0

virtual void	setRenderPass (RenderPass renderPass)=0
	Set render pass. More...

virtual	~Entity ()
	Destructor. More...

Private Member Functions
bool	isNeedsComputeTransformations ()

void	computeTransformations (int contextIdx)
	Compute animations. More...

void	computeTransformations (int contextIdx, int64_t lastFrameAtTime, int64_t currentFrameAtTime) override
	Compute transformations. More...

bool	isNeedsPreRender ()

void	preRender (int contextIdx)
	Pre render step like uploading VBOs and such. More...

bool	isNeedsForwardShading ()

void	setParentEntity (Entity *entity) override
	Set parent entity, needs to be called before adding to engine. More...

Entity *	getParentEntity () override

void	applyParentTransformations (const Transformations &parentTransformations) override
	Apply parent transformations. More...

Private Attributes
Engine *	engine { nullptr }

Entity *	parentEntity { nullptr }

bool	frustumCulling { true }

RenderPass	renderPass { RENDERPASS_STANDARD }

string	shaderId

uint8_t	uniqueShaderId { 0 }

string	distanceShaderId

uint8_t	uniqueDistanceShaderId { 0 }

float	distanceShaderDistance { 50.0f }

string	reflectionEnvironmentMappingId

bool	reflectionEnvironmentMappingPositionSet { false }

Vector3	reflectionEnvironmentMappingPosition

Engine::EffectPass	excludeFromEffectPass { Engine::EFFECTPASS_NONE }

bool	enableEarlyZRejection { false }

bool	disableDepthTest { false }

int64_t	frameTransformationsLast { -1LL }

int64_t	timeTransformationsLast { -1LL }

EntityShaderParameters	shaderParameters

EntityShaderParameters	distanceShaderParameters

bool	needsPreRender { false }

bool	needsForwardShading { false }

Friends
class	Engine

class	ImposterObject3D

class	LODObject3D

class	LODObject3DImposter

class	Object3DRenderGroup

class	ObjectParticleSystem

class	SkinnedObject3DRenderGroup

class	tdme::engine::subsystems::rendering::EntityRenderer

class	tdme::engine::subsystems::shadowmapping::ShadowMap

Additional Inherited Members
Public Types inherited from Entity
enum	RenderPass { RENDERPASS_NONE = 0 , RENDERPASS_SKY = 1 , RENDERPASS_NOFRUSTUMCULLING = 1 , RENDERPASS_TERRAIN = 2 , RENDERPASS_STANDARD = 4 , RENDERPASS_WATER = 8 , RENDERPASS_POST_POSTPROCESSING = 16 }

enum	EntityType { ENTITYTYPE_ENTITYHIERARCHY , ENTITYTYPE_ENVIRONMENTMAPPING , ENTITYTYPE_IMPOSTEROBJECT3D , ENTITYTYPE_LINESOBJECT3D , ENTITYTYPE_LODOBJECT3D , ENTITYTYPE_LODOBJECT3DIMPOSTER , ENTITYTYPE_OBJECT3D , ENTITYTYPE_OBJECT3DRENDERGROUP , ENTITYTYPE_FOGPARTICLESYSTEM , ENTITYTYPE_OBJECTPARTICLESYSTEM , ENTITYTYPE_PARTICLESYSTEMGROUP , ENTITYTYPE_POINTSPARTICLESYSTEM }

Static Public Attributes inherited from Entity
static constexpr int	RENDERPASS_MAX { 5 }

static constexpr int	RENDERPASS_ALL { 1 + 2 + 4 + 8 + 16 }

Protected Member Functions inherited from Object3DInternal
void	updateBoundingBox ()
	Update bounding volume. More...

Protected Member Functions inherited from Object3DBase
	Object3DBase (Model *model, bool useManagers, Engine::AnimationProcessingTarget animationProcessingTarget, int instances)
	Private constructor. More...

virtual	~Object3DBase ()
	Destructor. More...

Protected Attributes inherited from Object3DInternal
string	id

bool	enabled

bool	pickable

bool	contributesShadows

bool	receivesShadows

Color4	effectColorMul

Color4	effectColorAdd

BoundingBox	boundingBox

BoundingBox	boundingBoxTransformed

Protected Attributes inherited from Object3DBase
Model *	model

vector< Object3DNode * >	object3dNodes

bool	usesManagers

int	instances

int	enabledInstances

vector< Object3DAnimation * >	instanceAnimations

vector< bool >	instanceEnabled

vector< Transformations >	instanceTransformations

int	currentInstance

Engine::AnimationProcessingTarget	animationProcessingTarget

Detailed Description

Object 3D to be used with engine class.

Author: Andreas Drewke

Version: $Id$

Definition at line 57 of file Object3D.h.

Constructor & Destructor Documentation

◆ Object3D() [1/2]

Object3D	(	const string &	id,
		Model *	model,
		int	instances
	)

Public constructor.

Parameters

id	id
model	model
instances	instances to compute and render by duplication, which only is intended to be used with skinned meshes

Definition at line 29 of file Object3D.cpp.

◆ Object3D() [2/2]

Object3D	(	const string &	id,
		Model *	model
	)

Public constructor.

Parameters

id	id
model	model

Definition at line 35 of file Object3D.cpp.

Member Function Documentation

◆ addRotation()

void addRotation	(	const Vector3 &	axis,
		const float	angle
	)

inlineoverridevirtual

Add rotation.

Parameters

axis	axis
angle	angle

Implements Entity.

Definition at line 299 of file Object3D.h.

◆ applyParentTransformations()

void applyParentTransformations ( const Transformations & parentTransformations )

inlineoverrideprivatevirtual

Apply parent transformations.

Parameters

parentTransformations parent transformations

Implements Entity.

Definition at line 167 of file Object3D.h.

◆ computeTransformations() [1/2]

void computeTransformations ( int contextIdx )

inlineprivate

Compute animations.

Parameters

contextIdx context index

Definition at line 105 of file Object3D.h.

◆ computeTransformations() [2/2]

void computeTransformations	(	int	contextIdx,
		int64_t	lastFrameAtTime,
		int64_t	currentFrameAtTime
	)

inlineoverrideprivatevirtual

Compute transformations.

Parameters

contextIdx	context index
lastFrameAtTime	time of last animation computation
currentFrameAtTime	time of current animation computation

Reimplemented from Object3DBase.

Definition at line 127 of file Object3D.h.

◆ dispose()

void dispose ( )

overridevirtual

Dispose this object 3d.

Implements Entity.

Definition at line 106 of file Object3D.cpp.

◆ fromTransformations()

void fromTransformations ( const Transformations & transformations )

overridevirtual

Set up this transformations from given transformations.

Parameters

transformations transformations

Implements Entity.

Definition at line 52 of file Object3D.cpp.

◆ getBoundingBox()

BoundingBox * getBoundingBox ( )

inlineoverridevirtual

Returns: bounding box / in model coordinate space

Implements Entity.

Definition at line 215 of file Object3D.h.

◆ getBoundingBoxTransformed()

BoundingBox * getBoundingBoxTransformed ( )

inlineoverridevirtual

Returns: bounding box transformed / in world coordinate space

Implements Entity.

Definition at line 219 of file Object3D.h.

◆ getDistanceShader()

const string & getDistanceShader ( )

inline

Returns: distance shader id

Definition at line 366 of file Object3D.h.

◆ getDistanceShaderDistance()

float getDistanceShaderDistance ( )

inline

Returns: distance shader distance

Definition at line 386 of file Object3D.h.

◆ getDistanceShaderParameter()

const ShaderParameter getDistanceShaderParameter ( const string & parameterName )

inline

Returns distance shader parameter for given parameter name, if the value does not exist, the default will be returned.

Parameters

shaderId	shader id
parameterName	parameter name

Returns: shader parameter

Definition at line 514 of file Object3D.h.

◆ getEffectColorAdd()

const Color4 & getEffectColorAdd ( ) const

inlineoverridevirtual

The effect color will be added to fragment color.

Returns: effect color

Implements Entity.

Definition at line 223 of file Object3D.h.

◆ getEffectColorMul()

const Color4 & getEffectColorMul ( ) const

inlineoverridevirtual

The effect color will be multiplied with fragment color.

Returns: effect color

Implements Entity.

Definition at line 231 of file Object3D.h.

◆ getEntityType()

EntityType getEntityType ( )

inlineoverridevirtual

Returns: entity type

Implements Entity.

Definition at line 196 of file Object3D.h.

◆ getExcludeFromEffectPass()

Engine::EffectPass getExcludeFromEffectPass ( ) const

inline

Returns: if to exclude from a certain effect pass

Definition at line 446 of file Object3D.h.

◆ getId()

const string & getId ( )

inlineoverridevirtual

Returns: object id

Implements Entity.

Definition at line 239 of file Object3D.h.

◆ getParentEntity()

Entity * getParentEntity ( )

inlineoverrideprivatevirtual

Returns: parent entity

Implements Entity.

Definition at line 164 of file Object3D.h.

◆ getPivot()

const Vector3 & getPivot ( ) const

inlineoverridevirtual

Returns: pivot or center of rotations

Implements Entity.

Definition at line 283 of file Object3D.h.

◆ getReflectionEnvironmentMappingId()

const string & getReflectionEnvironmentMappingId ( )

inline

Returns: reflection environment mapping id

Definition at line 401 of file Object3D.h.

◆ getReflectionEnvironmentMappingPosition()

const Vector3 & getReflectionEnvironmentMappingPosition ( )

inline

Returns: reflection environment mapping position

Definition at line 422 of file Object3D.h.

◆ getRenderPass()

RenderPass getRenderPass ( ) const

inlineoverridevirtual

Returns: render pass

Implements Entity.

Definition at line 335 of file Object3D.h.

◆ getRotation()

Rotation & getRotation ( const int idx )

inlineoverridevirtual

Get rotation at given index.

Parameters

idx	rotation index

Returns: rotation

Implements Entity.

Definition at line 295 of file Object3D.h.

◆ getRotationAngle()

const float getRotationAngle ( const int idx ) const

inlineoverridevirtual

Parameters

idx	rotation index

Returns: rotation angle for rotation with given index

Implements Entity.

Definition at line 315 of file Object3D.h.

◆ getRotationAxis()

const Vector3 & getRotationAxis ( const int idx ) const

inlineoverridevirtual

Parameters

idx	rotation index

Returns: rotation axis for rotation with given index

Implements Entity.

Definition at line 307 of file Object3D.h.

◆ getRotationCount()

const int getRotationCount ( ) const

inlineoverridevirtual

Returns: rotation count

Implements Entity.

Definition at line 291 of file Object3D.h.

◆ getRotationsQuaternion()

const Quaternion & getRotationsQuaternion ( ) const

inlineoverridevirtual

Returns: rotations quaternion

Implements Entity.

Definition at line 323 of file Object3D.h.

◆ getScale()

const Vector3 & getScale ( ) const

inlineoverridevirtual

Returns: object scale

Implements Entity.

Definition at line 275 of file Object3D.h.

◆ getShader()

const string & getShader ( )

inline

Returns: shader id

Definition at line 346 of file Object3D.h.

◆ getShaderParameter()

const ShaderParameter getShaderParameter ( const string & parameterName )

inline

Returns shader parameter for given parameter name, if the value does not exist, the default will be returned.

Parameters

shaderId	shader id
parameterName	parameter name

Returns: shader parameter

Definition at line 494 of file Object3D.h.

◆ getTransformations()

const Transformations & getTransformations ( ) const

inlineoverridevirtual

Returns: this transformations

Implements Entity.

Definition at line 331 of file Object3D.h.

◆ getTransformationsMatrix()

const Matrix4x4 & getTransformationsMatrix ( ) const

inlineoverridevirtual

Returns: this transformations matrix

Implements Entity.

Definition at line 327 of file Object3D.h.

◆ getTranslation()

const Vector3 & getTranslation ( ) const

inlineoverridevirtual

Returns: object translation

Implements Entity.

Definition at line 267 of file Object3D.h.

◆ getUniqueDistanceShaderId()

uint8_t getUniqueDistanceShaderId ( )

inline

Returns: unique distance shader id

Definition at line 373 of file Object3D.h.

◆ getUniqueShaderId()

uint8_t getUniqueShaderId ( )

inline

Returns: unique shader id

Definition at line 359 of file Object3D.h.

◆ hasReflectionEnvironmentMappingPosition()

bool hasReflectionEnvironmentMappingPosition ( )

inline

Returns: if object3d has a reflection environment mapping position

Definition at line 415 of file Object3D.h.

◆ initialize()

void initialize ( )

overridevirtual

Initiates this object 3d.

Implements Entity.

Definition at line 111 of file Object3D.cpp.

◆ isContributesShadows()

bool isContributesShadows ( )

inlineoverridevirtual

Returns: if entity contributes to shadows

Implements Entity.

Definition at line 243 of file Object3D.h.

◆ isDisableDepthTest()

bool isDisableDepthTest ( ) const

inline

Returns: if depth test is disabled

Definition at line 476 of file Object3D.h.

◆ isEnabled()

bool isEnabled ( )

inlineoverridevirtual

Returns: true if enabled to be rendered

Implements Entity.

Definition at line 205 of file Object3D.h.

◆ isEnableEarlyZRejection()

bool isEnableEarlyZRejection ( ) const

inline

Returns: If early z rejection is enabled

Definition at line 461 of file Object3D.h.

◆ isFrustumCulling()

bool isFrustumCulling ( )

overridevirtual

Returns: if frustum culling is enabled

Implements Entity.

Definition at line 85 of file Object3D.cpp.

◆ isNeedsComputeTransformations()

bool isNeedsComputeTransformations ( )

inlineprivate

Returns: if this object3d instance needs a computeTransformations() call each frame

Definition at line 97 of file Object3D.h.

◆ isNeedsForwardShading()

bool isNeedsForwardShading ( )

inlineprivate

Returns: if this object3d needs forward shading

Definition at line 156 of file Object3D.h.

◆ isNeedsPreRender()

bool isNeedsPreRender ( )

inlineprivate

Returns: if this object3d instance needs a preRender() call each frame

Definition at line 134 of file Object3D.h.

◆ isPickable()

bool isPickable ( )

inlineoverridevirtual

Returns: if object is pickable

Implements Entity.

Definition at line 259 of file Object3D.h.

◆ isReceivesShadows()

bool isReceivesShadows ( )

inlineoverridevirtual

Returns: if entity receives shadows

Implements Entity.

Definition at line 251 of file Object3D.h.

◆ preRender()

void preRender ( int contextIdx )

inlineprivate

Pre render step like uploading VBOs and such.

Parameters

contextIdx context index

Definition at line 144 of file Object3D.h.

◆ removeRotation()

void removeRotation ( const int idx )

inlineoverridevirtual

Remove rotation.

Parameters

idx index

Implements Entity.

Definition at line 303 of file Object3D.h.

◆ setContributesShadows()

void setContributesShadows ( bool contributesShadows )

inlineoverridevirtual

Enable/disable contributes shadows.

Parameters

contributesShadows contributes shadows

Implements Entity.

Definition at line 247 of file Object3D.h.

◆ setDisableDepthTest()

void setDisableDepthTest ( bool disableDepthTest )

inline

Set disable depth test.

Parameters

disableDepthTest disable depth test

Definition at line 484 of file Object3D.h.

◆ setDistanceShader()

void setDistanceShader ( const string & id )

Set distance shader.

Parameters

id shader id

Definition at line 136 of file Object3D.cpp.

◆ setDistanceShaderDistance()

void setDistanceShaderDistance ( float distanceShaderDistance )

inline

Set distance shader distance.

Parameters

distanceShaderDistance shader

Definition at line 394 of file Object3D.h.

◆ setDistanceShaderParameter()

void setDistanceShaderParameter	(	const string &	parameterName,
		const ShaderParameter &	parameterValue
	)

inline

Set distance shader parameter for given parameter name.

Parameters

shaderId	shader id
parameterName	parameter name
paraemterValue	parameter value

Definition at line 524 of file Object3D.h.

◆ setEffectColorAdd()

void setEffectColorAdd ( const Color4 & effectColorAdd )

inlineoverridevirtual

Set effect color that will be added to fragment color.

Returns: effect color

Implements Entity.

Definition at line 227 of file Object3D.h.

◆ setEffectColorMul()

void setEffectColorMul ( const Color4 & effectColorMul )

inlineoverridevirtual

Set effect color that will be multiplied with fragment color.

Parameters

effectColorMul effect color

Implements Entity.

Definition at line 235 of file Object3D.h.

◆ setEnabled()

void setEnabled ( bool enabled )

overridevirtual

Enable/disable rendering.

Parameters

enabled enabled

Implements Entity.

Definition at line 64 of file Object3D.cpp.

◆ setEnableEarlyZRejection()

void setEnableEarlyZRejection ( bool enableEarlyZRejection )

inline

Enable/disable early z rejection.

Parameters

enableEarlyZRejection enable early z rejection

Definition at line 469 of file Object3D.h.

◆ setEngine()

void setEngine ( Engine * engine )

overridevirtual

Set up engine.

Parameters

engine engine

Implements Entity.

Definition at line 41 of file Object3D.cpp.

◆ setExcludeEffectPass()

void setExcludeEffectPass ( Engine::EffectPass effectPass )

inline

Set exclude from effect pass.

Parameters

effectPass effect pass

Definition at line 454 of file Object3D.h.

◆ setFrustumCulling()

void setFrustumCulling ( bool frustumCulling )

overridevirtual

Set frustum culling.

Parameters

frustumCulling frustum culling

Implements Entity.

Definition at line 89 of file Object3D.cpp.

◆ setNeedsPreRender()

void setNeedsPreRender ( bool needsPreRender )

inline

Set up if this object3d instance needs a preRender() call each frame.

Definition at line 191 of file Object3D.h.

◆ setParentEntity()

void setParentEntity ( Entity * entity )

inlineoverrideprivatevirtual

Set parent entity, needs to be called before adding to engine.

Parameters

entity entity

Implements Entity.

Definition at line 161 of file Object3D.h.

◆ setPickable()

void setPickable ( bool pickable )

inlineoverridevirtual

Set this object pickable.

Parameters

pickable pickable

Implements Entity.

Definition at line 263 of file Object3D.h.

◆ setPivot()

void setPivot ( const Vector3 & pivot )

inlineoverridevirtual

Set pivot.

Parameters

pivot pivot

Implements Entity.

Definition at line 287 of file Object3D.h.

◆ setReceivesShadows()

void setReceivesShadows ( bool receivesShadows )

inlineoverridevirtual

Enable/disable receives shadows.

Parameters

receivesShadows receives shadows

Implements Entity.

Definition at line 255 of file Object3D.h.

◆ setReflectionEnvironmentMappingId()

void setReflectionEnvironmentMappingId ( const string & reflectionEnvironmentMappingId )

inline

Returns: reflection environment mapping id

Definition at line 408 of file Object3D.h.

◆ setReflectionEnvironmentMappingPosition()

void setReflectionEnvironmentMappingPosition ( const Vector3 & reflectionEnvironmentMappingPosition )

inline

Set reflection environment mapping position.

Parameters

reflectionEnvironmentMappingPosition reflection environment mapping position

Definition at line 430 of file Object3D.h.

◆ setRenderer()

void setRenderer ( Renderer * renderer )

overridevirtual

Set up renderer.

Parameters

renderer renderer

Implements Entity.

Definition at line 48 of file Object3D.cpp.

◆ setRenderPass()

void setRenderPass ( RenderPass renderPass )

inlineoverridevirtual

Set render pass.

Parameters

renderPass render pass

Implements Entity.

Definition at line 339 of file Object3D.h.

◆ setRotationAngle()

void setRotationAngle	(	const int	idx,
		const float	angle
	)

inlineoverridevirtual

Parameters

idx	rotation index
angle	rotation angle

Returns: rotation angle for rotation with given index

Implements Entity.

Definition at line 319 of file Object3D.h.

◆ setRotationAxis()

void setRotationAxis	(	const int	idx,
		const Vector3 &	axis
	)

inlineoverridevirtual

Set rotation axis.

Parameters

idx	rotation index
axis	rotation axis

Implements Entity.

Definition at line 311 of file Object3D.h.

◆ setScale()

void setScale ( const Vector3 & scale )

inlineoverridevirtual

Set scale.

Parameters

scale scale

Implements Entity.

Definition at line 279 of file Object3D.h.

◆ setShader()

void setShader ( const string & id )

Set shader.

Parameters

id shader id

Definition at line 116 of file Object3D.cpp.

◆ setShaderParameter()

void setShaderParameter	(	const string &	parameterName,
		const ShaderParameter &	parameterValue
	)

inline

Set shader parameter for given parameter name.

Parameters

shaderId	shader id
parameterName	parameter name
paraemterValue	parameter value

Definition at line 504 of file Object3D.h.

◆ setTranslation()

void setTranslation ( const Vector3 & translation )

inlineoverridevirtual

Set translation.

Parameters

translation translation

Implements Entity.

Definition at line 271 of file Object3D.h.

◆ unsetReflectionEnvironmentMappingPosition()

void unsetReflectionEnvironmentMappingPosition ( )

inline

Unset reflection environment mapping position.

Definition at line 438 of file Object3D.h.

◆ update()

void update ( )

overridevirtual

Update transformations.

Implements Entity.

Definition at line 58 of file Object3D.cpp.

Friends And Related Function Documentation

◆ Engine

friend class Engine

friend

Definition at line 62 of file Object3D.h.

◆ ImposterObject3D

friend class ImposterObject3D

friend

Definition at line 63 of file Object3D.h.

◆ LODObject3D

friend class LODObject3D

friend

Definition at line 64 of file Object3D.h.

◆ LODObject3DImposter

friend class LODObject3DImposter

friend

Definition at line 65 of file Object3D.h.

◆ Object3DRenderGroup

friend class Object3DRenderGroup

friend

Definition at line 66 of file Object3D.h.

◆ ObjectParticleSystem

friend class ObjectParticleSystem

friend

Definition at line 67 of file Object3D.h.

◆ SkinnedObject3DRenderGroup

friend class SkinnedObject3DRenderGroup

friend

Definition at line 68 of file Object3D.h.

◆ tdme::engine::subsystems::rendering::EntityRenderer

friend class tdme::engine::subsystems::rendering::EntityRenderer

friend

Definition at line 69 of file Object3D.h.

◆ tdme::engine::subsystems::shadowmapping::ShadowMap

friend class tdme::engine::subsystems::shadowmapping::ShadowMap

friend

Definition at line 70 of file Object3D.h.

Member Data Documentation

◆ disableDepthTest

bool disableDepthTest { false }

private

Definition at line 86 of file Object3D.h.

◆ distanceShaderDistance

float distanceShaderDistance { 50.0f }

private

Definition at line 80 of file Object3D.h.

◆ distanceShaderId

string distanceShaderId

private

Definition at line 78 of file Object3D.h.

◆ distanceShaderParameters

EntityShaderParameters distanceShaderParameters

private

Definition at line 90 of file Object3D.h.

◆ enableEarlyZRejection

bool enableEarlyZRejection { false }

private

Definition at line 85 of file Object3D.h.

◆ engine

Engine* engine { nullptr }

private

Definition at line 72 of file Object3D.h.

◆ excludeFromEffectPass

Engine::EffectPass excludeFromEffectPass { Engine::EFFECTPASS_NONE }

private

Definition at line 84 of file Object3D.h.

◆ frameTransformationsLast

int64_t frameTransformationsLast { -1LL }

private

Definition at line 87 of file Object3D.h.

◆ frustumCulling

bool frustumCulling { true }

private

Definition at line 74 of file Object3D.h.

◆ needsForwardShading

bool needsForwardShading { false }

private

Definition at line 92 of file Object3D.h.

◆ needsPreRender

bool needsPreRender { false }

private

Definition at line 91 of file Object3D.h.

◆ parentEntity

Entity* parentEntity { nullptr }

private

Definition at line 73 of file Object3D.h.

◆ reflectionEnvironmentMappingId

string reflectionEnvironmentMappingId

private

Definition at line 81 of file Object3D.h.

◆ reflectionEnvironmentMappingPosition

Vector3 reflectionEnvironmentMappingPosition

private

Definition at line 83 of file Object3D.h.

◆ reflectionEnvironmentMappingPositionSet

bool reflectionEnvironmentMappingPositionSet { false }

private

Definition at line 82 of file Object3D.h.

◆ renderPass

RenderPass renderPass { RENDERPASS_STANDARD }

private

Definition at line 75 of file Object3D.h.

◆ shaderId

string shaderId

private

Definition at line 76 of file Object3D.h.

◆ shaderParameters

EntityShaderParameters shaderParameters

private

Definition at line 89 of file Object3D.h.

◆ timeTransformationsLast

int64_t timeTransformationsLast { -1LL }

private

Definition at line 88 of file Object3D.h.

◆ uniqueDistanceShaderId

uint8_t uniqueDistanceShaderId { 0 }

private

Definition at line 79 of file Object3D.h.

◆ uniqueShaderId

uint8_t uniqueShaderId { 0 }

private

Definition at line 77 of file Object3D.h.

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

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

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Object3D() [1/2]

◆ Object3D() [2/2]

Member Function Documentation

◆ addRotation()

◆ applyParentTransformations()

◆ computeTransformations() [1/2]

◆ computeTransformations() [2/2]

◆ dispose()

◆ fromTransformations()

◆ getBoundingBox()

◆ getBoundingBoxTransformed()

◆ getDistanceShader()

◆ getDistanceShaderDistance()

◆ getDistanceShaderParameter()

◆ getEffectColorAdd()

◆ getEffectColorMul()

◆ getEntityType()

◆ getExcludeFromEffectPass()

◆ getId()

◆ getParentEntity()

◆ getPivot()

◆ getReflectionEnvironmentMappingId()

◆ getReflectionEnvironmentMappingPosition()

◆ getRenderPass()

◆ getRotation()

◆ getRotationAngle()

◆ getRotationAxis()

◆ getRotationCount()

◆ getRotationsQuaternion()

◆ getScale()

◆ getShader()

◆ getShaderParameter()

◆ getTransformations()

◆ getTransformationsMatrix()

◆ getTranslation()

◆ getUniqueDistanceShaderId()

◆ getUniqueShaderId()

◆ hasReflectionEnvironmentMappingPosition()

◆ initialize()

◆ isContributesShadows()

◆ isDisableDepthTest()

◆ isEnabled()

◆ isEnableEarlyZRejection()

◆ isFrustumCulling()

◆ isNeedsComputeTransformations()

◆ isNeedsForwardShading()

◆ isNeedsPreRender()

◆ isPickable()

◆ isReceivesShadows()

◆ preRender()

◆ removeRotation()

◆ setContributesShadows()

◆ setDisableDepthTest()

◆ setDistanceShader()

◆ setDistanceShaderDistance()

◆ setDistanceShaderParameter()

◆ setEffectColorAdd()

◆ setEffectColorMul()

◆ setEnabled()

◆ setEnableEarlyZRejection()

◆ setEngine()

◆ setExcludeEffectPass()

◆ setFrustumCulling()

◆ setNeedsPreRender()

◆ setParentEntity()

◆ setPickable()

◆ setPivot()

◆ setReceivesShadows()

◆ setReflectionEnvironmentMappingId()

◆ setReflectionEnvironmentMappingPosition()

◆ setRenderer()

◆ setRenderPass()

◆ setRotationAngle()