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
virtual void	SetParticleTestTime (TimeValue testTime)=0
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 ()

---

Function Documentation

IObject * GetParticleContainer

(

)

const [pure virtual, inherited]

Search for all occurrences

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

Object * GetParticleSystem

(

)

const [pure virtual, inherited]

Search for all occurrences

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

INode * GetParticleSystemNode

(

)

const [pure virtual, inherited]

Search for all occurrences

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

Tab< Object * > & GetInitActions

(

)

[pure virtual, inherited]

Search for all occurrences

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

Tab< INode * > & GetInitActionNodes

(

)

[pure virtual, inherited]

Search for all occurrences

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

TimeValue GetTimeStart

(

)

const [pure virtual, inherited]

Search for all occurrences

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

TimeValue GetTimeEnd

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetTimeEnd

(

TimeValue

time

)

[pure virtual, inherited]

Search for all occurrences

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, inherited]

Search for all occurrences

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, inherited]

Search for all occurrences

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

FPInterface * GetIntegrator

(

)

const [pure virtual, inherited]

Search for all occurrences

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

int RandSign

(

void

)

[pure virtual, inherited]

Search for all occurrences

Get random sign { -1, 1 }.

float Rand01

(

void

)

[pure virtual, inherited]

Search for all occurrences

Get random number between 0.0f and 1.0f.

float Rand11

(

void

)

[pure virtual, inherited]

Search for all occurrences

Get random number between -1.0f and 1.0f.

float Rand55

(

void

)

[pure virtual, inherited]

Search for all occurrences

Get random number between -0.5f and 0.5f.

int Rand0X

(

int

maxnum

)

[pure virtual, inherited]

Search for all occurrences

Get integer random number between 0 and maxnum.

Point3 * RandSpherePoint

(

)

[pure virtual, inherited]

Search for all occurrences

Get random point from sphere surface of radius 1.

Point3 * RandDivergeVector	(	Point3	vec,
		float	maxAngle
	)		[pure virtual, inherited]

Search for all occurrences

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, inherited]

Search for all occurrences

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

void SetUseTime

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseAge

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseAge

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseLifespan

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseLifespan

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseEventTime

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseEventTime

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUsePosition

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUsePosition

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseSpeed

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseSpeed

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseAcceleration

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseAcceleration

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseOrientation

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseOrientation

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseSpin

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseSpin

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseScale

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseScale

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseTM

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseTM

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseSelected

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseSelected

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseShape

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseShape

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseMtlIndex

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseMtlIndex

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseMapping

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseMapping

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseInt

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseInt

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseFloat

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseFloat

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseVector

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseVector

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

bool GetUseMatrix

(

)

const [pure virtual, inherited]

Search for all occurrences

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

void SetUseMatrix

(

bool

use

)

[pure virtual, inherited]

Search for all occurrences

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

int NumParticles

(

)

[pure virtual, inherited]

Search for all occurrences

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

bool AddParticle

(

)

[pure virtual, inherited]

Search for all occurrences

Add a single particle to particle system.

Returns true if the operation was completed successfully.

bool AddParticles

(

int

num

)

[pure virtual, inherited]

Search for all occurrences

Add "num" particles into the particle system.

Returns true if the operation was completed successfully.

bool DeleteParticle

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

Delete a single particle with the given index.

Returns true if the operation was completed successfully.

bool DeleteParticles	(	int	start,
		int	num
	)		[pure virtual, inherited]

Search for all occurrences

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

Returns true if the operation was completed successfully.

int GetParticleBornIndex

(

int

i

)

[pure virtual, inherited]

Search for all occurrences

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:

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

bool HasParticleBornIndex	(	int	bornIndex,
		int &	index
	)		[pure virtual, inherited]

Search for all occurrences

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, inherited]

Search for all occurrences

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

int GetCurrentParticleBornIndex

(

)

[pure virtual, inherited]

Search for all occurrences

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

void SetCurrentParticleIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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

void SetCurrentParticleBornIndex

(

int

bornIndex

)

[pure virtual, inherited]

Search for all occurrences

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

bool IsParticleNewByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

id,:	particle born index
index,:	particle index in the particle container

bool IsParticleNewByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See IsParticleNewByIndex().

bool IsParticleNew

(

)

[pure virtual, inherited]

Search for all occurrences

See IsParticleNewByIndex().

TimeValue GetParticleTimeByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

id,:	int, particle born index
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

TimeValue GetParticleTimeByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleTimeByIndex().

void SetParticleTimeByIndex	(	int	index,
		TimeValue	time
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleTimeByIndex().

void SetParticleTimeByIndex	(	int	index,
		TimeValue	time,
		float	timeDelta
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleTimeByIndex().

void SetParticleTimeByBornIndex	(	int	id,
		TimeValue	time
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleTimeByIndex().

void SetParticleTimeByBornIndex	(	int	id,
		TimeValue	time,
		float	timeDelta
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleTimeByIndex().

TimeValue GetParticleTime

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleTimeByIndex().

void SetParticleTime

(

TimeValue

time

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleTimeByIndex().

TimeValue GetParticleAgeByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
TimeValue	age: new age value to set for a particle

TimeValue GetParticleAgeByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleAgeByIndex().

void SetParticleAgeByIndex	(	int	index,
		TimeValue	age
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleAgeByIndex().

void SetParticleAgeByBornIndex	(	int	id,
		TimeValue	age
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleAgeByIndex().

TimeValue GetParticleAge

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleAgeByIndex().

void SetParticleAge

(

TimeValue

age

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleAgeByIndex().

TimeValue GetParticleLifespanByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
TimeValue	lifespan: new lifespan value to set for a particle

TimeValue GetParticleLifespanByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleLifespanByIndex().

void SetParticleLifespanByIndex	(	int	index,
		TimeValue	lifespan
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleLifespanByIndex().

void SetParticleLifespanByBornIndex	(	int	id,
		TimeValue	lifespan
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleLifespanByIndex().

TimeValue GetParticleLifespan

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleLifespanByIndex().

void SetParticleLifespan

(

TimeValue

lifespan

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleLifespanByIndex().

TimeValue GetParticleEventTimeByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

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

TimeValue GetParticleEventTimeByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleEventTimeByIndex().

void SetParticleEventTimeByIndex	(	int	index,
		TimeValue	time
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleEventTimeByIndex().

void SetParticleEventTimeByBornIndex	(	int	id,
		TimeValue	time
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleEventTimeByIndex().

TimeValue GetParticleEventTime

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleEventTimeByIndex().

void SetParticleEventTime

(

TimeValue

time

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleEventTimeByIndex().

Point3 * GetParticlePositionByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
Point3	pos: position of the particle

Point3 * GetParticlePositionByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticlePositionByIndex().

void SetParticlePositionByIndex	(	int	index,
		Point3	pos
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticlePositionByIndex().

void SetParticlePositionByBornIndex	(	int	id,
		Point3	pos
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticlePositionByIndex().

Point3 * GetParticlePosition

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticlePositionByIndex().

void SetParticlePosition

(

Point3

pos

)

[pure virtual, inherited]

Search for all occurrences

See GetParticlePositionByIndex().

Point3 * GetParticleSpeedByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
Point3	speed: speed of the particle in units per frame

Point3 * GetParticleSpeedByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleSpeedByIndex().

void SetParticleSpeedByIndex	(	int	index,
		Point3	speed
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleSpeedByIndex().

void SetParticleSpeedByBornIndex	(	int	id,
		Point3	speed
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleSpeedByIndex().

Point3 * GetParticleSpeed

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleSpeedByIndex().

void SetParticleSpeed

(

Point3

speed

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleSpeedByIndex().

Point3 * GetParticleAccelerationByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
Point3	accel: acceleration of the particle in units per frame squared

Point3 * GetParticleAccelerationByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleAccelerationByIndex().

void SetParticleAccelerationByIndex	(	int	index,
		Point3	accel
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleAccelerationByIndex().

void SetParticleAccelerationByBornIndex	(	int	id,
		Point3	accel
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleAccelerationByIndex().

Point3 * GetParticleAcceleration

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleAccelerationByIndex().

void SetParticleAcceleration

(

Point3

speed

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleAccelerationByIndex().

Point3 * GetParticleOrientationByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
Point3	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 * GetParticleOrientationByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleOrientationByIndex().

void SetParticleOrientationByIndex	(	int	index,
		Point3	orient
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleOrientationByIndex().

void SetParticleOrientationByBornIndex	(	int	id,
		Point3	orient
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleOrientationByIndex().

Point3 * GetParticleOrientation

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleOrientationByIndex().

void SetParticleOrientation

(

Point3

orient

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleOrientationByIndex().

AngAxis * GetParticleSpinByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

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

AngAxis * GetParticleSpinByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleSpinByIndex().

void SetParticleSpinByIndex	(	int	index,
		AngAxis	spin
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleSpinByIndex().

void SetParticleSpinByBornIndex	(	int	id,
		AngAxis	spin
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleSpinByIndex().

AngAxis * GetParticleSpin

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleSpinByIndex().

void SetParticleSpin

(

AngAxis

spin

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleSpinByIndex().

float GetParticleScaleByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
float	scale: uniform scale factor
Point3	scale: scale factor for each local axis of the particle

float GetParticleScaleByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleScaleByIndex().

void SetParticleScaleByIndex	(	int	index,
		float	scale
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleScaleByIndex().

void SetParticleScaleByBornIndex	(	int	id,
		float	scale
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleScaleByIndex().

float GetParticleScale

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleScaleByIndex().

void SetParticleScale

(

float

scale

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleScaleByIndex().

Point3 * GetParticleScaleXYZByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleScaleByIndex().

Point3 * GetParticleScaleXYZByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleScaleByIndex().

void SetParticleScaleXYZByIndex	(	int	index,
		Point3	scale
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleScaleByIndex().

void SetParticleScaleXYZByBornIndex	(	int	id,
		Point3	scale
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleScaleByIndex().

Point3 * GetParticleScaleXYZ

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleScaleByIndex().

void SetParticleScaleXYZ

(

Point3

scale

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleScaleByIndex().

Matrix3 * GetParticleTMByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
Matrix3	tm: transformation matrix of the particle

Matrix3 * GetParticleTMByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleTMByIndex().

void SetParticleTMByIndex	(	int	index,
		Matrix3	tm
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleTMByIndex().

void SetParticleTMByBornIndex	(	int	id,
		Matrix3	tm
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleTMByIndex().

Matrix3 * GetParticleTM

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleTMByIndex().

void SetParticleTM

(

Matrix3

tm

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleTMByIndex().

bool GetParticleSelectedByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
bool	selected: selection status of the particle

bool GetParticleSelectedByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleSelectedByIndex().

void SetParticleSelectedByIndex	(	int	index,
		bool	selected
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleSelectedByIndex().

void SetParticleSelectedByBornIndex	(	int	id,
		bool	selected
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleSelectedByIndex().

bool GetParticleSelected

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleSelectedByIndex().

void SetParticleSelected

(

bool

selected

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleSelectedByIndex().

Mesh * GetParticleShapeByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
Mesh*	shape: shape of the particle

Mesh * GetParticleShapeByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleShapeByIndex().

void SetParticleShapeByIndex	(	int	index,
		Mesh *	shape
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleShapeByIndex().

void SetParticleShapeByBornIndex	(	int	id,
		Mesh *	shape
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleShapeByIndex().

Mesh * GetParticleShape

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleShapeByIndex().

void SetParticleShape

(

Mesh *

shape

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleShapeByIndex().

void SetGlobalParticleShape

(

Mesh *

shape

)

[pure virtual, inherited]

Search for all occurrences

Set the same shape for all particles.

See GetParticleShapeByIndex().

void SetParticleMtlIndexByIndex	(	int	index,
		int	mtlIndex
	)		[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
int	mtlIndex: material index of the particle

void SetParticleMtlIndexByBornIndex	(	int	id,
		int	mtlIndex
	)		[pure virtual, inherited]

Search for all occurrences

See SetParticleMtlIndexByIndex().

void SetParticleMtlIndex

(

int

mtlIndex

)

[pure virtual, inherited]

Search for all occurrences

See SetParticleMtlIndexByIndex().

void SetParticleMappingByIndex	(	int	index,
		int	mapChannel,
		UVVert	mapValue
	)		[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
int	mapChannel: mapping channel; range from 0 to MAX_MESHMAPS-1
UVVert	mapValue: mapping value of the particle

void SetParticleMappingByBornIndex	(	int	id,
		int	mapChannel,
		UVVert	mapValue
	)		[pure virtual, inherited]

Search for all occurrences

See SetParticleMappingByIndex().

void SetParticleMapping	(	int	mapChannel,
		UVVert	mapValue
	)		[pure virtual, inherited]

Search for all occurrences

See SetParticleMappingByIndex().

int GetParticleIntByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
int	value: integer value of the particle

int GetParticleIntByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleIntByIndex().

void SetParticleIntByIndex	(	int	index,
		int	value
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleIntByIndex().

void SetParticleIntByBornIndex	(	int	id,
		int	value
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleIntByIndex().

int GetParticleInt

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleIntByIndex().

void SetParticleInt

(

int

value

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleIntByIndex().

float GetParticleFloatByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
float	value: float value of the particle

float GetParticleFloatByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleFloatByIndex().

void SetParticleFloatByIndex	(	int	index,
		float	value
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleFloatByIndex().

void SetParticleFloatByBornIndex	(	int	id,
		float	value
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleFloatByIndex().

float GetParticleFloat

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleFloatByIndex().

void SetParticleFloat

(

float

value

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleFloatByIndex().

Point3 * GetParticleVectorByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

id,:	int, particle born index
index,:	int, particle index in the particle group
Point3,:	vector value of the particle

Point3 * GetParticleVectorByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleVectorByIndex().

void SetParticleVectorByIndex	(	int	index,
		Point3	value
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleVectorByIndex().

void SetParticleVectorByBornIndex	(	int	id,
		Point3	value
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleVectorByIndex().

Point3 * GetParticleVector

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleVectorByIndex().

void SetParticleVector

(

Point3

value

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleVectorByIndex().

Matrix3 * GetParticleMatrixByIndex

(

int

index

)

[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
Matrix3	value: matrix value of the particle

Matrix3 * GetParticleMatrixByBornIndex

(

int

id

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleMatrixByIndex().

void SetParticleMatrixByIndex	(	int	index,
		Matrix3	value
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleMatrixByIndex().

void SetParticleMatrixByBornIndex	(	int	id,
		Matrix3	value
	)		[pure virtual, inherited]

Search for all occurrences

See GetParticleMatrixByIndex().

Matrix3 * GetParticleMatrix

(

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleMatrixByIndex().

void SetParticleMatrix

(

Matrix3

value

)

[pure virtual, inherited]

Search for all occurrences

See GetParticleMatrixByIndex().

void SetParticleTestStatusByIndex	(	int	index,
		bool	testStatus
	)		[pure virtual, inherited]

Search for all occurrences

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:

int	id: particle born index
int	index: particle index in the particle group
bool	testStatus: test status

void SetParticleTestStatusByBornIndex	(	int	id,
		bool	testStatus
	)		[pure virtual, inherited]

Search for all occurrences

See SetParticleTestStatusByIndex()

bool GetParticleTestStatus

(

)

[pure virtual, inherited]

Search for all occurrences

See SetParticleTestStatusByIndex()

void SetParticleTestStatus

(

bool

testStatus

)

[pure virtual, inherited]

Search for all occurrences

See SetParticleTestStatusByIndex().

void SetGlobalTestStatus

(

bool

testStatus

)

[pure virtual, inherited]

Search for all occurrences

Set the same test status for all particles.

void SetParticleTestTimeByIndex	(	int	index,
		TimeValue	testTime
	)		[pure virtual, inherited]

Search for all occurrences

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:

id,:	int, particle born index
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 SetParticleTestTimeByIndex	(	int	index,
		TimeValue	testTime,
		float	testTimeDelta
	)		[pure virtual, inherited]

Search for all occurrences

See SetParticleTestTimeByIndex().

void SetParticleTestTimeByBornIndex	(	int	id,
		TimeValue	testTime
	)		[pure virtual, inherited]

Search for all occurrences

See SetParticleTestTimeByIndex().

void SetParticleTestTimeByBornIndex	(	int	id,
		TimeValue	testTime,
		float	testTimeDelta
	)		[pure virtual, inherited]

Search for all occurrences

See SetParticleTestTimeByIndex().

virtual TimeValue GetParticleTestTime

(

)

[pure virtual, inherited]

Search for all occurrences

virtual void SetParticleTestTime

(

TimeValue

testTime

)

[pure virtual, inherited]

Search for all occurrences

void SetParticleTestTime	(	TimeValue	testTime,
		float	testTimeDelta
	)		[pure virtual, inherited]

Search for all occurrences

See SetParticleTestTimeByIndex().

void SetGlobalTestTime

(

TimeValue

testTime

)

[pure virtual, inherited]

Search for all occurrences

set the same test status for all particles

void SetGlobalTestTime	(	TimeValue	testTime,
		float	testTimeDelta
	)		[pure virtual, inherited]

Search for all occurrences

set the same test status for all particles

FPInterfaceDesc * GetDesc

(

)

[inline, virtual, inherited]

Search for all occurrences

Remarks:

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

Implements FPInterface.

{ return GetDescByID(MXSPARTICLECONTAINER_INTERFACE); }