StraightEmitter Class Reference

An Emitter that emits in a given direction. More...

Inheritance diagram for StraightEmitter:
Emitter Registerable Transformable

List of all members.

Public Member Functions

 StraightEmitter (const Vector3D &direction=Vector3D(0.0f, 0.0f,-1.0f))
 The constructor of StraightEmitter.
void setDirection (const Vector3D &direction)
 Sets the direction of this StraightEmitter.
const Vector3DgetDirection () const
 Gets the direction of this StraightEmitter.
const Vector3DgetTransformedDirection () const
 Gets the transformed direction of this StraightEmitter.

Static Public Member Functions

static StraightEmittercreate (const Vector3D &direction=Vector3D(0.0f, 0.0f,-1.0f))
 Creates and registers a new StraightEmitter.

Protected Member Functions

virtual void innerUpdateTransform ()
 Updates all the parameters in the world coordinates.

Detailed Description

An Emitter that emits in a given direction.

Definition at line 36 of file SPK_StraightEmitter.h.


Constructor & Destructor Documentation

StraightEmitter ( const Vector3D direction = Vector3D(0.0f, 0.0f,-1.0f)  ) 

The constructor of StraightEmitter.

Parameters:
direction : the direction of the StraighEmitter

Member Function Documentation

StraightEmitter * create ( const Vector3D direction = Vector3D(0.0f,0.0f,-1.0f)  )  [static]

Creates and registers a new StraightEmitter.

Parameters:
direction : the direction of the StraighEmitter
Since:
1.04.00

Definition at line 102 of file SPK_StraightEmitter.h.

const Vector3D & getDirection (  )  const

Gets the direction of this StraightEmitter.

Returns:
the direction of this StraightEmitter

Definition at line 109 of file SPK_StraightEmitter.h.

const Vector3D & getTransformedDirection (  )  const

Gets the transformed direction of this StraightEmitter.

Returns:
the transformed direction of this StraightEmitter

Definition at line 114 of file SPK_StraightEmitter.h.

virtual void innerUpdateTransform (  )  [protected, virtual]

Updates all the parameters in the world coordinates.

This method can be overriden in derived classes of Transformable (By default it does nothing).
It is this method task to compute all parameters of the class that are dependent of the world transform.

Reimplemented from Transformable.

void setDirection ( const Vector3D direction  ) 

Sets the direction of this StraightEmitter.

Note that it is not necessary to provide a normalized Vector3D. This Vector3D only indicates a direction, its norm does not matter.

Parameters:
direction : the direction of this StraightEmitter

Generated on Wed Apr 27 21:09:26 2011 for SPARK Particle Engine by  doxygen 1.6.1