IParticleChannelPTV.h

Enumerations
enum	{ kSetTick , kSetFraction , kSetTickFraction }

Functions
virtual TimeValue	GetTick (int index) const =0
	Get particle property.
virtual float	GetFraction (int index) const =0
	Returns true if "index" particle exists.
virtual void	GetTickFraction (int index, TimeValue &tick, float &fraction) const =0
virtual bool	IsSync () const =0
	Returns true if all particles have the same time.
virtual const PreciseTimeValue &	GetValue (int index) const =0
	Methods not in the mapped interface.
virtual const PreciseTimeValue &	GetValue () const =0
	Get synchronized time for all particles; if timing isn't synchronized then return time for the first particle in the container.
FPInterfaceDesc *	GetDesc ()
	VFN_2 (kSetTick, SetTick, TYPE_INT, TYPE_TIMEVALUE)
	VFN_2 (kSetFraction, SetFraction, TYPE_INT, TYPE_FLOAT)
	VFN_3 (kSetTickFraction, SetTickFraction, TYPE_INT, TYPE_TIMEVALUE, TYPE_FLOAT)
virtual void	SetTick (int index, TimeValue time)=0
virtual void	SetFraction (int index, float time)=0
virtual void	SetTickFraction (int index, TimeValue tick, float fraction)=0
virtual void	SetValue (int index, const PreciseTimeValue &time)=0
virtual void	SetValue (const PreciseTimeValue &time)=0
FPInterfaceDesc *	GetDesc ()

Detailed Description

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kSetTick
kSetFraction
kSetTickFraction

         {  kSetTick,
            kSetFraction,
            kSetTickFraction,
    }; 

Function Documentation

GetTick()

TimeValue GetTick ( int  index ) const

pure virtual

Get particle property.

GetFraction()

float GetFraction ( int  index ) const

pure virtual

Returns true if "index" particle exists.

GetTickFraction()

void GetTickFraction ( int  index, TimeValue &  tick, float &  fraction  ) const

pure virtual

IsSync()

bool IsSync ( ) const

pure virtual

Returns true if all particles have the same time.

GetValue() [1/2]

const PreciseTimeValue & GetValue ( int  index ) const

pure virtual

Methods not in the mapped interface.

GetValue() [2/2]

const PreciseTimeValue & GetValue ( ) const

pure virtual

Get synchronized time for all particles; if timing isn't synchronized then return time for the first particle in the container.

GetDesc() [1/2]

FPInterfaceDesc * GetDesc ( )

inlinevirtual

Remarks

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

Implements FPInterface.

{ return GetDescByID(PARTICLECHANNELPTVR_INTERFACE); }

VFN_2() [1/2]

VFN_2	(	kSetTick	,
		SetTick	,
		TYPE_INT	,
		TYPE_TIMEVALUE
	)

VFN_2() [2/2]

VFN_2	(	kSetFraction	,
		SetFraction	,
		TYPE_INT	,
		TYPE_FLOAT
	)

VFN_3()

VFN_3	(	kSetTickFraction	,
		SetTickFraction	,
		TYPE_INT	,
		TYPE_TIMEVALUE	,
		TYPE_FLOAT
	)

SetTick()

virtual void SetTick ( int  index, TimeValue  time  )

pure virtual

SetFraction()

virtual void SetFraction ( int  index, float  time  )

pure virtual

SetTickFraction()

virtual void SetTickFraction ( int  index, TimeValue  tick, float  fraction  )

pure virtual

SetValue() [1/2]

virtual void SetValue ( int  index, const PreciseTimeValue &  time  )

pure virtual

SetValue() [2/2]

virtual void SetValue ( const PreciseTimeValue &  time )

pure virtual

GetDesc() [2/2]

FPInterfaceDesc * GetDesc ( )

inlinevirtual

Remarks

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

Implements FPInterface.

{ return GetDescByID(PARTICLECHANNELPTVW_INTERFACE); }