The Nebula Device 3: AsyncGraphics::GraphicsServerProxy Class Reference

The Nebula Device 3

AsyncGraphics::GraphicsServerProxy Class Reference

#include <graphicsserverproxy.h>

Inheritance diagram for AsyncGraphics::GraphicsServerProxy:

Core::RefCounted


Detailed Description

Client-side proxy of the GraphicsServer. Used to create and update StageProxies and ViewProxies.

(C) 2007 Radon Labs GmbH

Public Member Functions

 GraphicsServerProxy ()
 constructor
virtual ~GraphicsServerProxy ()
 destructor
void Open ()
 open the graphics server proxy
void Close ()
 close the graphics server proxy
bool IsOpen () const
 return true if graphics server is open
void OnFrame ()
 perform per-frame updates
Ptr< StageProxy > CreateStageProxy (const Util::StringAtom &name, const Core::Rtti &stageBuilderClass, const Attr::AttributeContainer &stageBuilderAttrs)
 create a stage proxy
void DiscardStageProxy (const Ptr< StageProxy > &stageProxy)
 discard a stage proxy object
void DiscardAllStageProxies ()
 discard all stage proxy objects
bool HasStageProxy (const Util::StringAtom &name) const
 return true if a stage proxy exists by name
const Ptr< StageProxy > & GetStageProxyByName (const Util::StringAtom &name) const
 lookup a stage proxy by name
const Util::Array
< Ptr< StageProxy > > & 
GetStageProxies () const
 get all stage proxies
Ptr< ViewProxyCreateViewProxy (const Core::Rtti &viewClass, const Util::StringAtom &viewName, const Util::StringAtom &stageName, const Resources::ResourceId &frameShaderName, bool isDefaultView=false)
 create a view proxy
void DiscardViewProxy (const Ptr< ViewProxy > &view)
 discard a view proxy
void DiscardAllViewProxies ()
 discard all view proxies
bool HasViewProxy (const Util::StringAtom &name) const
 return true if a view proxy exists by name
const Ptr< ViewProxy > & GetViewProxyByName (const Util::StringAtom &name) const
 lookup a view proxy by name
const Util::Array
< Ptr< ViewProxy > > & 
GetViewProxies () const
 get all view proxies
const Ptr< ViewProxy > & GetDefaultViewProxy () const
 get the default view proxy
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Member Function Documentation

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.