RenderWorldHandle Class Reference

RenderWorldHandle is the base wrapper class of the nitrous world. More...

#include <RenderWorldHandle.h>

Inheritance diagram for RenderWorldHandle:

Public Member Functions
GraphicsDriverAPI	RenderWorldHandle ()
GraphicsDriverAPI	RenderWorldHandle (const RenderWorldHandle &from)
GraphicsDriverAPI RenderWorldHandle &	operator= (const RenderWorldHandle &from)
virtual GraphicsDriverAPI	~RenderWorldHandle ()
GraphicsDriverAPI bool	Initialize ()
	Initialize this render world. More...
GraphicsDriverAPI void	Reset ()
	Call Reset() to clear all render nodes. More...
GraphicsDriverAPI bool	AddNode (const RenderNodeHandle &node)
	Add a render node to the world. More...
GraphicsDriverAPI void	RemoveNode (const RenderNodeHandle &node)
	Remove a render node from the world. More...
GraphicsDriverAPI void	UpdateNodes ()
	Synchronize changes to all render nodes from client side to server side. More...
GraphicsDriverAPI size_t	GetNumberOfNodes () const
	Get count of all render nodes in the world. More...
GraphicsDriverAPI RenderNodeIterator	NodeBegin ()
	Returns an iterator referring to the first node in the render world. More...
GraphicsDriverAPI RenderNodeIterator	NodeEnd ()
	Returns an iterator referring to the past-the-end node in the render world. More...
GraphicsDriverAPI const Box3 &	GetWorldBox ()
	Get the bounding box of all render nodes in the world. More...
GraphicsDriverAPI Box3	GetShadowWorldBox ()
	Get the bounding box of all render nodes casting shadows in the world. More...
Public Member Functions inherited from SmartHandle
virtual GraphicsDriverAPI	~SmartHandle ()
	destructor More...
GraphicsDriverAPI bool	IsValid () const
	Check if this handle is valid. More...
GraphicsDriverAPI void	Release ()
	Release the underlying graphics objects. More...
GraphicsDriverAPI Identifier	GetObjectID () const
	Get the underlying graphics object id. More...
GraphicsDriverAPI void	SetPointer (IRefObject *pObject)
GraphicsDriverAPI IRefObject *	GetPointer () const
	Get the underlying graphics object pointer. More...
bool	operator== (const SmartHandle &rhs) const
bool	operator!= (const SmartHandle &rhs) const
bool	operator< (const SmartHandle &rhs) const
bool	operator<= (const SmartHandle &rhs) const
bool	operator> (const SmartHandle &rhs) const
bool	operator>= (const SmartHandle &rhs) const
GraphicsDriverAPI	SmartHandle (const SmartHandle &)
GraphicsDriverAPI SmartHandle &	operator= (const SmartHandle &)

Static Public Member Functions
static GraphicsDriverAPI Class_ID	ClassID ()
	Gets the class ID that can identify this type of handle. More...
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...

Additional Inherited Members
Protected Member Functions inherited from SmartHandle
GraphicsDriverAPI	SmartHandle ()
Protected Attributes inherited from SmartHandle
IRefObject *	mpObject

Detailed Description

RenderWorldHandle is the base wrapper class of the nitrous world.

Constructor & Destructor Documentation

RenderWorldHandle() [1/2]

GraphicsDriverAPI RenderWorldHandle

(

)

RenderWorldHandle() [2/2]

GraphicsDriverAPI RenderWorldHandle

(

const RenderWorldHandle &

from

)

~RenderWorldHandle()

virtual GraphicsDriverAPI ~RenderWorldHandle ( )

virtual

Member Function Documentation

operator=()

GraphicsDriverAPI RenderWorldHandle& operator=

(

const RenderWorldHandle &

from

)

Initialize()

GraphicsDriverAPI bool Initialize

(

)

Initialize this render world.

Returns

true if successfully initialized, false otherwise.

Reset()

GraphicsDriverAPI void Reset

(

)

Call Reset() to clear all render nodes.

AddNode()

GraphicsDriverAPI bool AddNode

(

const RenderNodeHandle &

node

)

Add a render node to the world.

Parameters

[in]

node

the render node to be added

Returns

true if successfully added, false otherwise.

RemoveNode()

GraphicsDriverAPI void RemoveNode

(

const RenderNodeHandle &

node

)

Remove a render node from the world.

Parameters

[in]

node

the render node to be removed

UpdateNodes()

GraphicsDriverAPI void UpdateNodes

(

)

Synchronize changes to all render nodes from client side to server side.

GetNumberOfNodes()

GraphicsDriverAPI size_t GetNumberOfNodes

(

)

const

Get count of all render nodes in the world.

Returns

the count of nodes

NodeBegin()

GraphicsDriverAPI RenderNodeIterator NodeBegin

(

)

Returns an iterator referring to the first node in the render world.

Returns

an iterator referring to the first node in the render world.

NodeEnd()

GraphicsDriverAPI RenderNodeIterator NodeEnd

(

)

Returns an iterator referring to the past-the-end node in the render world.

Returns

an iterator referring to the past-the-end node in the render world.

GetWorldBox()

GraphicsDriverAPI const Box3& GetWorldBox

(

)

Get the bounding box of all render nodes in the world.

Returns

the bounding box of all render nodes in the world

GetShadowWorldBox()

GraphicsDriverAPI Box3 GetShadowWorldBox

(

)

Get the bounding box of all render nodes casting shadows in the world.

Returns

the bounding box of all render nodes casting shadows in the world

ClassID()

static GraphicsDriverAPI Class_ID ClassID ( )

static

Gets the class ID that can identify this type of handle.

Returns

Gets the class ID that can identify this type of handle