ViewParameter Class Reference

This class wrap up all viewport related parameters. More...

#include <ViewParameter.h>

Inheritance diagram for ViewParameter:

Public Member Functions
GraphicsDriverAPI	ViewParameter ()
	Constructor. More...
virtual GraphicsDriverAPI	~ViewParameter ()
	Destructor. More...
GraphicsDriverAPI ViewExp *	GetViewExp () const
	Get the render view's ViewExp. More...
GraphicsDriverAPI void	SetViewExp (ViewExp *viewExp)
	Set the render view's ViewExp. More...
GraphicsDriverAPI size_t	GetWidth () const
	Get the render view's width. More...
GraphicsDriverAPI size_t	GetHeight () const
	Get the render view's height. More...
GraphicsDriverAPI void	SetSize (const RectangleSize &viewSize)
	Set the render view's width and height. More...
GraphicsDriverAPI void	SetRenderRegion (const RenderRegion &renderRegion)
	Set the render region of the render view. More...
GraphicsDriverAPI const RenderRegion &	GetRenderRegion () const
	Get the render region of the render view. More...
GraphicsDriverAPI bool	IsRenderRegionVisible () const
	Indicate whether the render region intersection with the view after computation. More...
GraphicsDriverAPI const FBox2 &	GetClippedTargetRegion () const
	Get the intersection position in the view coordinate if having intersection. More...
GraphicsDriverAPI const FBox2 &	GetClippedSourceRegion () const
	Get the intersection position in the source coordinate if having intersection. More...
GraphicsDriverAPI CameraPtr	GetCamera () const
	Get the camera of the render view. More...
Public Member Functions inherited from ARefObject
GraphicsUtilityAPI	ARefObject ()
virtual GraphicsUtilityAPI long	AddRef ()
	from IRefObject, see comments in IRefObject More...
virtual GraphicsUtilityAPI long	Release ()
	decrease reference count of this object by one, if the decreased reference count equals zero, the object will be deleted. More...
GraphicsUtilityAPI IRefObject *	QueryInterface (Interface_ID classID)
	Try query an interface from the ref object using a given interface id. More...
Public Member Functions inherited from IRefObject
GraphicsUtilityAPI	IRefObject ()
virtual GraphicsUtilityAPI	~IRefObject ()

Protected Attributes
ViewParameterData *	mpData

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...
Protected Member Functions inherited from ARefObject
virtual GraphicsUtilityAPI void	DeleteThis ()
	This function will be called when the reference count of an ARefObject equals zero. More...
virtual GraphicsUtilityAPI	~ARefObject ()

Detailed Description

This class wrap up all viewport related parameters.

For e.g., the width and height of render view render region,frame draw method etc.,.

Constructor & Destructor Documentation

ViewParameter()

GraphicsDriverAPI ViewParameter

(

)

Constructor.

~ViewParameter()

virtual GraphicsDriverAPI ~ViewParameter ( )

virtual

Destructor.

Member Function Documentation

GetViewExp()

GraphicsDriverAPI ViewExp* GetViewExp

(

)

const

Get the render view's ViewExp.

Returns

the ViewExp of the render view.

SetViewExp()

GraphicsDriverAPI void SetViewExp

(

ViewExp *

viewExp

)

Set the render view's ViewExp.

Parameters

[in]

viewExp

the ViewExp of the render view.

GetWidth()

GraphicsDriverAPI size_t GetWidth

(

)

const

Get the render view's width.

Returns

the width of the render view.

GetHeight()

GraphicsDriverAPI size_t GetHeight

(

)

const

Get the render view's height.

Returns

the height of the render view.

SetSize()

GraphicsDriverAPI void SetSize

(

const RectangleSize &

viewSize

)

Set the render view's width and height.

Parameters

[in]

viewSize

the rectangle size of the render view.

SetRenderRegion()

GraphicsDriverAPI void SetRenderRegion

(

const RenderRegion &

renderRegion

)

Set the render region of the render view.

Parameters

[in]

renderRegion

this parameter is one struct type that includes the clipping rectangle,offset and scales of the original render target in the screen space of the render view.

GetRenderRegion()

GraphicsDriverAPI const RenderRegion& GetRenderRegion

(

)

const

Get the render region of the render view.

Returns

the render region that includes the scales,clipping rectangle and offset of the original render target in the screen space of the render view.

IsRenderRegionVisible()

GraphicsDriverAPI bool IsRenderRegionVisible

(

)

const

Indicate whether the render region intersection with the view after computation.

Returns

true if having intersection or false otherwise.

GetClippedTargetRegion()

GraphicsDriverAPI const FBox2& GetClippedTargetRegion

(

)

const

Get the intersection position in the view coordinate if having intersection.

Returns

the intersection position in the view coordinate.

GetClippedSourceRegion()

GraphicsDriverAPI const FBox2& GetClippedSourceRegion

(

)

const

Get the intersection position in the source coordinate if having intersection.

Returns

the intersection position in the source coordinate.

GetCamera()

GraphicsDriverAPI CameraPtr GetCamera

(

)

const

Get the camera of the render view.

Returns

the camera of the render view

Member Data Documentation

mpData

ViewParameterData* mpData

protected