TDME2 1.9.121
Public Member Functions | List of all members
ParticleSystemEntity Struct Referenceabstract

Particle system entity interface. More...

#include <tdme/engine/ParticleSystemEntity.h>

Inheritance diagram for ParticleSystemEntity:
Inheritance graph
Collaboration diagram for ParticleSystemEntity:
Collaboration graph

Public Member Functions

virtual ~ParticleSystemEntity ()
 Public destructor. More...
 
virtual ParticleEmittergetEmitter ()=0
 
virtual bool isActive ()=0
 
virtual bool isAutoEmit ()=0
 
virtual void setAutoEmit (bool autoEmit)=0
 Set auto emit. More...
 
virtual void updateParticles ()=0
 Updates the particle entity. More...
 
virtual int32_t emitParticles ()=0
 Adds particles to this particle entity at given position. More...
 
virtual const TransformationsgetLocalTransformations ()=0
 
virtual void setLocalTransformations (const Transformations &transformations)=0
 Set local transformations. More...
 
- 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 Color4getEffectColorMul () 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 Color4getEffectColorAdd () 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 BoundingBoxgetBoundingBox ()=0
 
virtual BoundingBoxgetBoundingBoxTransformed ()=0
 
virtual const Vector3getTranslation () const =0
 
virtual void setTranslation (const Vector3 &translation)=0
 Set translation. More...
 
virtual const Vector3getScale () const =0
 
virtual void setScale (const Vector3 &scale)=0
 Set scale. More...
 
virtual const Vector3getPivot () const =0
 
virtual void setPivot (const Vector3 &pivot)=0
 Set pivot. More...
 
virtual const int getRotationCount () const =0
 
virtual RotationgetRotation (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 Vector3getRotationAxis (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 QuaterniongetRotationsQuaternion () const =0
 
virtual const Matrix4x4getTransformationsMatrix () 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 TransformationsgetTransformations () const =0
 
virtual RenderPass getRenderPass () const =0
 
virtual void setRenderPass (RenderPass renderPass)=0
 Set render pass. More...
 
virtual ~Entity ()
 Destructor. More...
 

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 }
 

Detailed Description

Particle system entity interface.

Author
Andreas Drewke
Version
$Id$

Definition at line 21 of file ParticleSystemEntity.h.

Constructor & Destructor Documentation

◆ ~ParticleSystemEntity()

virtual ~ParticleSystemEntity ( )
inlinevirtual

Public destructor.

Definition at line 26 of file ParticleSystemEntity.h.

Member Function Documentation

◆ emitParticles()

virtual int32_t emitParticles ( )
pure virtual

Adds particles to this particle entity at given position.

Implemented in FogParticleSystem, ObjectParticleSystem, ParticleSystemGroup, and PointsParticleSystem.

◆ getEmitter()

virtual ParticleEmitter * getEmitter ( )
pure virtual
Returns
particle emitter

Implemented in FogParticleSystem, ObjectParticleSystem, ParticleSystemGroup, and PointsParticleSystem.

◆ getLocalTransformations()

virtual const Transformations & getLocalTransformations ( )
pure virtual
Returns
local transformations

Implemented in FogParticleSystem, ObjectParticleSystem, ParticleSystemGroup, and PointsParticleSystem.

◆ isActive()

virtual bool isActive ( )
pure virtual
Returns
true if active / particles available

Implemented in FogParticleSystem, ObjectParticleSystem, ParticleSystemGroup, and PointsParticleSystem.

◆ isAutoEmit()

virtual bool isAutoEmit ( )
pure virtual
Returns
if auto emit is enabled

Implemented in FogParticleSystem, ObjectParticleSystem, ParticleSystemGroup, and PointsParticleSystem.

◆ setAutoEmit()

virtual void setAutoEmit ( bool  autoEmit)
pure virtual

Set auto emit.

Parameters
autoEmitauto emit

Implemented in FogParticleSystem, ObjectParticleSystem, ParticleSystemGroup, and PointsParticleSystem.

◆ setLocalTransformations()

virtual void setLocalTransformations ( const Transformations transformations)
pure virtual

Set local transformations.

Parameters
transformationslocal transformations

Implemented in FogParticleSystem, ObjectParticleSystem, ParticleSystemGroup, and PointsParticleSystem.

◆ updateParticles()

virtual void updateParticles ( )
pure virtual

Updates the particle entity.

Implemented in FogParticleSystem, ObjectParticleSystem, ParticleSystemGroup, and PointsParticleSystem.


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