Smoke Emitter. More...

#include <deSmokeEmitter.h>

Inheritance diagram for deSmokeEmitter:

Public Types
typedef deTObjectReference< deSmokeEmitter >	Ref
	Type holding strong reference. More...

Public Types inherited from deResource
typedef deTObjectReference< deResource >	Ref
	Type holding strong reference. More...

Public Types inherited from deObject
typedef deTObjectReference< deObject >	Ref
	Type holding strong reference. More...

Public Member Functions
Management
const decDVector &	GetEmitterPosition () const
	Emitter position. More...

void	SetEmitterPosition (const decDVector &position)
	Set emitter position. More...

const decQuaternion &	GetEmitterOrientation () const
	Emitter orientation. More...

void	SetEmitterOrientation (const decQuaternion &orientation)
	Set emitter orientation. More...

const decDVector &	GetVolumePosition () const
	Volume position. More...

void	SetVolumePosition (const decDVector &position)
	Set volume position. More...

const decVector &	GetMinCastDirection () const
	Minimum cast direction deviation. More...

void	SetMinCastDirection (const decVector &deviation)
	Set minimum cast direction deviation. More...

const decVector &	GetMaxCastDirection () const
	Maximum cast direction deviation. More...

void	SetMaxCastDirection (const decVector &deviation)
	Set maximum cast direction deviation. More...

float	GetMinCastVelocity () const
	Minimum cast velocity. More...

void	SetMinCastVelocity (float velocity)
	Set minimum cast velocity. More...

float	GetMaxCastVelocity () const
	Maximum cast velocity. More...

void	SetMaxCastVelocity (float velocity)
	Set maximum cast velocity. More...

float	GetMinCastDensity () const
	Minimum cast density. More...

void	SetMinCastDensity (float density)
	Set minimum cast density. More...

float	GetMaxCastDensity () const
	Maximum cast density. More...

void	SetMaxCastDensity (float density)
	Set maximum cast density. More...

bool	GetEnableCasting () const
	Determines if casting particles is enabled. More...

void	SetEnableCasting (bool enable)
	Sets if casting particles is enabled. More...

deComponent *	GetComponent () const
	Component used for casting or NULL. More...

void	SetComponent (deComponent *component)
	Set component used for casting or NULL. More...

int	GetCastTexture () const
	Texture to use from the component skin to cast particles from. More...

void	SetCastTexture (int texture)
	Set texture to use from the component skin to cast particles from. More...

deSkin *	GetSkin () const
	Skin of the particle instances or NULL. More...

void	SetSkin (deSkin *skin)
	Set mode of the particle instances or NULL. More...

const decCollisionFilter &	GetCollisionFilter () const
	Collision filter. More...

void	SetCollisionFilter (const decCollisionFilter &collisionFilter)
	Set collision filter. More...

const decVector &	GetGravity () const
	Gravity in m/s^2. More...

void	SetGravity (const decVector &gravity)
	Set gravity in m/s^2. More...

bool	GetUseLocalGravity () const
	Local gravity has to be used instead of the world gravity. More...

void	SetUseLocalGravity (bool useLocalGravity)
	Set if local gravity has to be used instead of the world gravity. More...

int	GetPointCount () const
	Number of points. More...

deSmokeDensityPoint *	GetPoints () const
	Pointer to the points which can be NULL. More...

void	SetPoints (deSmokeDensityPoint *points, int count)
	Set points. More...

void	NotifyPointsChanged ()
	Notifies the graphic peer that the points changed. More...

System Peers
deBaseGraphicSmokeEmitter *	GetPeerGraphic () const
	Graphic system peer object. More...

void	SetPeerGraphic (deBaseGraphicSmokeEmitter *peer)
	Set graphic system peer object. More...

deBasePhysicsSmokeEmitter *	GetPeerPhysics () const
	Physics system peer object. More...

void	SetPeerPhysics (deBasePhysicsSmokeEmitter *peer)
	Set physics system peer object. More...

Linked List
deWorld *	GetParentWorld () const
	Parent world or NULL. More...

void	SetParentWorld (deWorld *world)
	Set parent world or NULL. More...

deSmokeEmitter *	GetLLWorldPrev () const
	Previous smoke emitter in the parent world linked list. More...

void	SetLLWorldPrev (deSmokeEmitter *smokeEmitter)
	Set next smoke emitter in the parent world linked list. More...

deSmokeEmitter *	GetLLWorldNext () const
	Next smoke emitter in the parent world linked list. More...

void	SetLLWorldNext (deSmokeEmitter *smokeEmitter)
	Set next smoke emitter in the parent world linked list. More...

Public Member Functions inherited from deResource
deResourceManager *	GetResourceManager () const
	Resource manager or NULL if resource is leaking. More...

deEngine *	GetEngine () const
	Game engine object from resource manager. More...

deResource *	GetLLManagerPrev () const
	Previous resource in the resource manager linked list. More...

void	SetLLManagerPrev (deResource *resource)
	Set next resource in the resource manager linked list. More...

deResource *	GetLLManagerNext () const
	Next resource in the resource manager linked list. More...

void	SetLLManagerNext (deResource *resource)
	Set next resource in the resource manager linked list. More...

void	MarkLeaking ()
	Marks the resource leaking. More...

	deResource (deResourceManager *resourceManager)
	Create resource. More...

Public Member Functions inherited from deObject
int	GetRefCount () const
	Reference count. More...

void	AddReference ()
	Add reference increasing reference count by 1. More...

void	FreeReference ()
	Decrease reference count by one and delete object if count reaches 0. More...

	deObject ()
	Create object with reference count of 1. More...

Constructors and Destructors
	deSmokeEmitter (deSmokeEmitterManager *manager)
	Create new particle system. More...

virtual	~deSmokeEmitter ()
	Clean up particle system. More...

Additional Inherited Members
Protected Member Functions inherited from deResource
virtual	~deResource ()
	Clean up resource. More...

Protected Member Functions inherited from deObject
virtual	~deObject ()
	Clean up object. More...

Detailed Description

Smoke Emitter.

A smoke emitter produces gazous volumetric objects influenced by force fields or other physics objects. The gasous volume is described using a list of density points. Each density point represents a sphere of variable size. The density distribution inside a sphere declines quadratic towards the sphere boundary. The transparency of the sphere depends therefore on the radius. The maximum radius parameter indicates the largest radius of a sphere where the density is not equal to 0. Spheres with a larger radius become invisible and are removed.

Member Typedef Documentation

◆ Ref

typedef deTObjectReference<deSmokeEmitter> deSmokeEmitter::Ref

Type holding strong reference.

Constructor & Destructor Documentation

◆ deSmokeEmitter()

deSmokeEmitter::deSmokeEmitter ( deSmokeEmitterManager * manager )

Create new particle system.

◆ ~deSmokeEmitter()

virtual deSmokeEmitter::~deSmokeEmitter ( )

protectedvirtual

Clean up particle system.

Note: Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

◆ GetCastTexture()

int deSmokeEmitter::GetCastTexture ( ) const

inline

Texture to use from the component skin to cast particles from.

◆ GetCollisionFilter()

const decCollisionFilter& deSmokeEmitter::GetCollisionFilter ( ) const

inline

Collision filter.

◆ GetComponent()

deComponent* deSmokeEmitter::GetComponent ( ) const

inline

Component used for casting or NULL.

◆ GetEmitterOrientation()

const decQuaternion& deSmokeEmitter::GetEmitterOrientation ( ) const

inline

Emitter orientation.

◆ GetEmitterPosition()

const decDVector& deSmokeEmitter::GetEmitterPosition ( ) const

inline

Emitter position.

◆ GetEnableCasting()

bool deSmokeEmitter::GetEnableCasting ( ) const

inline

Determines if casting particles is enabled.

◆ GetGravity()

const decVector& deSmokeEmitter::GetGravity ( ) const

inline

Gravity in m/s^2.

◆ GetLLWorldNext()

deSmokeEmitter* deSmokeEmitter::GetLLWorldNext ( ) const

inline

Next smoke emitter in the parent world linked list.

◆ GetLLWorldPrev()

deSmokeEmitter* deSmokeEmitter::GetLLWorldPrev ( ) const

inline

Previous smoke emitter in the parent world linked list.

◆ GetMaxCastDensity()

float deSmokeEmitter::GetMaxCastDensity ( ) const

inline

Maximum cast density.

◆ GetMaxCastDirection()

const decVector& deSmokeEmitter::GetMaxCastDirection ( ) const

inline

Maximum cast direction deviation.

◆ GetMaxCastVelocity()

float deSmokeEmitter::GetMaxCastVelocity ( ) const

inline

Maximum cast velocity.

◆ GetMinCastDensity()

float deSmokeEmitter::GetMinCastDensity ( ) const

inline

Minimum cast density.

◆ GetMinCastDirection()

const decVector& deSmokeEmitter::GetMinCastDirection ( ) const

inline

Minimum cast direction deviation.

◆ GetMinCastVelocity()

float deSmokeEmitter::GetMinCastVelocity ( ) const

inline

Minimum cast velocity.

◆ GetParentWorld()

deWorld* deSmokeEmitter::GetParentWorld ( ) const

inline

Parent world or NULL.

◆ GetPeerGraphic()

deBaseGraphicSmokeEmitter* deSmokeEmitter::GetPeerGraphic ( ) const

inline

Graphic system peer object.

◆ GetPeerPhysics()

deBasePhysicsSmokeEmitter* deSmokeEmitter::GetPeerPhysics ( ) const

inline

Physics system peer object.

◆ GetPointCount()

int deSmokeEmitter::GetPointCount ( ) const

inline

Number of points.

◆ GetPoints()

deSmokeDensityPoint* deSmokeEmitter::GetPoints ( ) const

inline

Pointer to the points which can be NULL.

◆ GetSkin()

deSkin* deSmokeEmitter::GetSkin ( ) const

inline

Skin of the particle instances or NULL.

◆ GetUseLocalGravity()

bool deSmokeEmitter::GetUseLocalGravity ( ) const

inline

Local gravity has to be used instead of the world gravity.

◆ GetVolumePosition()

const decDVector& deSmokeEmitter::GetVolumePosition ( ) const

inline

Volume position.

◆ NotifyPointsChanged()

void deSmokeEmitter::NotifyPointsChanged ( )

Notifies the graphic peer that the points changed.

◆ SetCastTexture()

void deSmokeEmitter::SetCastTexture ( int texture )

Set texture to use from the component skin to cast particles from.

◆ SetCollisionFilter()

void deSmokeEmitter::SetCollisionFilter ( const decCollisionFilter & collisionFilter )

Set collision filter.

◆ SetComponent()

void deSmokeEmitter::SetComponent ( deComponent * component )

Set component used for casting or NULL.

◆ SetEmitterOrientation()

void deSmokeEmitter::SetEmitterOrientation ( const decQuaternion & orientation )

Set emitter orientation.

◆ SetEmitterPosition()

void deSmokeEmitter::SetEmitterPosition ( const decDVector & position )

Set emitter position.

◆ SetEnableCasting()

void deSmokeEmitter::SetEnableCasting ( bool enable )

Sets if casting particles is enabled.

◆ SetGravity()

void deSmokeEmitter::SetGravity ( const decVector & gravity )

Set gravity in m/s^2.

◆ SetLLWorldNext()

void deSmokeEmitter::SetLLWorldNext ( deSmokeEmitter * smokeEmitter )

Set next smoke emitter in the parent world linked list.

◆ SetLLWorldPrev()

void deSmokeEmitter::SetLLWorldPrev ( deSmokeEmitter * smokeEmitter )

Set next smoke emitter in the parent world linked list.

◆ SetMaxCastDensity()

void deSmokeEmitter::SetMaxCastDensity ( float density )

Set maximum cast density.

◆ SetMaxCastDirection()

void deSmokeEmitter::SetMaxCastDirection ( const decVector & deviation )

Set maximum cast direction deviation.

◆ SetMaxCastVelocity()

void deSmokeEmitter::SetMaxCastVelocity ( float velocity )

Set maximum cast velocity.

◆ SetMinCastDensity()

void deSmokeEmitter::SetMinCastDensity ( float density )

Set minimum cast density.

◆ SetMinCastDirection()

void deSmokeEmitter::SetMinCastDirection ( const decVector & deviation )

Set minimum cast direction deviation.

◆ SetMinCastVelocity()

void deSmokeEmitter::SetMinCastVelocity ( float velocity )

Set minimum cast velocity.

◆ SetParentWorld()

void deSmokeEmitter::SetParentWorld ( deWorld * world )

Set parent world or NULL.

◆ SetPeerGraphic()

void deSmokeEmitter::SetPeerGraphic ( deBaseGraphicSmokeEmitter * peer )

Set graphic system peer object.

◆ SetPeerPhysics()

void deSmokeEmitter::SetPeerPhysics ( deBasePhysicsSmokeEmitter * peer )

Set physics system peer object.

◆ SetPoints()

void deSmokeEmitter::SetPoints	(	deSmokeDensityPoint *	points,
		int	count
	)

Set points.

◆ SetSkin()

void deSmokeEmitter::SetSkin ( deSkin * skin )

Set mode of the particle instances or NULL.

◆ SetUseLocalGravity()

void deSmokeEmitter::SetUseLocalGravity ( bool useLocalGravity )

Set if local gravity has to be used instead of the world gravity.

◆ SetVolumePosition()

void deSmokeEmitter::SetVolumePosition ( const decDVector & position )

Set volume position.

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

deSmokeEmitter.h

Public Types

Public Member Functions

Constructors and Destructors

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ref

Constructor & Destructor Documentation

◆ deSmokeEmitter()

◆ ~deSmokeEmitter()

Member Function Documentation

◆ GetCastTexture()

◆ GetCollisionFilter()

◆ GetComponent()

◆ GetEmitterOrientation()

◆ GetEmitterPosition()

◆ GetEnableCasting()

◆ GetGravity()

◆ GetLLWorldNext()

◆ GetLLWorldPrev()

◆ GetMaxCastDensity()

◆ GetMaxCastDirection()

◆ GetMaxCastVelocity()

◆ GetMinCastDensity()

◆ GetMinCastDirection()

◆ GetMinCastVelocity()

◆ GetParentWorld()

◆ GetPeerGraphic()

◆ GetPeerPhysics()

◆ GetPointCount()

◆ GetPoints()

◆ GetSkin()

◆ GetUseLocalGravity()

◆ GetVolumePosition()

◆ NotifyPointsChanged()

◆ SetCastTexture()

◆ SetCollisionFilter()

◆ SetComponent()

◆ SetEmitterOrientation()

◆ SetEmitterPosition()

◆ SetEnableCasting()

◆ SetGravity()

◆ SetLLWorldNext()

◆ SetLLWorldPrev()

◆ SetMaxCastDensity()

◆ SetMaxCastDirection()

◆ SetMaxCastVelocity()

◆ SetMinCastDensity()

◆ SetMinCastDirection()

◆ SetMinCastVelocity()

◆ SetParentWorld()

◆ SetPeerGraphic()

◆ SetPeerPhysics()

◆ SetPoints()

◆ SetSkin()

◆ SetUseLocalGravity()

◆ SetVolumePosition()