IMXSParticleContainer.h

Module description

Functions
virtual IObject *	GetParticleContainer () const =0
	The non-maxscript-version of particle container in the Init/Proceed/Release calls for operator and test. More...
virtual Object *	GetParticleSystem () const =0
	The particle system in the Init/Proceed/Release calls for operator and test. More...
virtual INode *	GetParticleSystemNode () const =0
	The particle system node in the Init/Proceed/Release calls for operator and test. More...
virtual Tab< Object * > &	GetInitActions ()=0
	The list of actions during initialization in the Init/Proceed/Release calls for operator and test. More...
virtual Tab< INode * > &	GetInitActionNodes ()=0
	The list of action nodes during initialization in the Init/Proceed/Release calls for operator and test. More...
virtual TimeValue	GetTimeStart () const =0
	Start of the proceed interval in the Init/Proceed/Release calls for operator and test. More...
virtual TimeValue	GetTimeEnd () const =0
	End of the proceed interval in the Init/Proceed/Release calls for operator and test. More...
virtual void	SetTimeEnd (TimeValue time)=0
	Set the end time if the operator can't proceed particles to the given time end in the Init/Proceed/Release calls for operator. More...
virtual void	SetTimeEnd (TimeValue time, float timeDelta)=0
	Set the end time if the test can't proceed particles to the given time end in the Init/Proceed/Release calls for test. More...
virtual INode *	GetActionNode () const =0
	The node of the action in the Init/Proceed/Release calls for operator and test. More...
virtual FPInterface *	GetIntegrator () const =0
	Update cycle integrator in the Init/Proceed/Release calls for operator and test. More...
virtual int	RandSign (void)=0
	Get random sign { -1, 1 }. More...
virtual float	Rand01 (void)=0
	Get random number between 0.0f and 1.0f. More...
virtual float	Rand11 (void)=0
	Get random number between -1.0f and 1.0f. More...
virtual float	Rand55 (void)=0
	Get random number between -0.5f and 0.5f. More...
virtual int	Rand0X (int maxnum)=0
	Get integer random number between 0 and maxnum. More...
virtual Point3 *	RandSpherePoint ()=0
	Get random point from sphere surface of radius 1. More...
virtual Point3 *	RandDivergeVector (Point3 vec, float maxAngle)=0
	Returns a vector with the same length as a given vector but the direction differs from the given for no more than maxAngle. More...
virtual bool	GetUseTime () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseTime (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseAge () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseAge (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseLifespan () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseLifespan (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseEventTime () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseEventTime (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUsePosition () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUsePosition (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseSpeed () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseSpeed (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseAcceleration () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseAcceleration (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseOrientation () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseOrientation (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseSpin () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseSpin (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseScale () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseScale (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseTM () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseTM (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseSelected () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseSelected (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseShape () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseShape (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseMtlIndex () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseMtlIndex (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseMapping () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseMapping (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseInt () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseInt (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseFloat () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseFloat (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseVector () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseVector (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual bool	GetUseMatrix () const =0
	Used to define whether particle channel will be used by the operator/test. More...
virtual void	SetUseMatrix (bool use)=0
	Used to define whether particle channel will be used by the operator/test. More...
virtual int	NumParticles ()=0
	Method to get/set properties of the particle in the container. More...
virtual bool	AddParticle ()=0
	Add a single particle to particle system. More...
virtual bool	AddParticles (int num)=0
	Add "num" particles into the particle system. More...
virtual bool	DeleteParticle (int index)=0
	Delete a single particle with the given index. More...
virtual bool	DeleteParticles (int start, int num)=0
	List-type delete of "num" particles starting with "start". More...
virtual int	GetParticleBornIndex (int i)=0
	Each particle is given a unique ID (consecutive) upon its birth. More...
virtual bool	HasParticleBornIndex (int bornIndex, int &index)=0
	Implemented by the Plug-In. More...
virtual int	GetCurrentParticleIndex ()=0
	Defines "current" index, used to get the property without specifying the index. More...
virtual int	GetCurrentParticleBornIndex ()=0
	Defines "current" bornIndex, used to get the property without specifying the index. More...
virtual void	SetCurrentParticleIndex (int index)=0
	Defines "current" index, used to set the property without specifying the index. More...
virtual void	SetCurrentParticleBornIndex (int bornIndex)=0
	Defines "current" bornIndex, used to set the property without specifying the index. More...
virtual bool	IsParticleNewByIndex (int index)=0
	Defines if a particle just arrived into the current event. More...
virtual bool	IsParticleNewByBornIndex (int id)=0
	See IsParticleNewByIndex(). More...
virtual bool	IsParticleNew ()=0
	See IsParticleNewByIndex(). More...
virtual TimeValue	GetParticleTimeByIndex (int index)=0
	Defines time for the current state for a particle. More...
virtual TimeValue	GetParticleTimeByBornIndex (int id)=0
	See GetParticleTimeByIndex(). More...
virtual void	SetParticleTimeByIndex (int index, TimeValue time)=0
	See GetParticleTimeByIndex(). More...
virtual void	SetParticleTimeByIndex (int index, TimeValue time, float timeDelta)=0
	See GetParticleTimeByIndex(). More...
virtual void	SetParticleTimeByBornIndex (int id, TimeValue time)=0
	See GetParticleTimeByIndex(). More...
virtual void	SetParticleTimeByBornIndex (int id, TimeValue time, float timeDelta)=0
	See GetParticleTimeByIndex(). More...
virtual TimeValue	GetParticleTime ()=0
	See GetParticleTimeByIndex(). More...
virtual void	SetParticleTime (TimeValue time)=0
	See GetParticleTimeByIndex(). More...
virtual TimeValue	GetParticleAgeByIndex (int index)=0
	Defines age of the specified particle. More...
virtual TimeValue	GetParticleAgeByBornIndex (int id)=0
	See GetParticleAgeByIndex(). More...
virtual void	SetParticleAgeByIndex (int index, TimeValue age)=0
	See GetParticleAgeByIndex(). More...
virtual void	SetParticleAgeByBornIndex (int id, TimeValue age)=0
	See GetParticleAgeByIndex(). More...
virtual TimeValue	GetParticleAge ()=0
	See GetParticleAgeByIndex(). More...
virtual void	SetParticleAge (TimeValue age)=0
	See GetParticleAgeByIndex(). More...
virtual TimeValue	GetParticleLifespanByIndex (int index)=0
	Defines lifespan of the specified particle. More...
virtual TimeValue	GetParticleLifespanByBornIndex (int id)=0
	See GetParticleLifespanByIndex(). More...
virtual void	SetParticleLifespanByIndex (int index, TimeValue lifespan)=0
	See GetParticleLifespanByIndex(). More...
virtual void	SetParticleLifespanByBornIndex (int id, TimeValue lifespan)=0
	See GetParticleLifespanByIndex(). More...
virtual TimeValue	GetParticleLifespan ()=0
	See GetParticleLifespanByIndex(). More...
virtual void	SetParticleLifespan (TimeValue lifespan)=0
	See GetParticleLifespanByIndex(). More...
virtual TimeValue	GetParticleEventTimeByIndex (int index)=0
	Defines for how long the specified particle was staying in the current action list (event). More...
virtual TimeValue	GetParticleEventTimeByBornIndex (int id)=0
	See GetParticleEventTimeByIndex(). More...
virtual void	SetParticleEventTimeByIndex (int index, TimeValue time)=0
	See GetParticleEventTimeByIndex(). More...
virtual void	SetParticleEventTimeByBornIndex (int id, TimeValue time)=0
	See GetParticleEventTimeByIndex(). More...
virtual TimeValue	GetParticleEventTime ()=0
	See GetParticleEventTimeByIndex(). More...
virtual void	SetParticleEventTime (TimeValue time)=0
	See GetParticleEventTimeByIndex(). More...
virtual Point3 *	GetParticlePositionByIndex (int index)=0
	Defines position of the specified particle in the current state. More...
virtual Point3 *	GetParticlePositionByBornIndex (int id)=0
	See GetParticlePositionByIndex(). More...
virtual void	SetParticlePositionByIndex (int index, Point3 pos)=0
	See GetParticlePositionByIndex(). More...
virtual void	SetParticlePositionByBornIndex (int id, Point3 pos)=0
	See GetParticlePositionByIndex(). More...
virtual Point3 *	GetParticlePosition ()=0
	See GetParticlePositionByIndex(). More...
virtual void	SetParticlePosition (Point3 pos)=0
	See GetParticlePositionByIndex(). More...
virtual Point3 *	GetParticleSpeedByIndex (int index)=0
	Defines speed of the specified particle in the current state. More...
virtual Point3 *	GetParticleSpeedByBornIndex (int id)=0
	See GetParticleSpeedByIndex(). More...
virtual void	SetParticleSpeedByIndex (int index, Point3 speed)=0
	See GetParticleSpeedByIndex(). More...
virtual void	SetParticleSpeedByBornIndex (int id, Point3 speed)=0
	See GetParticleSpeedByIndex(). More...
virtual Point3 *	GetParticleSpeed ()=0
	See GetParticleSpeedByIndex(). More...
virtual void	SetParticleSpeed (Point3 speed)=0
	See GetParticleSpeedByIndex(). More...
virtual Point3 *	GetParticleAccelerationByIndex (int index)=0
	Defines acceleration of the specified particle in the current state. More...
virtual Point3 *	GetParticleAccelerationByBornIndex (int id)=0
	See GetParticleAccelerationByIndex(). More...
virtual void	SetParticleAccelerationByIndex (int index, Point3 accel)=0
	See GetParticleAccelerationByIndex(). More...
virtual void	SetParticleAccelerationByBornIndex (int id, Point3 accel)=0
	See GetParticleAccelerationByIndex(). More...
virtual Point3 *	GetParticleAcceleration ()=0
	See GetParticleAccelerationByIndex(). More...
virtual void	SetParticleAcceleration (Point3 speed)=0
	See GetParticleAccelerationByIndex(). More...
virtual Point3 *	GetParticleOrientationByIndex (int index)=0
	Defines orientation of the specified particle in the current state. More...
virtual Point3 *	GetParticleOrientationByBornIndex (int id)=0
	See GetParticleOrientationByIndex(). More...
virtual void	SetParticleOrientationByIndex (int index, Point3 orient)=0
	See GetParticleOrientationByIndex(). More...
virtual void	SetParticleOrientationByBornIndex (int id, Point3 orient)=0
	See GetParticleOrientationByIndex(). More...
virtual Point3 *	GetParticleOrientation ()=0
	See GetParticleOrientationByIndex(). More...
virtual void	SetParticleOrientation (Point3 orient)=0
	See GetParticleOrientationByIndex(). More...
virtual AngAxis *	GetParticleSpinByIndex (int index)=0
	Defines angular speed of the specified particle in the current state. More...
virtual AngAxis *	GetParticleSpinByBornIndex (int id)=0
	See GetParticleSpinByIndex(). More...
virtual void	SetParticleSpinByIndex (int index, AngAxis spin)=0
	See GetParticleSpinByIndex(). More...
virtual void	SetParticleSpinByBornIndex (int id, AngAxis spin)=0
	See GetParticleSpinByIndex(). More...
virtual AngAxis *	GetParticleSpin ()=0
	See GetParticleSpinByIndex(). More...
virtual void	SetParticleSpin (AngAxis spin)=0
	See GetParticleSpinByIndex(). More...
virtual float	GetParticleScaleByIndex (int index)=0
	Defines scale factor of the specified particle in the current state. More...
virtual float	GetParticleScaleByBornIndex (int id)=0
	See GetParticleScaleByIndex(). More...
virtual void	SetParticleScaleByIndex (int index, float scale)=0
	See GetParticleScaleByIndex(). More...
virtual void	SetParticleScaleByBornIndex (int id, float scale)=0
	See GetParticleScaleByIndex(). More...
virtual float	GetParticleScale ()=0
	See GetParticleScaleByIndex(). More...
virtual void	SetParticleScale (float scale)=0
	See GetParticleScaleByIndex(). More...
virtual Point3 *	GetParticleScaleXYZByIndex (int index)=0
	See GetParticleScaleByIndex(). More...
virtual Point3 *	GetParticleScaleXYZByBornIndex (int id)=0
	See GetParticleScaleByIndex(). More...
virtual void	SetParticleScaleXYZByIndex (int index, Point3 scale)=0
	See GetParticleScaleByIndex(). More...
virtual void	SetParticleScaleXYZByBornIndex (int id, Point3 scale)=0
	See GetParticleScaleByIndex(). More...
virtual Point3 *	GetParticleScaleXYZ ()=0
	See GetParticleScaleByIndex(). More...
virtual void	SetParticleScaleXYZ (Point3 scale)=0
	See GetParticleScaleByIndex(). More...
virtual Matrix3 *	GetParticleTMByIndex (int index)=0
	Defines transformation matrix of the specified particle in the current state. More...
virtual Matrix3 *	GetParticleTMByBornIndex (int id)=0
	See GetParticleTMByIndex(). More...
virtual void	SetParticleTMByIndex (int index, Matrix3 tm)=0
	See GetParticleTMByIndex(). More...
virtual void	SetParticleTMByBornIndex (int id, Matrix3 tm)=0
	See GetParticleTMByIndex(). More...
virtual Matrix3 *	GetParticleTM ()=0
	See GetParticleTMByIndex(). More...
virtual void	SetParticleTM (Matrix3 tm)=0
	See GetParticleTMByIndex(). More...
virtual bool	GetParticleSelectedByIndex (int index)=0
	Defines selection status of the specified particle in the current state. More...
virtual bool	GetParticleSelectedByBornIndex (int id)=0
	See GetParticleSelectedByIndex(). More...
virtual void	SetParticleSelectedByIndex (int index, bool selected)=0
	See GetParticleSelectedByIndex(). More...
virtual void	SetParticleSelectedByBornIndex (int id, bool selected)=0
	See GetParticleSelectedByIndex(). More...
virtual bool	GetParticleSelected ()=0
	See GetParticleSelectedByIndex(). More...
virtual void	SetParticleSelected (bool selected)=0
	See GetParticleSelectedByIndex(). More...
virtual Mesh *	GetParticleShapeByIndex (int index)=0
	Defines shape of the specified particle in the current state. More...
virtual Mesh *	GetParticleShapeByBornIndex (int id)=0
	See GetParticleShapeByIndex(). More...
virtual void	SetParticleShapeByIndex (int index, Mesh *shape)=0
	See GetParticleShapeByIndex(). More...
virtual void	SetParticleShapeByBornIndex (int id, Mesh *shape)=0
	See GetParticleShapeByIndex(). More...
virtual Mesh *	GetParticleShape ()=0
	See GetParticleShapeByIndex(). More...
virtual void	SetParticleShape (Mesh *shape)=0
	See GetParticleShapeByIndex(). More...
virtual void	SetGlobalParticleShape (Mesh *shape)=0
	Set the same shape for all particles. More...
virtual void	SetParticleMtlIndexByIndex (int index, int mtlIndex)=0
	Defines material index of the specified particle in the current state. More...
virtual void	SetParticleMtlIndexByBornIndex (int id, int mtlIndex)=0
	See SetParticleMtlIndexByIndex(). More...
virtual void	SetParticleMtlIndex (int mtlIndex)=0
	See SetParticleMtlIndexByIndex(). More...
virtual void	SetParticleMappingByIndex (int index, int mapChannel, UVVert mapValue)=0
	Defines mapping of the specified particle in the current state. More...
virtual void	SetParticleMappingByBornIndex (int id, int mapChannel, UVVert mapValue)=0
	See SetParticleMappingByIndex(). More...
virtual void	SetParticleMapping (int mapChannel, UVVert mapValue)=0
	See SetParticleMappingByIndex(). More...
virtual int	GetParticleIntByIndex (int index)=0
	Defines integer value of the specified particle. More...
virtual int	GetParticleIntByBornIndex (int id)=0
	See GetParticleIntByIndex(). More...
virtual void	SetParticleIntByIndex (int index, int value)=0
	See GetParticleIntByIndex(). More...
virtual void	SetParticleIntByBornIndex (int id, int value)=0
	See GetParticleIntByIndex(). More...
virtual int	GetParticleInt ()=0
	See GetParticleIntByIndex(). More...
virtual void	SetParticleInt (int value)=0
	See GetParticleIntByIndex(). More...
virtual float	GetParticleFloatByIndex (int index)=0
	Defines float value of the specified particle. More...
virtual float	GetParticleFloatByBornIndex (int id)=0
	See GetParticleFloatByIndex(). More...
virtual void	SetParticleFloatByIndex (int index, float value)=0
	See GetParticleFloatByIndex(). More...
virtual void	SetParticleFloatByBornIndex (int id, float value)=0
	See GetParticleFloatByIndex(). More...
virtual float	GetParticleFloat ()=0
	See GetParticleFloatByIndex(). More...
virtual void	SetParticleFloat (float value)=0
	See GetParticleFloatByIndex(). More...
virtual Point3 *	GetParticleVectorByIndex (int index)=0
	Defines vector value of the specified particle. More...
virtual Point3 *	GetParticleVectorByBornIndex (int id)=0
	See GetParticleVectorByIndex(). More...
virtual void	SetParticleVectorByIndex (int index, Point3 value)=0
	See GetParticleVectorByIndex(). More...
virtual void	SetParticleVectorByBornIndex (int id, Point3 value)=0
	See GetParticleVectorByIndex(). More...
virtual Point3 *	GetParticleVector ()=0
	See GetParticleVectorByIndex(). More...
virtual void	SetParticleVector (Point3 value)=0
	See GetParticleVectorByIndex(). More...
virtual Matrix3 *	GetParticleMatrixByIndex (int index)=0
	Defines matrix value of the specified particle. More...
virtual Matrix3 *	GetParticleMatrixByBornIndex (int id)=0
	See GetParticleMatrixByIndex(). More...
virtual void	SetParticleMatrixByIndex (int index, Matrix3 value)=0
	See GetParticleMatrixByIndex(). More...
virtual void	SetParticleMatrixByBornIndex (int id, Matrix3 value)=0
	See GetParticleMatrixByIndex(). More...
virtual Matrix3 *	GetParticleMatrix ()=0
	See GetParticleMatrixByIndex(). More...
virtual void	SetParticleMatrix (Matrix3 value)=0
	See GetParticleMatrixByIndex(). More...
virtual void	SetParticleTestStatusByIndex (int index, bool testStatus)=0
	Defines test status (true or false) for particles while testing. More...
virtual void	SetParticleTestStatusByBornIndex (int id, bool testStatus)=0
	See SetParticleTestStatusByIndex() More...
virtual bool	GetParticleTestStatus ()=0
	See SetParticleTestStatusByIndex() More...
virtual void	SetParticleTestStatus (bool testStatus)=0
	See SetParticleTestStatusByIndex(). More...
virtual void	SetGlobalTestStatus (bool testStatus)=0
	Set the same test status for all particles. More...
virtual void	SetParticleTestTimeByIndex (int index, TimeValue testTime)=0
	Defines the time when a particle satisfies the test. More...
virtual void	SetParticleTestTimeByIndex (int index, TimeValue testTime, float testTimeDelta)=0
	See SetParticleTestTimeByIndex(). More...
virtual void	SetParticleTestTimeByBornIndex (int id, TimeValue testTime)=0
	See SetParticleTestTimeByIndex(). More...
virtual void	SetParticleTestTimeByBornIndex (int id, TimeValue testTime, float testTimeDelta)=0
	See SetParticleTestTimeByIndex(). More...
virtual TimeValue	GetParticleTestTime ()=0
	See SetParticleTestTimeByIndex(). More...
virtual void	SetParticleTestTime (TimeValue testTime)=0
	See SetParticleTestTimeByIndex(). More...
virtual void	SetParticleTestTime (TimeValue testTime, float testTimeDelta)=0
	See SetParticleTestTimeByIndex(). More...
virtual void	SetGlobalTestTime (TimeValue testTime)=0
	set the same test status for all particles More...
virtual void	SetGlobalTestTime (TimeValue testTime, float testTimeDelta)=0
	set the same test status for all particles More...
FPInterfaceDesc *	GetDesc ()

Function Documentation

IObject * GetParticleContainer ( ) const

pure virtual

The non-maxscript-version of particle container in the Init/Proceed/Release calls for operator and test.

Object * GetParticleSystem ( ) const

pure virtual

The particle system in the Init/Proceed/Release calls for operator and test.

INode * GetParticleSystemNode ( ) const

pure virtual

The particle system node in the Init/Proceed/Release calls for operator and test.

Tab< Object * > & GetInitActions ( )

pure virtual

The list of actions during initialization in the Init/Proceed/Release calls for operator and test.

Tab< INode * > & GetInitActionNodes ( )

pure virtual

The list of action nodes during initialization in the Init/Proceed/Release calls for operator and test.

TimeValue GetTimeStart ( ) const

pure virtual

Start of the proceed interval in the Init/Proceed/Release calls for operator and test.

TimeValue GetTimeEnd ( ) const

pure virtual

End of the proceed interval in the Init/Proceed/Release calls for operator and test.

void SetTimeEnd ( TimeValue  time )

pure virtual

Set the end time if the operator can't proceed particles to the given time end in the Init/Proceed/Release calls for operator.

void SetTimeEnd ( TimeValue  time, float  timeDelta  )

pure virtual

Set the end time if the test can't proceed particles to the given time end in the Init/Proceed/Release calls for test.

INode * GetActionNode ( ) const

pure virtual

The node of the action in the Init/Proceed/Release calls for operator and test.

FPInterface * GetIntegrator ( ) const

pure virtual

Update cycle integrator in the Init/Proceed/Release calls for operator and test.

int RandSign ( void  )

pure virtual

Get random sign { -1, 1 }.

float Rand01 ( void  )

pure virtual

Get random number between 0.0f and 1.0f.

float Rand11 ( void  )

pure virtual

Get random number between -1.0f and 1.0f.

float Rand55 ( void  )

pure virtual

Get random number between -0.5f and 0.5f.

int Rand0X ( int  maxnum )

pure virtual

Get integer random number between 0 and maxnum.

Point3 * RandSpherePoint ( )

pure virtual

Get random point from sphere surface of radius 1.

Point3 * RandDivergeVector ( Point3  vec, float  maxAngle  )

pure virtual

Returns a vector with the same length as a given vector but the direction differs from the given for no more than maxAngle.

bool GetUseTime ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseTime ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseAge ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseAge ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseLifespan ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseLifespan ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseEventTime ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseEventTime ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUsePosition ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUsePosition ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseSpeed ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseSpeed ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseAcceleration ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseAcceleration ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseOrientation ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseOrientation ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseSpin ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseSpin ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseScale ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseScale ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseTM ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseTM ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseSelected ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseSelected ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseShape ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseShape ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseMtlIndex ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseMtlIndex ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseMapping ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseMapping ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseInt ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseInt ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseFloat ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseFloat ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseVector ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseVector ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

bool GetUseMatrix ( ) const

pure virtual

Used to define whether particle channel will be used by the operator/test.

void SetUseMatrix ( bool  use )

pure virtual

Used to define whether particle channel will be used by the operator/test.

int NumParticles ( )

pure virtual

Method to get/set properties of the particle in the container.

bool AddParticle ( )

pure virtual

Add a single particle to particle system.

Returns true if the operation was completed successfully.

bool AddParticles ( int  num )

pure virtual

Add "num" particles into the particle system.

Returns true if the operation was completed successfully.

bool DeleteParticle ( int  index )

pure virtual

Delete a single particle with the given index.

Returns true if the operation was completed successfully.

bool DeleteParticles ( int  start, int  num  )

pure virtual

List-type delete of "num" particles starting with "start".

Returns true if the operation was completed successfully.

int GetParticleBornIndex ( int  i )

pure virtual

Each particle is given a unique ID (consecutive) upon its birth.

The method allows us to distinguish physically different particles even if they are using the same particle index (because of the "index reusing").

Parameters

i	index of the particle in the range of [0, NumParticles-1]

bool HasParticleBornIndex ( int  bornIndex, int &  index  )

pure virtual

Implemented by the Plug-In.

The methods verifies if a particle with a given particle id (born index) is present in the particle container. The methods returns index in the container. If there is no such particle, the method returns false.

Parameters

bornIndex	particle born index
index	particle index in the particle group or particle system

int GetCurrentParticleIndex ( )

pure virtual

Defines "current" index, used to get the property without specifying the index.

int GetCurrentParticleBornIndex ( )

pure virtual

Defines "current" bornIndex, used to get the property without specifying the index.

void SetCurrentParticleIndex ( int  index )

pure virtual

Defines "current" index, used to set the property without specifying the index.

void SetCurrentParticleBornIndex ( int  bornIndex )

pure virtual

Defines "current" bornIndex, used to set the property without specifying the index.

bool IsParticleNewByIndex ( int  index )

pure virtual

Defines if a particle just arrived into the current event.

Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle container

bool IsParticleNewByBornIndex ( int  id )

pure virtual

See IsParticleNewByIndex().

Parameters

id	particle born index

bool IsParticleNew ( )

pure virtual

See IsParticleNewByIndex().

TimeValue GetParticleTimeByIndex ( int  index )

pure virtual

Defines time for the current state for a particle.

Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used. Modification of the time is only accessible for tests, and only for particles that satisfy the test.

Parameters

index

int, particle index in the particle container

TimeValue GetParticleTimeByBornIndex ( int  id )

pure virtual

See GetParticleTimeByIndex().

Parameters

id	int, particle born index

void SetParticleTimeByIndex ( int  index, TimeValue  time  )

pure virtual

See GetParticleTimeByIndex().

Parameters

index	int, particle index in the particle container
time	TimeValue, time of the current state for the particle

void SetParticleTimeByIndex ( int  index, TimeValue  time, float  timeDelta  )

pure virtual

See GetParticleTimeByIndex().

Parameters

index	int, particle index in the particle container
time	TimeValue, time of the current state for the particle
timeDelta	float, if you need more precision to set time value then use the timeDelta parameter

void SetParticleTimeByBornIndex ( int  id, TimeValue  time  )

pure virtual

See GetParticleTimeByIndex().

Parameters

id	int, particle born index
time	TimeValue, time of the current state for the particle

void SetParticleTimeByBornIndex ( int  id, TimeValue  time, float  timeDelta  )

pure virtual

See GetParticleTimeByIndex().

Parameters

id	int, particle born index
time	TimeValue, time of the current state for the particle
timeDelta	float, if you need more precision to set time value then use the timeDelta parameter

TimeValue GetParticleTime ( )

pure virtual

See GetParticleTimeByIndex().

void SetParticleTime ( TimeValue  time )

pure virtual

See GetParticleTimeByIndex().

Parameters

time	TimeValue, time of the current state for the particle

TimeValue GetParticleAgeByIndex ( int  index )

pure virtual

Defines age of the specified particle.

Particle is specified by either its index in the particle group or particle system, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle group

TimeValue GetParticleAgeByBornIndex ( int  id )

pure virtual

See GetParticleAgeByIndex().

Parameters

id	particle born index

void SetParticleAgeByIndex ( int  index, TimeValue  age  )

pure virtual

See GetParticleAgeByIndex().

Parameters

index	particle index in the particle group
age	new age value to set for a particle

void SetParticleAgeByBornIndex ( int  id, TimeValue  age  )

pure virtual

See GetParticleAgeByIndex().

Parameters

id	particle born index
age	new age value to set for a particle

TimeValue GetParticleAge ( )

pure virtual

See GetParticleAgeByIndex().

void SetParticleAge ( TimeValue  age )

pure virtual

See GetParticleAgeByIndex().

Parameters

age	new age value to set for a particle

TimeValue GetParticleLifespanByIndex ( int  index )

pure virtual

Defines lifespan of the specified particle.

Particle is specified by either its index in the particle group or particle system, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle group

TimeValue GetParticleLifespanByBornIndex ( int  id )

pure virtual

See GetParticleLifespanByIndex().

Parameters

id	particle born index

void SetParticleLifespanByIndex ( int  index, TimeValue  lifespan  )

pure virtual

See GetParticleLifespanByIndex().

Parameters

index	particle index in the particle group
lifespan	new lifespan value to set for a particle

void SetParticleLifespanByBornIndex ( int  id, TimeValue  lifespan  )

pure virtual

See GetParticleLifespanByIndex().

Parameters

id	particle born index
lifespan	new lifespan value to set for a particle

TimeValue GetParticleLifespan ( )

pure virtual

See GetParticleLifespanByIndex().

void SetParticleLifespan ( TimeValue  lifespan )

pure virtual

See GetParticleLifespanByIndex().

Parameters

lifespan

new lifespan value to set for a particle

TimeValue GetParticleEventTimeByIndex ( int  index )

pure virtual

Defines for how long the specified particle was staying in the current action list (event).

Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle container

TimeValue GetParticleEventTimeByBornIndex ( int  id )

pure virtual

See GetParticleEventTimeByIndex().

Parameters

id	particle born index

void SetParticleEventTimeByIndex ( int  index, TimeValue  time  )

pure virtual

See GetParticleEventTimeByIndex().

Parameters

index	particle index in the particle container
time	how long particle was staying in the current action list (event)

void SetParticleEventTimeByBornIndex ( int  id, TimeValue  time  )

pure virtual

See GetParticleEventTimeByIndex().

Parameters

id	particle born index
time	how long particle was staying in the current action list (event)

TimeValue GetParticleEventTime ( )

pure virtual

See GetParticleEventTimeByIndex().

void SetParticleEventTime ( TimeValue  time )

pure virtual

See GetParticleEventTimeByIndex().

Parameters

time	how long particle was staying in the current action list (event)

Point3 * GetParticlePositionByIndex ( int  index )

pure virtual

Defines position of the specified particle in the current state.

Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle group

Point3 * GetParticlePositionByBornIndex ( int  id )

pure virtual

See GetParticlePositionByIndex().

Parameters

id	particle born index

void SetParticlePositionByIndex ( int  index, Point3  pos  )

pure virtual

See GetParticlePositionByIndex().

Parameters

index	particle index in the particle group
pos	position of the particle

void SetParticlePositionByBornIndex ( int  id, Point3  pos  )

pure virtual

See GetParticlePositionByIndex().

Parameters

id	particle born index
pos	position of the particle

Point3 * GetParticlePosition ( )

pure virtual

See GetParticlePositionByIndex().

void SetParticlePosition ( Point3  pos )

pure virtual

See GetParticlePositionByIndex().

Parameters

pos	position of the particle

Point3 * GetParticleSpeedByIndex ( int  index )

pure virtual

Defines speed of the specified particle in the current state.

Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle group

Point3 * GetParticleSpeedByBornIndex ( int  id )

pure virtual

See GetParticleSpeedByIndex().

Parameters

id	particle born index

void SetParticleSpeedByIndex ( int  index, Point3  speed  )

pure virtual

See GetParticleSpeedByIndex().

Parameters

index	particle index in the particle group
speed	speed of the particle in units per frame

void SetParticleSpeedByBornIndex ( int  id, Point3  speed  )

pure virtual

See GetParticleSpeedByIndex().

Parameters

id	particle born index
speed	speed of the particle in units per frame

Point3 * GetParticleSpeed ( )

pure virtual

See GetParticleSpeedByIndex().

void SetParticleSpeed ( Point3  speed )

pure virtual

See GetParticleSpeedByIndex().

Parameters

speed

speed of the particle in units per frame

Point3 * GetParticleAccelerationByIndex ( int  index )

pure virtual

Defines acceleration of the specified particle in the current state.

Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used. The acceleration is reset in the each update cycle so the operator/test should update it for each particle in each proceed call.

Parameters

index

particle index in the particle group

Point3 * GetParticleAccelerationByBornIndex ( int  id )

pure virtual

See GetParticleAccelerationByIndex().

Parameters

id	particle born index

void SetParticleAccelerationByIndex ( int  index, Point3  accel  )

pure virtual

See GetParticleAccelerationByIndex().

Parameters

index	particle index in the particle group
accel	acceleration of the particle in units per frame squared

void SetParticleAccelerationByBornIndex ( int  id, Point3  accel  )

pure virtual

See GetParticleAccelerationByIndex().

Parameters

id	particle born index
accel	acceleration of the particle in units per frame squared

Point3 * GetParticleAcceleration ( )

pure virtual

See GetParticleAccelerationByIndex().

void SetParticleAcceleration ( Point3  speed )

pure virtual

See GetParticleAccelerationByIndex().

Parameters

speed

acceleration of the particle in units per frame squared

Point3 * GetParticleOrientationByIndex ( int  index )

pure virtual

Defines orientation of the specified particle in the current state.

Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle group

Point3 * GetParticleOrientationByBornIndex ( int  id )

pure virtual

See GetParticleOrientationByIndex().

Parameters

id	particle born index

void SetParticleOrientationByIndex ( int  index, Point3  orient  )

pure virtual

See GetParticleOrientationByIndex().

Parameters

index	particle index in the particle group
orient	orientation of the particle. The orientation is defined by incremental rotations by world axes X, Y and Z. The rotation values are in degrees.

void SetParticleOrientationByBornIndex ( int  id, Point3  orient  )

pure virtual

See GetParticleOrientationByIndex().

Parameters

id	particle born index
orient	orientation of the particle. The orientation is defined by incremental rotations by world axes X, Y and Z. The rotation values are in degrees.

Point3 * GetParticleOrientation ( )

pure virtual

See GetParticleOrientationByIndex().

void SetParticleOrientation ( Point3  orient )

pure virtual

See GetParticleOrientationByIndex().

Parameters

orient

orientation of the particle. The orientation is defined by incremental rotations by world axes X, Y and Z. The rotation values are in degrees.

AngAxis * GetParticleSpinByIndex ( int  index )

pure virtual

Defines angular speed of the specified particle in the current state.

Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle group

AngAxis * GetParticleSpinByBornIndex ( int  id )

pure virtual

See GetParticleSpinByIndex().

Parameters

id	particle born index

void SetParticleSpinByIndex ( int  index, AngAxis  spin  )

pure virtual

See GetParticleSpinByIndex().

Parameters

index	particle index in the particle group
spin	angular speed of the particle in rotation per frame, axis defines rotation axis, angle defines rotation amount per frame

void SetParticleSpinByBornIndex ( int  id, AngAxis  spin  )

pure virtual

See GetParticleSpinByIndex().

Parameters

id	particle born index
spin	angular speed of the particle in rotation per frame, axis defines rotation axis, angle defines rotation amount per frame

AngAxis * GetParticleSpin ( )

pure virtual

See GetParticleSpinByIndex().

void SetParticleSpin ( AngAxis  spin )

pure virtual

See GetParticleSpinByIndex().

Parameters

spin	angular speed of the particle in rotation per frame, axis defines rotation axis, angle defines rotation amount per frame

float GetParticleScaleByIndex ( int  index )

pure virtual

Defines scale factor of the specified particle in the current state.

The XYZ form is used for non-uniform scaling. Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle group

float GetParticleScaleByBornIndex ( int  id )

pure virtual

See GetParticleScaleByIndex().

Parameters

id	particle born index

void SetParticleScaleByIndex ( int  index, float  scale  )

pure virtual

See GetParticleScaleByIndex().

Parameters

index	particle index in the particle group
scale	uniform scale factor

void SetParticleScaleByBornIndex ( int  id, float  scale  )

pure virtual

See GetParticleScaleByIndex().

Parameters

id	particle born index
scale	uniform scale factor

float GetParticleScale ( )

pure virtual

See GetParticleScaleByIndex().

void SetParticleScale ( float  scale )

pure virtual

See GetParticleScaleByIndex().

Parameters

scale

uniform scale factor

Point3 * GetParticleScaleXYZByIndex ( int  index )

pure virtual

See GetParticleScaleByIndex().

Parameters

index

particle index in the particle group

Point3 * GetParticleScaleXYZByBornIndex ( int  id )

pure virtual

See GetParticleScaleByIndex().

Parameters

id	particle born index

void SetParticleScaleXYZByIndex ( int  index, Point3  scale  )

pure virtual

See GetParticleScaleByIndex().

Parameters

index	particle index in the particle group
scale	scale factor for each local axis of the particle

void SetParticleScaleXYZByBornIndex ( int  id, Point3  scale  )

pure virtual

See GetParticleScaleByIndex().

Parameters

id	particle born index
scale	scale factor for each local axis of the particle

Point3 * GetParticleScaleXYZ ( )

pure virtual

See GetParticleScaleByIndex().

void SetParticleScaleXYZ ( Point3  scale )

pure virtual

See GetParticleScaleByIndex().

Parameters

scale

scale factor for each local axis of the particle

Matrix3 * GetParticleTMByIndex ( int  index )

pure virtual

Defines transformation matrix of the specified particle in the current state.

Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle group

Matrix3 * GetParticleTMByBornIndex ( int  id )

pure virtual

See GetParticleTMByIndex().

Parameters

id	particle born index

void SetParticleTMByIndex ( int  index, Matrix3  tm  )

pure virtual

See GetParticleTMByIndex().

Parameters

index	particle index in the particle group
tm	transformation matrix of the particle

void SetParticleTMByBornIndex ( int  id, Matrix3  tm  )

pure virtual

See GetParticleTMByIndex().

Parameters

id	particle born index
tm	transformation matrix of the particle

Matrix3 * GetParticleTM ( )

pure virtual

See GetParticleTMByIndex().

void SetParticleTM ( Matrix3  tm )

pure virtual

See GetParticleTMByIndex().

Parameters

tm	transformation matrix of the particle

bool GetParticleSelectedByIndex ( int  index )

pure virtual

Defines selection status of the specified particle in the current state.

Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle group

bool GetParticleSelectedByBornIndex ( int  id )

pure virtual

See GetParticleSelectedByIndex().

Parameters

id	particle born index

void SetParticleSelectedByIndex ( int  index, bool  selected  )

pure virtual

See GetParticleSelectedByIndex().

Parameters

index	particle index in the particle group
selected	selection status of the particle

void SetParticleSelectedByBornIndex ( int  id, bool  selected  )

pure virtual

See GetParticleSelectedByIndex().

Parameters

id	particle born index
selected	selection status of the particle

bool GetParticleSelected ( )

pure virtual

See GetParticleSelectedByIndex().

void SetParticleSelected ( bool  selected )

pure virtual

See GetParticleSelectedByIndex().

Parameters

selected

selection status of the particle

Mesh * GetParticleShapeByIndex ( int  index )

pure virtual

Defines shape of the specified particle in the current state.

Particle is specified by either its index in the particle container, or by its born index. if no index is specified then the "current" index is used.

Parameters

index

particle index in the particle group

Mesh * GetParticleShapeByBornIndex ( int  id )

pure virtual

See GetParticleShapeByIndex().

Parameters

id	particle born index

void SetParticleShapeByIndex ( int  index, Mesh *  shape  )

pure virtual

See GetParticleShapeByIndex().

Parameters

index	particle index in the particle group
shape	shape of the particle

void SetParticleShapeByBornIndex ( int  id, Mesh *  shape  )

pure virtual

See GetParticleShapeByIndex().

Parameters

id	particle born index
shape	shape of the particle

Mesh * GetParticleShape ( )

pure virtual

See GetParticleShapeByIndex().

void SetParticleShape ( Mesh *  shape )

pure virtual

See GetParticleShapeByIndex().

Parameters

shape

shape of the particle

void SetGlobalParticleShape ( Mesh *  shape )

pure virtual

Set the same shape for all particles.

See GetParticleShapeByIndex().

Parameters

shape

shape of the particle

void SetParticleMtlIndexByIndex ( int  index, int  mtlIndex  )

pure virtual

Defines material index of the specified particle in the current state.

Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index	particle index in the particle group
mtlIndex	material index of the particle

void SetParticleMtlIndexByBornIndex ( int  id, int  mtlIndex  )

pure virtual

See SetParticleMtlIndexByIndex().

Parameters

id	particle born index
mtlIndex	material index of the particle

void SetParticleMtlIndex ( int  mtlIndex )

pure virtual

See SetParticleMtlIndexByIndex().

Parameters

mtlIndex

material index of the particle

void SetParticleMappingByIndex ( int  index, int  mapChannel, UVVert  mapValue  )

pure virtual

Defines mapping of the specified particle in the current state.

All vertices of the particle are assigned the same map value. Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index	particle index in the particle group
mapChannel	mapping channel; range from 0 to MAX_MESHMAPS-1
mapValue	mapping value of the particle

void SetParticleMappingByBornIndex ( int  id, int  mapChannel, UVVert  mapValue  )

pure virtual

See SetParticleMappingByIndex().

Parameters

id	particle born index
mapChannel	mapping channel; range from 0 to MAX_MESHMAPS-1
mapValue	mapping value of the particle

void SetParticleMapping ( int  mapChannel, UVVert  mapValue  )

pure virtual

See SetParticleMappingByIndex().

Parameters

mapChannel	mapping channel; range from 0 to MAX_MESHMAPS-1
mapValue	mapping value of the particle

int GetParticleIntByIndex ( int  index )

pure virtual

Defines integer value of the specified particle.

The methods can be used to keep integer data with the particle, and to be used later. Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle group

int GetParticleIntByBornIndex ( int  id )

pure virtual

See GetParticleIntByIndex().

Parameters

id	particle born index

void SetParticleIntByIndex ( int  index, int  value  )

pure virtual

See GetParticleIntByIndex().

Parameters

index	particle index in the particle group
value	integer value of the particle

void SetParticleIntByBornIndex ( int  id, int  value  )

pure virtual

See GetParticleIntByIndex().

Parameters

id	particle born index
value	integer value of the particle

int GetParticleInt ( )

pure virtual

See GetParticleIntByIndex().

void SetParticleInt ( int  value )

pure virtual

See GetParticleIntByIndex().

Parameters

value

integer value of the particle

float GetParticleFloatByIndex ( int  index )

pure virtual

Defines float value of the specified particle.

The methods can be used to keep float data with the particle, and to be used later. Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle group

float GetParticleFloatByBornIndex ( int  id )

pure virtual

See GetParticleFloatByIndex().

Parameters

id	particle born index

void SetParticleFloatByIndex ( int  index, float  value  )

pure virtual

See GetParticleFloatByIndex().

Parameters

index	particle index in the particle group
value	float value of the particle

void SetParticleFloatByBornIndex ( int  id, float  value  )

pure virtual

See GetParticleFloatByIndex().

Parameters

id	particle born index
value	float value of the particle

float GetParticleFloat ( )

pure virtual

See GetParticleFloatByIndex().

void SetParticleFloat ( float  value )

pure virtual

See GetParticleFloatByIndex().

Parameters

value

float value of the particle

Point3 * GetParticleVectorByIndex ( int  index )

pure virtual

Defines vector value of the specified particle.

Can be used to keep vector data with the particle, and to be used later. Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

int, particle index in the particle group

Point3 * GetParticleVectorByBornIndex ( int  id )

pure virtual

See GetParticleVectorByIndex().

Parameters

id	int, particle born index

void SetParticleVectorByIndex ( int  index, Point3  value  )

pure virtual

See GetParticleVectorByIndex().

Parameters

index	int, particle index in the particle group
value	vector value of the particle

void SetParticleVectorByBornIndex ( int  id, Point3  value  )

pure virtual

See GetParticleVectorByIndex().

Parameters

id	int, particle born index
value	vector value of the particle

Point3 * GetParticleVector ( )

pure virtual

See GetParticleVectorByIndex().

void SetParticleVector ( Point3  value )

pure virtual

See GetParticleVectorByIndex().

Parameters

value

vector value of the particle

Matrix3 * GetParticleMatrixByIndex ( int  index )

pure virtual

Defines matrix value of the specified particle.

Can be used to keep matrix data with the particle, and to be used later. Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index

particle index in the particle group

Matrix3 * GetParticleMatrixByBornIndex ( int  id )

pure virtual

See GetParticleMatrixByIndex().

Parameters

id	particle born index

void SetParticleMatrixByIndex ( int  index, Matrix3  value  )

pure virtual

See GetParticleMatrixByIndex().

Parameters

index	particle index in the particle group
value	matrix value of the particle

void SetParticleMatrixByBornIndex ( int  id, Matrix3  value  )

pure virtual

See GetParticleMatrixByIndex().

Parameters

id	particle born index
value	matrix value of the particle

Matrix3 * GetParticleMatrix ( )

pure virtual

See GetParticleMatrixByIndex().

void SetParticleMatrix ( Matrix3  value )

pure virtual

See GetParticleMatrixByIndex().

Parameters

value

matrix value of the particle

void SetParticleTestStatusByIndex ( int  index, bool  testStatus  )

pure virtual

Defines test status (true or false) for particles while testing.

Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index	particle index in the particle group
testStatus	test status

void SetParticleTestStatusByBornIndex ( int  id, bool  testStatus  )

pure virtual

See SetParticleTestStatusByIndex()

Parameters

id	particle born index
testStatus	test status

bool GetParticleTestStatus ( )

pure virtual

See SetParticleTestStatusByIndex()

void SetParticleTestStatus ( bool  testStatus )

pure virtual

See SetParticleTestStatusByIndex().

Parameters

testStatus

test status

void SetGlobalTestStatus ( bool  testStatus )

pure virtual

Set the same test status for all particles.

Parameters

testStatus

test status

void SetParticleTestTimeByIndex ( int  index, TimeValue  testTime  )

pure virtual

Defines the time when a particle satisfies the test.

Particle is specified by either its index in the particle container, or by its born index. If no index is specified then the "current" index is used.

Parameters

index	int, particle index in the particle group
testTime	TimeValue; time when a particle satisfies the test

void SetParticleTestTimeByIndex ( int  index, TimeValue  testTime, float  testTimeDelta  )

pure virtual

See SetParticleTestTimeByIndex().

Parameters

index	int, particle index in the particle group
testTime	TimeValue; time when a particle satisfies the test
testTimeDelta	float, if testTime parameter doesn't have enough precision then use the delta for fine tuning the test time

void SetParticleTestTimeByBornIndex ( int  id, TimeValue  testTime  )

pure virtual

See SetParticleTestTimeByIndex().

Parameters

id	int, particle born index
testTime	TimeValue; time when a particle satisfies the test

void SetParticleTestTimeByBornIndex ( int  id, TimeValue  testTime, float  testTimeDelta  )

pure virtual

See SetParticleTestTimeByIndex().

Parameters

id	int, particle born index
testTime	TimeValue; time when a particle satisfies the test
testTimeDelta	float, if testTime parameter doesn't have enough precision then use the delta for fine tuning the test time

TimeValue GetParticleTestTime ( )

pure virtual

See SetParticleTestTimeByIndex().

void SetParticleTestTime ( TimeValue  testTime )

pure virtual

See SetParticleTestTimeByIndex().

Parameters

testTime

TimeValue; time when a particle satisfies the test

void SetParticleTestTime ( TimeValue  testTime, float  testTimeDelta  )

pure virtual

See SetParticleTestTimeByIndex().

Parameters

testTime	TimeValue; time when a particle satisfies the test
testTimeDelta	float, if testTime parameter doesn't have enough precision then use the delta for fine tuning the test time

void SetGlobalTestTime ( TimeValue  testTime )

pure virtual

set the same test status for all particles

Parameters

testTime

TimeValue; time when a particle satisfies the test

void SetGlobalTestTime ( TimeValue  testTime, float  testTimeDelta  )

pure virtual

set the same test status for all particles

Parameters

testTime	TimeValue; time when a particle satisfies the test
testTimeDelta	float, if testTime parameter doesn't have enough precision then use the delta for fine tuning the test time

FPInterfaceDesc * GetDesc ( )

inlinevirtual

Remarks

Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

{ return GetDescByID(MXSPARTICLECONTAINER_INTERFACE); }