The Nebula Device 3: Graphics::View Class Reference

The Nebula Device 3

Graphics::View Class Reference

#include <view.h>

Inheritance diagram for Graphics::View:

Core::RefCounted

Detailed Description

A client-side proxy of a InternalGraphics::InternalView in the Graphic subsystem.

(C) 2007 Radon Labs GmbH

Public Member Functions

 View ()
 constructor
virtual ~View ()
 destructor
bool IsValid () const
 return true if the View is valid
const Util::StringAtomGetName () const
 get name of view
const Core::RttiGetViewClass () const
 get the class-type of the server-side view object
const Util::StringAtomGetStageName () const
 get the name of the stage this view is attached to
const Resources::ResourceIdGetFrameShaderName () const
 get the name of the frame-shader this view will use for rendering
bool IsDefaultView () const
 check whether this is the default view
void SetCameraEntity (const Ptr< CameraEntity > &cameraEntity)
 set the camera entity this view should "look through"
const Ptr< CameraEntity > & GetCameraEntity () const
 get the view's current camera entity (may return invalid ptr if no camera is set)
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.