QSDK 1.1 Documentation

Q::FxSource Struct Reference
[Particle Effects]

Particle-generating Geom. More...

#include <Q/q.h>

Inheritance diagram for Q::FxSource:

List of all members.

Public Member Functions
Maths::Vec3f	gravity () const
Utils::Result	setGravity (const Maths::Vec3f &)
float	generationRate () const
Utils::Result	setGenerationRate (float)
FxClassSequence	fxClassSequence () const
Utils::Result	setFxClassSequence (const FxClassSequence &fxcs)
Static Public Member Functions
ClassType	classType ()
FxSource	cast (const ObjectBase &)

---

Detailed Description

Particle-generating Geom.

An FxSource defines how atoms (defined by a derived class of FxClass) are distributed in space, and how the distribution evolves in time. This is a base class which must be subclassed for individual source shape types, e.g. FxSourceCuboid.

The FxSource class defines an FxClassSequence used to display the atoms. The atoms transmute from one class to the next as the life for the current class expires.

In addition to the parameters defined by FxClass and its derived classes, the FxSource defines a direction and magnitude for gravity and a generation rate for atoms.

See also:

QDemo2 production guide for guidance on how to build and import particle effects in Q files.

---

Member Function Documentation

FxSource Q::FxSource::cast (  const ObjectBase &   )  [static]

If the object referenced by obj is a group, then return a suitable FxSource reference to the object. Note: Casting this object will cause it to be loaded from the database if it is not currently resident. Reimplemented from Q::Geom. Reimplemented in Q::FxSourceCuboid.

ClassType Q::FxSource::classType (   )  [static]

Return the type for this class Reimplemented in Q::FxSourceCuboid.

FxClassSequence Q::FxSource::fxClassSequence (   )  const

Return the class sequence used to define the behaviour of atoms generated by this source.

float Q::FxSource::generationRate (   )  const

Return the generation rate for this source. The generation rate value is the number of atoms per second which. These atoms are emitted continuously and uniformly. In the future, it may be possible to control this with automation.

Maths::Vec3f Q::FxSource::gravity (   )  const

Return the value of gravity for atoms generated by this source. The magnitude of the vector defines the gravitational acceleration and the direction defines the directional of the gravitational pull.

Utils::Result Q::FxSource::setFxClassSequence (  const FxClassSequence &  fxcs  )

Set the class sequence for this source.

Utils::Result Q::FxSource::setGenerationRate (  float   )

Set the generation rate for this source.

Utils::Result Q::FxSource::setGravity (  const Maths::Vec3f &   )

Set the value of gravity for this source.

		Qube Software Limited © 2000-2004