IMeshDisplay2 Class Reference

This reference page is linked to from the following overview topics: Nitrous Graphics SDK Extensions, Plug-in Display Interface, About RenderItem.

---

Search for all occurrences

#include <IMeshDisplay2.h>

Inheritance diagram for IMeshDisplay2:

---

Class Description

Use this interface to query the per node related render items from a mesh or mnesh.

One can directly query this interface from a mesh or mnmesh object.

Public Member Functions
GraphicsDriverAPI	IMeshDisplay2 ()
virtual GraphicsDriverAPI	~IMeshDisplay2 ()
virtual void	PrepareDisplay (const GenerateMeshRenderItemsContext &generateRenderItemsContext)=0
virtual bool	GetRenderItems (const MaxContext &maxContext, const GenerateMeshRenderItemsContext &generateRenderItemsContext, UpdateNodeContext &nodeContext, IRenderItemContainer &targetRenderItemContainer)=0
	This function is usually called by IObjectDisplay2::UpdatePerNodeItems() to get accurate render items specified by generateRenderItemsContext to match the accurate per-node requirements for the current node's specific render items.
virtual GraphicsDriverAPI Interface_ID	GetID ()
virtual GraphicsDriverAPI BaseInterface *	GetInterface (Interface_ID id)

---

Constructor & Destructor Documentation

GraphicsDriverAPI IMeshDisplay2

(

)

virtual GraphicsDriverAPI ~IMeshDisplay2

(

)

[virtual]

---

Member Function Documentation

virtual void PrepareDisplay

(

const GenerateMeshRenderItemsContext &

generateRenderItemsContext

)

[pure virtual]

Search for all occurrences

virtual bool GetRenderItems	(	const MaxContext &	maxContext,
		const GenerateMeshRenderItemsContext &	generateRenderItemsContext,
		UpdateNodeContext &	nodeContext,
		IRenderItemContainer &	targetRenderItemContainer
	)		[pure virtual]

Search for all occurrences

This function is usually called by IObjectDisplay2::UpdatePerNodeItems() to get accurate render items specified by generateRenderItemsContext to match the accurate per-node requirements for the current node's specific render items.

Parameters:

maxContext	Contains all viewports in which this object will be displayed.
generateRenderItemContext	contains all the information that is used to generate all the required render items.
nodeContext	which contains all infos required for adding per node relevant render items.
targetRenderItemContainer	the target render item container.

Returns:

true if successful or false otherwise

virtual GraphicsDriverAPI Interface_ID GetID

(

)

[virtual]

Search for all occurrences

Remarks:

This method returns the unique interface ID.

Reimplemented from BaseInterface.

virtual GraphicsDriverAPI BaseInterface* GetInterface

(

Interface_ID

id

)

[virtual]

Search for all occurrences

Remarks:

Returns a pointer to the interface whose ID is specified.

Parameters:

Interface_ID id

The ID of the interface to return.

Default Implementation:

{ return NULL; }

Reimplemented from BaseInterface.