IRenderItemContainer Class Reference
 
 
 
IRenderItemContainer Class Reference

#include <IRenderItemContainer.h>

Inheritance diagram for IRenderItemContainer:
MaxHeapOperators RenderItemHandleArray

Class Description

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

Public Member Functions

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

Protected Member Functions

virtual  ~IRenderItemContainer ()

Constructor & Destructor Documentation

virtual ~IRenderItemContainer ( ) [inline, protected, virtual]
{}

Member Function Documentation

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.

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.

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.
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.
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.

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.

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.

virtual void ClearAllRenderItems ( ) [pure virtual]

Remove all render items from this container.

Implemented in RenderItemHandleArray.