IMXSParticleContainer.h

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

Detailed Description

Function Documentation

GetParticleContainer()

virtual IObject * GetParticleContainer ( ) const

pure virtual

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

GetParticleSystem()

virtual Object * GetParticleSystem ( ) const

pure virtual

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

GetParticleSystemNode()

virtual INode * GetParticleSystemNode ( ) const

pure virtual

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

GetInitActions()

virtual Tab< Object * > & GetInitActions ( )

pure virtual

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

GetInitActionNodes()

virtual Tab< INode * > & GetInitActionNodes ( )

pure virtual

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

GetTimeStart()

virtual TimeValue GetTimeStart ( ) const

pure virtual

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

GetTimeEnd()

virtual TimeValue GetTimeEnd ( ) const

pure virtual

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

SetTimeEnd() [1/2]

virtual 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.

SetTimeEnd() [2/2]

virtual 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.

GetActionNode()

virtual INode * GetActionNode ( ) const

pure virtual

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

GetIntegrator()

virtual FPInterface * GetIntegrator ( ) const

pure virtual

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

RandSign()

virtual int RandSign ( void )

pure virtual

Get random sign { -1, 1 }.

Rand01()

virtual float Rand01 ( void )

pure virtual

Get random number between 0.0f and 1.0f.

Rand11()

virtual float Rand11 ( void )

pure virtual

Get random number between -1.0f and 1.0f.

Rand55()

virtual float Rand55 ( void )

pure virtual

Get random number between -0.5f and 0.5f.

Rand0X()

virtual int Rand0X ( int maxnum )

pure virtual

Get integer random number between 0 and maxnum.

RandSpherePoint()

virtual Point3 * RandSpherePoint ( )

pure virtual

Get random point from sphere surface of radius 1.

RandDivergeVector()

virtual 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.

GetUseTime()

virtual bool GetUseTime ( ) const

pure virtual

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

SetUseTime()

virtual void SetUseTime ( bool use )

pure virtual

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

GetUseAge()

virtual bool GetUseAge ( ) const

pure virtual

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

SetUseAge()

virtual void SetUseAge ( bool use )

pure virtual

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

GetUseLifespan()

virtual bool GetUseLifespan ( ) const

pure virtual

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

SetUseLifespan()

virtual void SetUseLifespan ( bool use )

pure virtual

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

GetUseEventTime()

virtual bool GetUseEventTime ( ) const

pure virtual

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

SetUseEventTime()

virtual void SetUseEventTime ( bool use )

pure virtual

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

GetUsePosition()

virtual bool GetUsePosition ( ) const

pure virtual

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

SetUsePosition()

virtual void SetUsePosition ( bool use )

pure virtual

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

GetUseSpeed()

virtual bool GetUseSpeed ( ) const

pure virtual

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

SetUseSpeed()

virtual void SetUseSpeed ( bool use )

pure virtual

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

GetUseAcceleration()

virtual bool GetUseAcceleration ( ) const

pure virtual

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

SetUseAcceleration()

virtual void SetUseAcceleration ( bool use )

pure virtual

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

GetUseOrientation()

virtual bool GetUseOrientation ( ) const

pure virtual

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

SetUseOrientation()

virtual void SetUseOrientation ( bool use )

pure virtual

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

GetUseSpin()

virtual bool GetUseSpin ( ) const

pure virtual

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

SetUseSpin()

virtual void SetUseSpin ( bool use )

pure virtual

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

GetUseScale()

virtual bool GetUseScale ( ) const

pure virtual

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

SetUseScale()

virtual void SetUseScale ( bool use )

pure virtual

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

GetUseTM()

virtual bool GetUseTM ( ) const

pure virtual

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

SetUseTM()

virtual void SetUseTM ( bool use )

pure virtual

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

GetUseSelected()

virtual bool GetUseSelected ( ) const

pure virtual

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

SetUseSelected()

virtual void SetUseSelected ( bool use )

pure virtual

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

GetUseShape()

virtual bool GetUseShape ( ) const

pure virtual

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

SetUseShape()

virtual void SetUseShape ( bool use )

pure virtual

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

GetUseMtlIndex()

virtual bool GetUseMtlIndex ( ) const

pure virtual

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

SetUseMtlIndex()

virtual void SetUseMtlIndex ( bool use )

pure virtual

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

GetUseMapping()

virtual bool GetUseMapping ( ) const

pure virtual

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

SetUseMapping()

virtual void SetUseMapping ( bool use )

pure virtual

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

GetUseInt()

virtual bool GetUseInt ( ) const

pure virtual

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

SetUseInt()

virtual void SetUseInt ( bool use )

pure virtual

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

GetUseFloat()

virtual bool GetUseFloat ( ) const

pure virtual

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

SetUseFloat()

virtual void SetUseFloat ( bool use )

pure virtual

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

GetUseVector()

virtual bool GetUseVector ( ) const

pure virtual

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

SetUseVector()

virtual void SetUseVector ( bool use )

pure virtual

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

GetUseMatrix()

virtual bool GetUseMatrix ( ) const

pure virtual

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

SetUseMatrix()

virtual void SetUseMatrix ( bool use )

pure virtual

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

NumParticles()

virtual int NumParticles ( )

pure virtual

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

AddParticle()

virtual bool AddParticle ( )

pure virtual

Add a single particle to particle system.

Returns true if the operation was completed successfully.

AddParticles()

virtual bool AddParticles ( int num )

pure virtual

Add "num" particles into the particle system.

Returns true if the operation was completed successfully.

DeleteParticle()

virtual bool DeleteParticle ( int index )

pure virtual

Delete a single particle with the given index.

Returns true if the operation was completed successfully.

DeleteParticles()

virtual 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.

GetParticleBornIndex()

virtual 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]

HasParticleBornIndex()

virtual 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

GetCurrentParticleIndex()

virtual int GetCurrentParticleIndex ( )

pure virtual

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

GetCurrentParticleBornIndex()

virtual int GetCurrentParticleBornIndex ( )

pure virtual

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

SetCurrentParticleIndex()

virtual void SetCurrentParticleIndex ( int index )

pure virtual

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

SetCurrentParticleBornIndex()

virtual void SetCurrentParticleBornIndex ( int bornIndex )

pure virtual

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

IsParticleNewByIndex()

virtual 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

IsParticleNewByBornIndex()

virtual bool IsParticleNewByBornIndex ( int id )

pure virtual

See IsParticleNewByIndex().

Parameters

id	particle born index

IsParticleNew()

virtual bool IsParticleNew ( )

pure virtual

See IsParticleNewByIndex().

GetParticleTimeByIndex()

virtual 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

GetParticleTimeByBornIndex()

virtual TimeValue GetParticleTimeByBornIndex ( int id )

pure virtual

See GetParticleTimeByIndex().

Parameters

id	int, particle born index

SetParticleTimeByIndex() [1/2]

virtual 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

SetParticleTimeByIndex() [2/2]

virtual 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

SetParticleTimeByBornIndex() [1/2]

virtual 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

SetParticleTimeByBornIndex() [2/2]

virtual 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

GetParticleTime()

virtual TimeValue GetParticleTime ( )

pure virtual

See GetParticleTimeByIndex().

SetParticleTime()

virtual void SetParticleTime ( TimeValue time )

pure virtual

See GetParticleTimeByIndex().

Parameters

time	TimeValue, time of the current state for the particle

GetParticleAgeByIndex()

virtual 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

GetParticleAgeByBornIndex()

virtual TimeValue GetParticleAgeByBornIndex ( int id )

pure virtual

See GetParticleAgeByIndex().

Parameters

id	particle born index

SetParticleAgeByIndex()

virtual 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

SetParticleAgeByBornIndex()

virtual void SetParticleAgeByBornIndex ( int id, TimeValue age )

pure virtual

See GetParticleAgeByIndex().

Parameters

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

GetParticleAge()

virtual TimeValue GetParticleAge ( )

pure virtual

See GetParticleAgeByIndex().

SetParticleAge()

virtual void SetParticleAge ( TimeValue age )

pure virtual

See GetParticleAgeByIndex().

Parameters

age	new age value to set for a particle

GetParticleLifespanByIndex()

virtual 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

GetParticleLifespanByBornIndex()

virtual TimeValue GetParticleLifespanByBornIndex ( int id )

pure virtual

See GetParticleLifespanByIndex().

Parameters

id	particle born index

SetParticleLifespanByIndex()

virtual 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

SetParticleLifespanByBornIndex()

virtual void SetParticleLifespanByBornIndex ( int id, TimeValue lifespan )

pure virtual

See GetParticleLifespanByIndex().

Parameters

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

GetParticleLifespan()

virtual TimeValue GetParticleLifespan ( )

pure virtual

See GetParticleLifespanByIndex().

SetParticleLifespan()

virtual void SetParticleLifespan ( TimeValue lifespan )

pure virtual

See GetParticleLifespanByIndex().

Parameters

lifespan

new lifespan value to set for a particle

GetParticleEventTimeByIndex()

virtual 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

GetParticleEventTimeByBornIndex()

virtual TimeValue GetParticleEventTimeByBornIndex ( int id )

pure virtual

See GetParticleEventTimeByIndex().

Parameters

id	particle born index

SetParticleEventTimeByIndex()

virtual 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)

SetParticleEventTimeByBornIndex()

virtual 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)

GetParticleEventTime()

virtual TimeValue GetParticleEventTime ( )

pure virtual

See GetParticleEventTimeByIndex().

SetParticleEventTime()

virtual void SetParticleEventTime ( TimeValue time )

pure virtual

See GetParticleEventTimeByIndex().

Parameters

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

GetParticlePositionByIndex()

virtual 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

GetParticlePositionByBornIndex()

virtual Point3 * GetParticlePositionByBornIndex ( int id )

pure virtual

See GetParticlePositionByIndex().

Parameters

id	particle born index

SetParticlePositionByIndex()

virtual void SetParticlePositionByIndex ( int index, Point3 pos )

pure virtual

See GetParticlePositionByIndex().

Parameters

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

SetParticlePositionByBornIndex()

virtual void SetParticlePositionByBornIndex ( int id, Point3 pos )

pure virtual

See GetParticlePositionByIndex().

Parameters

id	particle born index
pos	position of the particle

GetParticlePosition()

virtual Point3 * GetParticlePosition ( )

pure virtual

See GetParticlePositionByIndex().

SetParticlePosition()

virtual void SetParticlePosition ( Point3 pos )

pure virtual

See GetParticlePositionByIndex().

Parameters

pos	position of the particle

GetParticleSpeedByIndex()

virtual 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

GetParticleSpeedByBornIndex()

virtual Point3 * GetParticleSpeedByBornIndex ( int id )

pure virtual

See GetParticleSpeedByIndex().

Parameters

id	particle born index

SetParticleSpeedByIndex()

virtual 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

SetParticleSpeedByBornIndex()

virtual void SetParticleSpeedByBornIndex ( int id, Point3 speed )

pure virtual

See GetParticleSpeedByIndex().

Parameters

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

GetParticleSpeed()

virtual Point3 * GetParticleSpeed ( )

pure virtual

See GetParticleSpeedByIndex().

SetParticleSpeed()

virtual void SetParticleSpeed ( Point3 speed )

pure virtual

See GetParticleSpeedByIndex().

Parameters

speed

speed of the particle in units per frame

GetParticleAccelerationByIndex()

virtual 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

GetParticleAccelerationByBornIndex()

virtual Point3 * GetParticleAccelerationByBornIndex ( int id )

pure virtual

See GetParticleAccelerationByIndex().

Parameters

id	particle born index

SetParticleAccelerationByIndex()

virtual 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

SetParticleAccelerationByBornIndex()

virtual 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

GetParticleAcceleration()

virtual Point3 * GetParticleAcceleration ( )

pure virtual

See GetParticleAccelerationByIndex().

SetParticleAcceleration()

virtual void SetParticleAcceleration ( Point3 speed )

pure virtual

See GetParticleAccelerationByIndex().

Parameters

speed

acceleration of the particle in units per frame squared

GetParticleOrientationByIndex()

virtual 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

GetParticleOrientationByBornIndex()

virtual Point3 * GetParticleOrientationByBornIndex ( int id )

pure virtual

See GetParticleOrientationByIndex().

Parameters

id	particle born index

SetParticleOrientationByIndex()

virtual 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.

SetParticleOrientationByBornIndex()

virtual 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.

GetParticleOrientation()

virtual Point3 * GetParticleOrientation ( )

pure virtual

See GetParticleOrientationByIndex().

SetParticleOrientation()

virtual 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.

GetParticleSpinByIndex()

virtual 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

GetParticleSpinByBornIndex()

virtual AngAxis * GetParticleSpinByBornIndex ( int id )

pure virtual

See GetParticleSpinByIndex().

Parameters

id	particle born index

SetParticleSpinByIndex()

virtual 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

SetParticleSpinByBornIndex()

virtual 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

GetParticleSpin()

virtual AngAxis * GetParticleSpin ( )

pure virtual

See GetParticleSpinByIndex().

SetParticleSpin()

virtual 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

GetParticleScaleByIndex()

virtual 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

GetParticleScaleByBornIndex()

virtual float GetParticleScaleByBornIndex ( int id )

pure virtual

See GetParticleScaleByIndex().

Parameters

id	particle born index

SetParticleScaleByIndex()

virtual void SetParticleScaleByIndex ( int index, float scale )

pure virtual

See GetParticleScaleByIndex().

Parameters

index	particle index in the particle group
scale	uniform scale factor

SetParticleScaleByBornIndex()

virtual void SetParticleScaleByBornIndex ( int id, float scale )

pure virtual

See GetParticleScaleByIndex().

Parameters

id	particle born index
scale	uniform scale factor

GetParticleScale()

virtual float GetParticleScale ( )

pure virtual

See GetParticleScaleByIndex().

SetParticleScale()

virtual void SetParticleScale ( float scale )

pure virtual

See GetParticleScaleByIndex().

Parameters

scale

uniform scale factor

GetParticleScaleXYZByIndex()

virtual Point3 * GetParticleScaleXYZByIndex ( int index )

pure virtual

See GetParticleScaleByIndex().

Parameters

index

particle index in the particle group

GetParticleScaleXYZByBornIndex()

virtual Point3 * GetParticleScaleXYZByBornIndex ( int id )

pure virtual

See GetParticleScaleByIndex().

Parameters

id	particle born index

SetParticleScaleXYZByIndex()

virtual 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

SetParticleScaleXYZByBornIndex()

virtual 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

GetParticleScaleXYZ()

virtual Point3 * GetParticleScaleXYZ ( )

pure virtual

See GetParticleScaleByIndex().

SetParticleScaleXYZ()

virtual void SetParticleScaleXYZ ( Point3 scale )

pure virtual

See GetParticleScaleByIndex().

Parameters

scale

scale factor for each local axis of the particle

GetParticleTMByIndex()

virtual 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

GetParticleTMByBornIndex()

virtual Matrix3 * GetParticleTMByBornIndex ( int id )

pure virtual

See GetParticleTMByIndex().

Parameters

id	particle born index

SetParticleTMByIndex()

virtual void SetParticleTMByIndex ( int index, Matrix3 tm )

pure virtual

See GetParticleTMByIndex().

Parameters

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

SetParticleTMByBornIndex()

virtual void SetParticleTMByBornIndex ( int id, Matrix3 tm )

pure virtual

See GetParticleTMByIndex().

Parameters

id	particle born index
tm	transformation matrix of the particle

GetParticleTM()

virtual Matrix3 * GetParticleTM ( )

pure virtual

See GetParticleTMByIndex().

SetParticleTM()

virtual void SetParticleTM ( Matrix3 tm )

pure virtual

See GetParticleTMByIndex().

Parameters

tm	transformation matrix of the particle

GetParticleSelectedByIndex()

virtual 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

GetParticleSelectedByBornIndex()

virtual bool GetParticleSelectedByBornIndex ( int id )

pure virtual

See GetParticleSelectedByIndex().

Parameters

id	particle born index

SetParticleSelectedByIndex()

virtual void SetParticleSelectedByIndex ( int index, bool selected )

pure virtual

See GetParticleSelectedByIndex().

Parameters

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

SetParticleSelectedByBornIndex()

virtual void SetParticleSelectedByBornIndex ( int id, bool selected )

pure virtual

See GetParticleSelectedByIndex().

Parameters

id	particle born index
selected	selection status of the particle

GetParticleSelected()

virtual bool GetParticleSelected ( )

pure virtual

See GetParticleSelectedByIndex().

SetParticleSelected()

virtual void SetParticleSelected ( bool selected )

pure virtual

See GetParticleSelectedByIndex().

Parameters

selected

selection status of the particle

GetParticleShapeByIndex()

virtual 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

GetParticleShapeByBornIndex()

virtual Mesh * GetParticleShapeByBornIndex ( int id )

pure virtual

See GetParticleShapeByIndex().

Parameters

id	particle born index

SetParticleShapeByIndex()

virtual void SetParticleShapeByIndex ( int index, Mesh * shape )

pure virtual

See GetParticleShapeByIndex().

Parameters

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

SetParticleShapeByBornIndex()

virtual void SetParticleShapeByBornIndex ( int id, Mesh * shape )

pure virtual

See GetParticleShapeByIndex().

Parameters

id	particle born index
shape	shape of the particle

GetParticleShape()

virtual Mesh * GetParticleShape ( )

pure virtual

See GetParticleShapeByIndex().

SetParticleShape()

virtual void SetParticleShape ( Mesh * shape )

pure virtual

See GetParticleShapeByIndex().

Parameters

shape

shape of the particle

SetGlobalParticleShape()

virtual void SetGlobalParticleShape ( Mesh * shape )

pure virtual

Set the same shape for all particles.

See GetParticleShapeByIndex().

Parameters

shape

shape of the particle

SetParticleMtlIndexByIndex()

virtual 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

SetParticleMtlIndexByBornIndex()

virtual void SetParticleMtlIndexByBornIndex ( int id, int mtlIndex )

pure virtual

See SetParticleMtlIndexByIndex().

Parameters

id	particle born index
mtlIndex	material index of the particle

SetParticleMtlIndex()

virtual void SetParticleMtlIndex ( int mtlIndex )

pure virtual

See SetParticleMtlIndexByIndex().

Parameters

mtlIndex

material index of the particle

SetParticleMappingByIndex()

virtual 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

SetParticleMappingByBornIndex()

virtual 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

SetParticleMapping()

virtual 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

GetParticleIntByIndex()

virtual 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

GetParticleIntByBornIndex()

virtual int GetParticleIntByBornIndex ( int id )

pure virtual

See GetParticleIntByIndex().

Parameters

id	particle born index

SetParticleIntByIndex()

virtual void SetParticleIntByIndex ( int index, int value )

pure virtual

See GetParticleIntByIndex().

Parameters

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

SetParticleIntByBornIndex()

virtual void SetParticleIntByBornIndex ( int id, int value )

pure virtual

See GetParticleIntByIndex().

Parameters

id	particle born index
value	integer value of the particle

GetParticleInt()

virtual int GetParticleInt ( )

pure virtual

See GetParticleIntByIndex().

SetParticleInt()

virtual void SetParticleInt ( int value )

pure virtual

See GetParticleIntByIndex().

Parameters

value

integer value of the particle

GetParticleFloatByIndex()

virtual 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

GetParticleFloatByBornIndex()

virtual float GetParticleFloatByBornIndex ( int id )

pure virtual

See GetParticleFloatByIndex().

Parameters

id	particle born index

SetParticleFloatByIndex()

virtual void SetParticleFloatByIndex ( int index, float value )

pure virtual

See GetParticleFloatByIndex().

Parameters

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

SetParticleFloatByBornIndex()

virtual void SetParticleFloatByBornIndex ( int id, float value )

pure virtual

See GetParticleFloatByIndex().

Parameters

id	particle born index
value	float value of the particle

GetParticleFloat()

virtual float GetParticleFloat ( )

pure virtual

See GetParticleFloatByIndex().

SetParticleFloat()

virtual void SetParticleFloat ( float value )

pure virtual

See GetParticleFloatByIndex().

Parameters

value

float value of the particle

GetParticleVectorByIndex()

virtual 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

GetParticleVectorByBornIndex()

virtual Point3 * GetParticleVectorByBornIndex ( int id )

pure virtual

See GetParticleVectorByIndex().

Parameters

id	int, particle born index

SetParticleVectorByIndex()

virtual 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

SetParticleVectorByBornIndex()

virtual void SetParticleVectorByBornIndex ( int id, Point3 value )

pure virtual

See GetParticleVectorByIndex().

Parameters

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

GetParticleVector()

virtual Point3 * GetParticleVector ( )

pure virtual

See GetParticleVectorByIndex().

SetParticleVector()

virtual void SetParticleVector ( Point3 value )

pure virtual

See GetParticleVectorByIndex().

Parameters

value

vector value of the particle

GetParticleMatrixByIndex()

virtual 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

GetParticleMatrixByBornIndex()

virtual Matrix3 * GetParticleMatrixByBornIndex ( int id )

pure virtual

See GetParticleMatrixByIndex().

Parameters

id	particle born index

SetParticleMatrixByIndex()

virtual void SetParticleMatrixByIndex ( int index, Matrix3 value )

pure virtual

See GetParticleMatrixByIndex().

Parameters

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

SetParticleMatrixByBornIndex()

virtual void SetParticleMatrixByBornIndex ( int id, Matrix3 value )

pure virtual

See GetParticleMatrixByIndex().

Parameters

id	particle born index
value	matrix value of the particle

GetParticleMatrix()

virtual Matrix3 * GetParticleMatrix ( )

pure virtual

See GetParticleMatrixByIndex().

SetParticleMatrix()

virtual void SetParticleMatrix ( Matrix3 value )

pure virtual

See GetParticleMatrixByIndex().

Parameters

value

matrix value of the particle

SetParticleTestStatusByIndex()

virtual 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

SetParticleTestStatusByBornIndex()

virtual void SetParticleTestStatusByBornIndex ( int id, bool testStatus )

pure virtual

See SetParticleTestStatusByIndex()

Parameters

id	particle born index
testStatus	test status

GetParticleTestStatus()

virtual bool GetParticleTestStatus ( )

pure virtual

See SetParticleTestStatusByIndex()

SetParticleTestStatus()

virtual void SetParticleTestStatus ( bool testStatus )

pure virtual

See SetParticleTestStatusByIndex().

Parameters

testStatus

test status

SetGlobalTestStatus()

virtual void SetGlobalTestStatus ( bool testStatus )

pure virtual

Set the same test status for all particles.

Parameters

testStatus

test status

SetParticleTestTimeByIndex() [1/2]

virtual 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

SetParticleTestTimeByIndex() [2/2]

virtual 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

SetParticleTestTimeByBornIndex() [1/2]

virtual 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

SetParticleTestTimeByBornIndex() [2/2]

virtual 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

GetParticleTestTime()

virtual TimeValue GetParticleTestTime ( )

pure virtual

See SetParticleTestTimeByIndex().

SetParticleTestTime() [1/2]

virtual void SetParticleTestTime ( TimeValue testTime )

pure virtual

See SetParticleTestTimeByIndex().

Parameters

testTime

TimeValue; time when a particle satisfies the test

SetParticleTestTime() [2/2]

virtual 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

SetGlobalTestTime() [1/2]

virtual void SetGlobalTestTime ( TimeValue testTime )

pure virtual

set the same test status for all particles

Parameters

testTime

TimeValue; time when a particle satisfies the test

SetGlobalTestTime() [2/2]

virtual 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

GetDesc()

FPInterfaceDesc * GetDesc ( )

inlinevirtual

Remarks

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

Implements FPInterface.

{ return GetDescByID(MXSPARTICLECONTAINER_INTERFACE); }