IPFSystemPool.h

Module description

Functions
virtual int	NumPFSystems ()=0
	returns number of PFSystems in the current scene More...
virtual INode *	GetPFSystem (int i)=0
	Returns i-th PFSystem in the scene. More...
virtual bool	HasPFSystem (INode *node)=0
	Checks if the given PFSystem node is present in the scene. More...
virtual bool	HasPFSystemByHandle (int handle)=0
	Check if the scene has a PFSystem with the given node handle. More...
virtual int	RegisterNotification (NOTIFYPROC proc, void *param)=0
	Register notification with the PFSystem pool. More...
virtual int	UnRegisterNotification (NOTIFYPROC proc, void *param)=0
	Unregister notification with the PFSystem pool. More...
FPInterfaceDesc *	GetDesc ()
PFExport	IPFSystemPool ()

Variables
static IPFSystemPool *	m_pool

Friends
PFExport IPFSystemPool *	GetPFSystemPool ()
	Friend function declarations. More...

Function Documentation

virtual int NumPFSystems ( )

pure virtual

returns number of PFSystems in the current scene

virtual INode* GetPFSystem ( int  i )

pure virtual

Returns i-th PFSystem in the scene.

Parameters

i	PFSystem index

virtual bool HasPFSystem ( INode *  node )

pure virtual

Checks if the given PFSystem node is present in the scene.

Parameters

node	PFSystem node

virtual bool HasPFSystemByHandle ( int  handle )

pure virtual

Check if the scene has a PFSystem with the given node handle.

virtual int RegisterNotification ( NOTIFYPROC  proc, void *  param  )

pure virtual

Register notification with the PFSystem pool.

The given function is called each time the set of all PFSystems is changing. Returns nonzero if the event was registered; otherwise zero.

Parameters

proc	The callback function called when the event occurs.
param	A pointer that is passed to the callback function when the notification is made.

virtual int UnRegisterNotification ( NOTIFYPROC  proc, void *  param  )

pure virtual

Unregister notification with the PFSystem pool.

This function is called to break the connection between the event and the callback. After this function executes the callback is no longer invoked when the event occurs. Returns nonzero if the event was unregistered; otherwise zero.

Parameters

proc	The callback function called when the event occurs.
param	A pointer that is passed to the callback function when the notification is made.

FPInterfaceDesc* GetDesc ( )

inlinevirtual

Remarks

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

Implements FPInterface.

{ return GetDescByID(PFSYSTEMPOOL_INTERFACE); }

PFExport IPFSystemPool ( )

protected

Variable Documentation

IPFSystemPool* m_pool

staticprotected

Friends

PFExport IPFSystemPool* GetPFSystemPool ( )

friend

Friend function declarations.