The Nebula Device 3: Base::MouseRenderDeviceBase Class Reference

The Nebula Device 3

Base::MouseRenderDeviceBase Class Reference

#include <mouserenderdevicebase.h>

Inheritance diagram for Base::MouseRenderDeviceBase:

Core::RefCounted CoreGraphics::MouseRenderDevice

Detailed Description

Renders one (or more, depending on platform) mouse cursors.

(C) 2009 Radon Labs GmbH

Public Member Functions

 MouseRenderDeviceBase ()
 constructor
virtual ~MouseRenderDeviceBase ()
 destructor
void Setup ()
 open the mouse renderer
void Discard ()
 close the mouse renderer
bool IsValid () const
 return true if the mouse renderer is valid
void PreloadTextures (const Util::Array< Resources::ResourceId > &texResIds)
 load mouse pointer textures
void UpdatePointers (const Util::Array< CoreGraphics::MousePointer > &pointers)
 update the mouse renderer
void RenderPointers ()
 render mouse pointer(s)
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

void Base::MouseRenderDeviceBase::PreloadTextures ( const Util::Array< Resources::ResourceId > &  texResIds  ) 

load mouse pointer textures

This method must be called to preload texture used by the mouse renderer. The method may be called at any time (also several times).

void Base::MouseRenderDeviceBase::UpdatePointers ( const Util::Array< CoreGraphics::MousePointer > &  pointers  ) 

update the mouse renderer

Update mouse pointers for rendering in the current frame. On some platforms, more then one mouse pointer exists, so this method takes an array of MousePointer objects. Calling this method will replace the previous array of MousePoiners.

void Base::MouseRenderDeviceBase::RenderPointers (  ) 

render mouse pointer(s)

This method should render the pointers describes by the last call to UpdatePointers(). Override this method in a derived platform- specific class.

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.