IRenderItemContainer Class Reference

A render item container, it provides various methods to access the contained render items. More...

#include <IRenderItemContainer.h>

Inheritance diagram for IRenderItemContainer:

Public Member Functions
virtual size_t	GetNumberOfRenderItems () const =0
	Get the number of render items contained in this container. More...
virtual RenderItemHandle	GetRenderItem (size_t i) const =0
	Get the i-th render item in this container. More...
GraphicsDriverAPI RenderItemHandle	FindRenderItem (unsigned long descriptionBits) const
	Find a render item with the specified mesh element description. More...
GraphicsDriverAPI RenderItemHandleArray	FindAllRenderItems (unsigned long descriptionBits) const
	Find all render items with the specified mesh element description. More...
virtual void	AddRenderItem (const RenderItemHandle &pRenderItem)=0
	Add a render item into this container. More...
virtual void	AddRenderItems (const IRenderItemContainer &renderItemContainer)=0
	Add all render items from the specified render item container into this container. More...
virtual void	RemoveRenderItem (size_t i)=0
	Remove the render item with the specified index from the container. More...
virtual void	ClearAllRenderItems ()=0
	Remove all render items from this container. More...

Protected Member Functions
virtual	~IRenderItemContainer ()

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Detailed Description

A render item container, it provides various methods to access the contained render items.

Constructor & Destructor Documentation

~IRenderItemContainer()

virtual ~IRenderItemContainer ( )

inlineprotectedvirtual

{}

Member Function Documentation

GetNumberOfRenderItems()

virtual size_t GetNumberOfRenderItems ( ) const

pure virtual

Get the number of render items contained in this container.

Returns

the number of render items contained in this container.

Implemented in RenderItemHandleArray.

GetRenderItem()

virtual RenderItemHandle GetRenderItem ( size_t  i ) const

pure virtual

Get the i-th render item in this container.

Parameters

i	the index of the render item to be retrieved.

Returns

the i-th render item in this container.

Implemented in RenderItemHandleArray.

FindRenderItem()

GraphicsDriverAPI RenderItemHandle FindRenderItem

(

unsigned long

descriptionBits

)

const

Find a render item with the specified mesh element description.

Parameters

descriptionBits

the unique ID associated with the specified mesh element description.

See also

MeshElementDescription::GetDescriptionBits()

Returns

the render item with the mesh element description.

FindAllRenderItems()

GraphicsDriverAPI RenderItemHandleArray FindAllRenderItems

(

unsigned long

descriptionBits

)

const

Find all render items with the specified mesh element description.

Parameters

descriptionBits

the unique ID associated with the specified mesh element description.

See also

MeshElementDescription::GetDescriptionBits()

Returns

the render item array with the mesh element description.

AddRenderItem()

virtual void AddRenderItem ( const RenderItemHandle &  pRenderItem )

pure virtual

Add a render item into this container.

Parameters

pRenderItem

the render item to add.

Implemented in RenderItemHandleArray.

AddRenderItems()

virtual void AddRenderItems ( const IRenderItemContainer &  renderItemContainer )

pure virtual

Add all render items from the specified render item container into this container.

Parameters

renderItemContainer

the render item container that the render items in which would be added into this container.

Implemented in RenderItemHandleArray.

RemoveRenderItem()

virtual void RemoveRenderItem ( size_t  i )

pure virtual

Remove the render item with the specified index from the container.

Parameters

i	the index of the render item to be removed.

Implemented in RenderItemHandleArray.

ClearAllRenderItems()

virtual void ClearAllRenderItems ( )

pure virtual

Remove all render items from this container.

Implemented in RenderItemHandleArray.