IPFSystemPool.h

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

---

Function Documentation

int NumPFSystems

(

)

[pure virtual, inherited]

Search for all occurrences

returns number of PFSystems in the current scene

INode * GetPFSystem

(

int

i

)

[pure virtual, inherited]

Search for all occurrences

Returns i-th PFSystem in the scene.

Parameters:

i,:	PFSystem index

bool HasPFSystem

(

INode *

node

)

[pure virtual, inherited]

Search for all occurrences

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

Parameters:

node,:

PFSystem node

bool HasPFSystemByHandle

(

int

handle

)

[pure virtual, inherited]

Search for all occurrences

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

int RegisterNotification	(	NOTIFYPROC	proc,
		void *	param
	)		[pure virtual, inherited]

Search for all occurrences

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.

int UnRegisterNotification	(	NOTIFYPROC	proc,
		void *	param
	)		[pure virtual, inherited]

Search for all occurrences

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.

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

PFExport IPFSystemPool

(

)

[protected, inherited]

Search for all occurrences

---

Variable Documentation

IPFSystemPool* m_pool [static, protected, inherited]

Search for all occurrences

---

Friends

PFExport IPFSystemPool * GetPFSystemPool

(

)

[friend, inherited]

Search for all occurrences

Friend function declarations.