3ds Max C++ API Reference
RenderItemHandleArray Class Reference

This is a utility class. More...

#include <RenderItemHandleArray.h>

+ Inheritance diagram for RenderItemHandleArray:

Public Member Functions

GraphicsDriverAPI RenderItemHandleArray ()
 
GraphicsDriverAPI RenderItemHandleArray (const RenderItemHandleArray &from)
 
GraphicsDriverAPI RenderItemHandleArrayoperator= (const RenderItemHandleArray &from)
 
virtual GraphicsDriverAPI ~RenderItemHandleArray ()
 
GraphicsDriverAPI size_t GetNumberOfRenderItems () const
 Get the number of render items contained in this container. More...
 
GraphicsDriverAPI RenderItemHandle GetRenderItem (size_t i) const
 Get the i-th render item in this container. More...
 
GraphicsDriverAPI void AddRenderItem (const RenderItemHandle &pRenderItem)
 Add a render item into this container. More...
 
GraphicsDriverAPI void AddRenderItems (const IRenderItemContainer &renderItemContainer)
 Add all render items from the specified render item container into this array. More...
 
GraphicsDriverAPI void RemoveRenderItem (size_t i)
 Remove the render item with the specified index from the container. More...
 
GraphicsDriverAPI void ClearAllRenderItems ()
 Remove all render items from this container. More...
 
- Public Member Functions inherited from IRenderItemContainer
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...
 

Additional Inherited Members

- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_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...
 
- Protected Member Functions inherited from IRenderItemContainer
virtual ~IRenderItemContainer ()
 

Detailed Description

This is a utility class.

It is used for storing a set of render items.

Constructor & Destructor Documentation

◆ RenderItemHandleArray() [1/2]

◆ RenderItemHandleArray() [2/2]

◆ ~RenderItemHandleArray()

Member Function Documentation

◆ operator=()

◆ GetNumberOfRenderItems()

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.

◆ GetRenderItem()

GraphicsDriverAPI RenderItemHandle GetRenderItem ( size_t  i) const
virtual

Get the i-th render item in this container.

Parameters
ithe index of the render item to be retrieved.
Returns
the i-th render item in this container.

Implements IRenderItemContainer.

◆ AddRenderItem()

GraphicsDriverAPI void AddRenderItem ( const RenderItemHandle pRenderItem)
virtual

Add a render item into this container.

Parameters
pRenderItemthe render item to add.

Implements IRenderItemContainer.

◆ AddRenderItems()

GraphicsDriverAPI void AddRenderItems ( const IRenderItemContainer renderItemContainer)
virtual

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

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

Implements IRenderItemContainer.

◆ RemoveRenderItem()

GraphicsDriverAPI void RemoveRenderItem ( size_t  i)
virtual

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

Parameters
ithe index of the render item to be removed.

Implements IRenderItemContainer.

◆ ClearAllRenderItems()

GraphicsDriverAPI void ClearAllRenderItems ( )
virtual

Remove all render items from this container.

Implements IRenderItemContainer.