RenderItemHandleArray Class Reference
 
 
 
RenderItemHandleArray Class Reference

#include <RenderItemHandleArray.h>

Inheritance diagram for RenderItemHandleArray:
IRenderItemContainer MaxHeapOperators

Class Description

This is a utility class.

It is used for storing a set of render items.

Public Member Functions

GraphicsDriverAPI  RenderItemHandleArray ()
GraphicsDriverAPI  RenderItemHandleArray (const RenderItemHandleArray &from)
GraphicsDriverAPI
RenderItemHandleArray
operator= (const RenderItemHandleArray &from)
virtual GraphicsDriverAPI  ~RenderItemHandleArray ()
GraphicsDriverAPI size_t  GetNumberOfRenderItems () const
  Get the number of render items contained in this container.
GraphicsDriverAPI RenderItemHandle  GetRenderItem (size_t i) const
  Get the i-th render item in this container.
GraphicsDriverAPI void  AddRenderItem (const RenderItemHandle &pRenderItem)
  Add a render item into this container.
GraphicsDriverAPI void  AddRenderItems (const IRenderItemContainer &renderItemContainer)
  Add all render items from the specified render item container into this array.
GraphicsDriverAPI void  RemoveRenderItem (size_t i)
  Remove the render item with the specified index from the container.
GraphicsDriverAPI void  ClearAllRenderItems ()
  Remove all render items from this container.

Constructor & Destructor Documentation

GraphicsDriverAPI RenderItemHandleArray ( )
GraphicsDriverAPI RenderItemHandleArray ( const RenderItemHandleArray from )
virtual GraphicsDriverAPI ~RenderItemHandleArray ( ) [virtual]

Member Function Documentation

GraphicsDriverAPI RenderItemHandleArray& operator= ( const RenderItemHandleArray from )
GraphicsDriverAPI size_t GetNumberOfRenderItems ( ) const [virtual]

Get the number of render items contained in this container.

Returns:
the number of render items contained in this container.

Implements IRenderItemContainer.

GraphicsDriverAPI RenderItemHandle GetRenderItem ( size_t  i ) const [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.

Implements IRenderItemContainer.

GraphicsDriverAPI void AddRenderItem ( const RenderItemHandle pRenderItem ) [virtual]

Add a render item into this container.

Parameters:
pRenderItem the render item to add.

Implements IRenderItemContainer.

GraphicsDriverAPI void AddRenderItems ( const IRenderItemContainer renderItemContainer ) [virtual]

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

Parameters:
renderItemContainer the render item container that the render items in which would be added into this array.

Implements IRenderItemContainer.

GraphicsDriverAPI void RemoveRenderItem ( size_t  i ) [virtual]

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

Parameters:
i the index of the render item to be removed.

Implements IRenderItemContainer.

GraphicsDriverAPI void ClearAllRenderItems ( ) [virtual]

Remove all render items from this container.

Implements IRenderItemContainer.