IPFRender.h

Module description

Functions
virtual int	HasRenderableGeometry ()
	The following methods are redirected from the particle object level to a particular ActionList. More...
virtual int	IsInstanceDependent (IObject *pCont, Object *pSystem)
	If an object creates different meshes depending on the particular instance (view-dependent) it should return 1. More...
virtual Mesh *	GetRenderMesh (IObject *pCont, TimeValue t, Object *pSystem, INode *inode, View &view, BOOL &needDelete)=0
	GetRenderMesh should be implemented by all renderable GeomObjects. More...
virtual int	NumberOfRenderMeshes (IObject *pCont, TimeValue t, Object *pSystem)
	Objects may now supply multiple render meshes. More...
virtual Mesh *	GetMultipleRenderMesh (IObject *pCont, TimeValue t, Object *pSystem, INode *inode, View &view, BOOL &needDelete, int meshNumber)
	For multiple render meshes, this method must be implemented. More...
virtual void	GetMultipleRenderMeshTM (IObject *pCont, TimeValue t, Object *pSystem, INode *inode, View &view, int meshNumber, Matrix3 &meshTM, Interval &meshTMValid)
	For multiple render meshes, this method must be implemented. More...
virtual PatchMesh *	GetRenderPatchMesh (IObject *pCont, TimeValue t, Object *pSystem, INode *inode, View &view, BOOL &needDelete)
	If this returns NULL, then GetRenderMesh will be called. More...
virtual Class_ID	PreferredCollapseType (IObject *pCont, Object *pSystem)
	This method allows objects to specify the class that is the best class to convert to when the user collapses the stack. More...
virtual BOOL	CanDoDisplacementMapping (IObject *pCont, Object *pSystem)
	Returns TRUE if this object can do displacement mapping; otherwise FALSE. More...
FPInterfaceDesc *	GetDesc ()

Function Documentation

virtual int HasRenderableGeometry ( )

inlinevirtual

The following methods are redirected from the particle object level to a particular ActionList.

The first parameter is a particle container of the ActionList. Returns 0 if the action doesn't render in all frames for any reason, for example a non-animated parameter prevents render.

{ return(1); }

virtual int IsInstanceDependent ( IObject *  pCont, Object *  pSystem  )

inlinevirtual

If an object creates different meshes depending on the particular instance (view-dependent) it should return 1.

Parameters

pCont	particle container to render particles from
pSystem	master particle system shell

{ return 0; }

virtual Mesh* GetRenderMesh ( IObject *  pCont, TimeValue  t, Object *  pSystem, INode *  inode, View &  view, BOOL &  needDelete  )

pure virtual

GetRenderMesh should be implemented by all renderable GeomObjects.

Set needDelete to TRUE if the render should delete the mesh, FALSE otherwise. Primitives that already have a mesh cached can just return a pointer to it (and set needDelete = FALSE).

Parameters

pCont	particle container to render particles from
t	current frame to render particles at. It's supposed that the container has been already updated to satisfy this moment
pSystem	master particle system shell
inode	INode of the particle group
view	View as of the GeomObject::GetRenderMesh() method
needDelete	boolean as of the GeomObject::GetRenderMesh() method

virtual int NumberOfRenderMeshes ( IObject *  pCont, TimeValue  t, Object *  pSystem  )

inlinevirtual

Objects may now supply multiple render meshes.

If this function returns a positive number, then GetMultipleRenderMesh and GetMultipleRenderMeshTM will be called for each mesh, instead of calling GetRenderMesh.

Parameters

pCont	particle container to render particles from
t	current frame to render particles at. It's supposed that the container has been already updated to satisfy this moment
pSystem	master particle system shell

{ return 0; } // 0 indicates multiple meshes not supported.

virtual Mesh* GetMultipleRenderMesh ( IObject *  pCont, TimeValue  t, Object *  pSystem, INode *  inode, View &  view, BOOL &  needDelete, int  meshNumber  )

inlinevirtual

For multiple render meshes, this method must be implemented.

Set needDelete to TRUE if the render should delete the mesh, FALSE otherwise. meshNumber specifies which of the multiplie meshes is being asked for.

Parameters

pCont	particle container to render particles from
t	current frame to render particles at. It's supposed that the container has been already updated to satisfy this moment
pSystem	master particle system shell
inode	INode of the particle group
view	View as of the GeomObject::GetRenderMesh() method
needDelete	boolean as of the GeomObject::GetRenderMesh() method
meshNumber	specifies which of the multiplie meshes is being asked for

{ return NULL; }

virtual void GetMultipleRenderMeshTM ( IObject *  pCont, TimeValue  t, Object *  pSystem, INode *  inode, View &  view, int  meshNumber, Matrix3 &  meshTM, Interval &  meshTMValid  )

inlinevirtual

For multiple render meshes, this method must be implemented.

meshTM should be returned with the transform defining the offset of the particular mesh in object space. meshTMValid should contain the validity interval of meshTM

Parameters

pCont	particle container to render particles from
t	current frame to render particles at. It's supposed that the container has been already updated to satisfy this moment
pSystem	master particle system shell
inode	INode of the particle group
view	View as of the GeomObject::GetRenderMesh() method
meshNumber	specifies which of the multiplie meshes is being asked for
meshTM
meshTMValid

                                                            { return;  }

virtual PatchMesh* GetRenderPatchMesh ( IObject *  pCont, TimeValue  t, Object *  pSystem, INode *  inode, View &  view, BOOL &  needDelete  )

inlinevirtual

If this returns NULL, then GetRenderMesh will be called.

Parameters

pCont	particle container to render particles from
t	current frame to render particles at. It's supposed that the container has been already updated to satisfy this moment
pSystem	master particle system shell
inode	INode of the particle group
view	View as of the GeomObject::GetRenderMesh() method
needDelete	boolean as of the GeomObject::GetRenderMesh() method

{ return NULL; }

virtual Class_ID PreferredCollapseType ( IObject *  pCont, Object *  pSystem  )

inlinevirtual

This method allows objects to specify the class that is the best class to convert to when the user collapses the stack.

Parameters

pCont	particle container
pSystem	master particle system shell

Returns

The Class_ID of the preferred object type.

{ return triObjectClassID; }

virtual BOOL CanDoDisplacementMapping ( IObject *  pCont, Object *  pSystem  )

inlinevirtual

Returns TRUE if this object can do displacement mapping; otherwise FALSE.

Parameters

pCont	particle container
pSystem	master particle system shell

{ return 0; }

FPInterfaceDesc* GetDesc ( )

inlinevirtual

Remarks

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

Implements FPInterface.

{ return GetDescByID(PFRENDER_INTERFACE); }