IPFIntegrator.h

Functions
virtual bool	Proceed (IObject *pCont, PreciseTimeValue time, int index)=0
	Returns true if the operation has been proceeded successfully Proceed a single particle with the given index to the given time.
virtual bool	Proceed (IObject *pCont, PreciseTimeValue time)=0
	Proceed all particles in the container to the given time.
virtual bool	Proceed (IObject *pCont, Tab< PreciseTimeValue > &times)=0
	Proceed all particles in the container to the given times (maybe different for each particle)
virtual bool	Proceed (IObject *pCont, PreciseTimeValue time, BitArray &selected)=0
	Proceed selected particles only to the given time.
virtual bool	Proceed (IObject *pCont, Tab< PreciseTimeValue > &times, BitArray &selected)=0
	Proceed selected particles only to the given times (maybe different for each particle)
PFExport bool	ProceedSync (IObject *pCont, TimeValue timeTick, float timeFraction, bool isSelected, BitArray *selected)
	"function-publishing" hook-up for the methods above
PFExport bool	ProceedASync (IObject *pCont, Tab< TimeValue > *timeTicks, Tab< float > *timeFractions, bool isSelected, BitArray *selected)
	"function-publishing" hook-up for the methods above
virtual IPFIntegrator *	GetEncapsulatedIntegrator ()
	An integrator may rely on another integrator to calculation some particle proceedings.
PFExport bool	HasEncapsulatedIntegrator (IPFIntegrator *integrator)
	Check if the current integrator has the given integrator encapsulated inside the encapsulated integrator can be more than one level down.
FPInterfaceDesc *	GetDesc ()
Variables
static Tab< IObject * >	m_objs
Friends
PFExport IPFIntegrator *	GetPFIntegrator ()
	Friend function declarations.
PFExport void	ReleasePFIntegrator (IPFIntegrator *)
	Friend function declarations.

---

Function Documentation

bool Proceed	(	IObject *	pCont,
		PreciseTimeValue	time,
		int	index
	)		[pure virtual, inherited]

Search for all occurrences

Returns true if the operation has been proceeded successfully Proceed a single particle with the given index to the given time.

If pCont is NULL then the method works with previously given container. It will expedite the call since the method won't acquire particle channels from the container but uses the previously acquired channels. When working with individual particles from the same container, the good practice is to make the call for the first particle with the container specified, and then for all other particles with the container set to NULL.

Parameters:

pCont,:	particleContainer
time,:	the time for particles to come to; each particle may have its own current valid time; the parameter sets the time for all particles to synchronize to
times,:	time value for a particle to come to; particles may have different time values to come to
selected,:	bitArray to define which particles to proceed

bool Proceed	(	IObject *	pCont,
		PreciseTimeValue	time
	)		[pure virtual, inherited]

Search for all occurrences

Proceed all particles in the container to the given time.

bool Proceed	(	IObject *	pCont,
		Tab< PreciseTimeValue > &	times
	)		[pure virtual, inherited]

Search for all occurrences

Proceed all particles in the container to the given times (maybe different for each particle)

bool Proceed	(	IObject *	pCont,
		PreciseTimeValue	time,
		BitArray &	selected
	)		[pure virtual, inherited]

Search for all occurrences

Proceed selected particles only to the given time.

bool Proceed	(	IObject *	pCont,
		Tab< PreciseTimeValue > &	times,
		BitArray &	selected
	)		[pure virtual, inherited]

Search for all occurrences

Proceed selected particles only to the given times (maybe different for each particle)

PFExport bool ProceedSync	(	IObject *	pCont,
		TimeValue	timeTick,
		float	timeFraction,
		bool	isSelected,
		BitArray *	selected
	)		[inherited]

Search for all occurrences

"function-publishing" hook-up for the methods above

Parameters:

pCont,:	particleContainer
timeTick,timeFraction,timeTicks,timeFractions,:	time for particles to come to. All particles may have the same time value to come to, in that case the method with timeTick and timeFraction have to used. Sum of timeTick and timeFraction define the exact time value (without TimeValue granularity). If particles have different time values to come to than use the second method with Tabs of timeTicks and timeFractions
isSelected,selected,:	if only part of particles need to be time-advanced then isSelected is true, and "selected" BitArray have to be defined

PFExport bool ProceedASync	(	IObject *	pCont,
		Tab< TimeValue > *	timeTicks,
		Tab< float > *	timeFractions,
		bool	isSelected,
		BitArray *	selected
	)		[inherited]

Search for all occurrences

"function-publishing" hook-up for the methods above

Parameters:

pCont,:	particleContainer
timeTick,timeFraction,timeTicks,timeFractions,:	time for particles to come to. All particles may have the same time value to come to, in that case the method with timeTick and timeFraction have to used. Sum of timeTick and timeFraction define the exact time value (without TimeValue granularity). If particles have different time values to come to than use the second method with Tabs of timeTicks and timeFractions
isSelected,selected,:	if only part of particles need to be time-advanced then isSelected is true, and "selected" BitArray have to be defined

IPFIntegrator * GetEncapsulatedIntegrator

(

)

[inline, virtual, inherited]

Search for all occurrences

An integrator may rely on another integrator to calculation some particle proceedings.

For example, a Collision test has IPFIntegrator interface to proceed particles according to collision approximations. At the same time a Collision test doesn't proceed angular velocity of a particle. For that the test relies on encapsulated standard integrator.

{ return NULL; }

PFExport bool HasEncapsulatedIntegrator

(

IPFIntegrator *

integrator

)

[inherited]

Search for all occurrences

Check if the current integrator has the given integrator encapsulated inside the encapsulated integrator can be more than one level down.

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(PFINTEGRATOR_INTERFACE); }

---

Variable Documentation

Tab<IObject*> m_objs [static, protected, inherited]

Search for all occurrences

---

Friends

PFExport IPFIntegrator * GetPFIntegrator

(

)

[friend, inherited]

Search for all occurrences

Friend function declarations.

PFExport void ReleasePFIntegrator

(

IPFIntegrator *

integrator

)

[friend, inherited]

Search for all occurrences

Friend function declarations.