ParaEngine::CViewportManager Class Reference

manager multiple viewport More...

#include <ViewportManager.h>

Inheritance diagram for ParaEngine::CViewportManager:

Public Member Functions
	ATTRIBUTE_DEFINE_CLASS (CViewportManager)
virtual int	InstallFields (CAttributeClass *pClass, bool bOverride)
	this class should be implemented if one wants to add new attribute. More...
virtual IAttributeFields *	GetChildAttributeObject (const std::string &sName)
	get attribute by child object. More...
virtual int	GetChildAttributeObjectCount (int nColumnIndex=0)
	get the number of child objects (row count) in the given column. More...
virtual IAttributeFields *	GetChildAttributeObject (int nRowIndex, int nColumnIndex=0)
void	UpdateViewport (int nBackbufferWidth, int nBackbufferHeight)
	call this function when the window size and screen back buffer size is changed
HRESULT	Render (double dTimeDelta, int nPipelineOrder)
	render all view ports
void	GetPointOnViewport (int &x, int &y, int *pWidth, int *pHeight)
CViewport *	GetViewportByPoint (int x, int y)
void	SetLayout (VIEWPORT_LAYOUT nLayout, CSceneObject *pMainScene=NULL, CGUIRoot *pGUIRoot=NULL)
	set default view layout
VIEWPORT_LAYOUT	GetLayout ()
void	UpdateLayout ()
	just in case the size changed. More...
int	GetViewportCount ()
void	SetViewportCount (int nCount)
void	GetCurrentViewport (ParaViewport &out)
	get current viewport
CViewport *	CreateGetViewPort (int nIndex=1)
	add view port More...
CViewport *	GetActiveViewPort ()
void	SetActiveViewPortIndex (int val)
void	SetActiveViewPort (CViewport *pViewport)
void	DeleteViewPort (int nIndex=0)
void	Cleanup ()
int	GetWidth () const
int	GetHeight () const
void	ApplyViewport ()
int	getCurrentFrameNumber () const
Public Member Functions inherited from ParaEngine::IAttributeFields
virtual int	GetAttributeClassID ()
	attribute class ID should be identical, unless one knows how overriding rules work. More...
virtual const char *	GetAttributeClassName ()
	a static string, describing the attribute class object's name
virtual const char *	GetAttributeClassDescription ()
	a static string, describing the attribute class object
virtual int	GetChildAttributeColumnCount ()
	we support multi-dimensional child object. More...
	ATTRIBUTE_METHOD1 (IAttributeFields, GetName_s, const char **)
	ATTRIBUTE_METHOD1 (IAttributeFields, SetName_s, const char *)
	ATTRIBUTE_METHOD (IAttributeFields, PrintObject_s)
	ATTRIBUTE_METHOD (IAttributeFields, AddRef_s)
	ATTRIBUTE_METHOD1 (IAttributeFields, GetRefCount_s, int *)
	ATTRIBUTE_METHOD1 (IAttributeFields, SetTime_s, int)
	ATTRIBUTE_METHOD1 (IAttributeFields, GetTime_s, int *)
	ATTRIBUTE_METHOD (IAttributeFields, Release_s)
virtual const std::string &	GetIdentifier ()
virtual void	SetIdentifier (const std::string &sID)
virtual bool	IsModified ()
	whether some of the fields are modified.It is up to the implementation class to provide this functionality if necessary. More...
virtual void	SetModified (bool bModified)
	set whether any field has been modified. More...
virtual bool	ValidateFields ()
	validate all fields and return true if validation passed. More...
virtual string	GetValidationMessage ()
	get the recent validation message due to the most recent call to ValidateFields()
virtual bool	ResetField (int nFieldID)
	Reset the field to its initial or default value. More...
virtual bool	InvokeEditor (int nFieldID, const std::string &sParameters)
	Invoke an (external) editor for a given field. More...
virtual bool	AddChildAttributeObject (IAttributeFields *pChild, int nRowIndex=-1, int nColumnIndex=0)
	add child object. More...
virtual void *	QueryObjectByName (const std::string &sObjectType)
	convert to object of a given type. More...
virtual void *	QueryObject (int nObjectType)
	convert to object of a given type. More...
virtual int	GetTime ()
	get the current local time in case it is animated in milli seconds frames. More...
virtual void	SetTime (int nTime)
virtual CDynamicAttributeField *	GetDynamicField (const std::string &sName)
	Get a dynamic field with a given name. More...
virtual CDynamicAttributeField *	GetDynamicField (int nIndex)
	Get a dynamic field with a given index. More...
virtual const char *	GetDynamicFieldNameByIndex (int nIndex)
	get field name by index
virtual int	GetDynamicFieldCount ()
	how many dynamic field this object currently have. More...
virtual int	SetDynamicField (const std::string &sName, const CVariable &value)
	set a dynamic field with a given name. More...
virtual int	AddDynamicField (const std::string &sName, ATTRIBUTE_FIELDTYPE dwType)
	add dynamic field and return field index
virtual void	RemoveAllDynamicFields ()
	remove all dynamic fields
virtual int	SaveDynamicFieldsToString (std::string &output)
	save only text dynamic fields to fieldname = value text strings. More...
virtual int	LoadDynamicFieldsFromString (const std::string &input)
	load only text dynamic fields from string More...
CAttributeClass *	GetAttributeClass ()
	get the main attribute class object. More...
void	PrintObject ()
	print the content of this object to a text file at temp/doc/[ClassName].txt. More...
Public Member Functions inherited from ParaEngine::IObject
virtual void	Clone (IObject *obj) const
	Clone the object's contains to a pointer. More...
virtual IObject *	Clone () const
	Clone the object's contains and return a pointer to the newly created object. More...
virtual bool	Equals (const IObject *obj) const
	Compare the object with another object. More...
virtual const IType *	GetType () const
virtual std::string	ToString () const
WeakPtr_type &	GetWeakReference ()
	get weak reference object. More...
virtual int	ProcessObjectEvent (const ObjectEvent &event)
	this function is only used to backward compatibility of ParaObject:AddEvent() function. More...
Public Member Functions inherited from ParaEngine::CRefCounted
void	addref () const
	add reference count of the object. More...
bool	delref () const
	decrease reference count of the object. More...
int	GetRefCount () const
	get the reference count
virtual int	Release ()
CRefCounted *	AddToAutoReleasePool ()
	addref and releases the ownership sometime soon automatically (usually at the end of the current frame). More...

Additional Inherited Members
Public Types inherited from ParaEngine::IAttributeFields
typedef ParaEngine::weak_ptr< IObject, IAttributeFields >	WeakPtr_type
Public Types inherited from ParaEngine::IObject
typedef ParaEngine::weak_ptr< IObject >	WeakPtr_type
Static Public Member Functions inherited from ParaEngine::IAttributeFields
static HRESULT	GetAttributeClassID_s (IAttributeFields *cls, int *p1)
static HRESULT	GetAttributeClassName_s (IAttributeFields *cls, const char **p1)
static bool	OpenWithDefaultEditor (const char *sFilename, bool bWaitOnReturn=false)
	Open a given file with the default registered editor in the game engine. More...
Protected Member Functions inherited from ParaEngine::IAttributeFields
virtual CAttributeClass *	CreateAttributeClass ()
	initialize fields
virtual CDynamicAttributesSet *	GetDynamicAttributes (bool bCreateIfNotExist=false)
Protected Attributes inherited from ParaEngine::IObject
WeakPtr_type	m_weak_reference
Protected Attributes inherited from ParaEngine::CRefCounted
int	m_refcount

Detailed Description

manager multiple viewport

Member Function Documentation

CreateGetViewPort()

CViewport * ParaEngine::CViewportManager::CreateGetViewPort

(

int

nIndex = 1

)

add view port

Parameters

nIndex

usually 0 is the GUI root's viewport, 1 is the main 3d scene's viewport.

GetChildAttributeObject()

IAttributeFields * ParaEngine::CViewportManager::GetChildAttributeObject ( const std::string &  sName )

virtual

get attribute by child object.

used to iterate across the attribute field hierarchy.

Reimplemented from ParaEngine::IAttributeFields.

GetChildAttributeObjectCount()

int ParaEngine::CViewportManager::GetChildAttributeObjectCount ( int  nColumnIndex = 0 )

virtual

get the number of child objects (row count) in the given column.

please note different columns can have different row count.

Reimplemented from ParaEngine::IAttributeFields.

GetPointOnViewport()

void ParaEngine::CViewportManager::GetPointOnViewport	(	int &	x,
		int &	y,
		int *	pWidth,
		int *	pHeight
	)

Parameters

x,y	[in|out] a position on back buffer. If it is screen position, it should be multiplied by UI scaling.
pWidth,pHeight	the view port's size is returned.

Returns

true: if there is a point inside one of the viewports. otherwise false.

InstallFields()

int ParaEngine::CViewportManager::InstallFields ( CAttributeClass *  pClass, bool  bOverride  )

virtual

this class should be implemented if one wants to add new attribute.

This function is always called internally.

Reimplemented from ParaEngine::IAttributeFields.

UpdateLayout()

void ParaEngine::CViewportManager::UpdateLayout

(

)

just in case the size changed.

---

The documentation for this class was generated from the following files:

• Client/trunk/ParaEngineClient/3dengine/ViewportManager.h
• Client/trunk/ParaEngineClient/3dengine/ViewportManager.cpp