torque Torque Game Engine Documentation
TGE Version 1.5.2

GuiBitmapCtrl Class Reference

#include <guiBitmapCtrl.h>

Inheritance diagram for GuiBitmapCtrl:

Inheritance graph
[legend]

Detailed Description

Renders a bitmap.


Public Member Functions

 DECLARE_CONOBJECT (GuiBitmapCtrl)
 GuiBitmapCtrl ()
bool onWake ()
 Called when this object is asked to wake up returns true if it's actually awake at the end.
void onSleep ()
 Called when this object is asked to sleep.
void inspectPostApply ()
 Called after any property of the object is changed in the world editor.
void setBitmap (const char *name, bool resize=false)
void setBitmap (const TextureHandle &handle, bool resize=false)
S32 getWidth () const
S32 getHeight () const
void onRender (Point2I offset, const RectI &updateRect)
 Called when this control is to render itself.
void setValue (S32 x, S32 y)

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Static Protected Member Functions

static bool setBitmapName (void *obj, const char *data)
static const char * getBitmapName (void *obj, const char *data)

Protected Attributes

StringTableEntry mBitmapName
TextureHandle mTextureHandle
Point2I startPoint
bool mWrap

Private Types

typedef GuiControl Parent


Member Typedef Documentation

typedef GuiControl GuiBitmapCtrl::Parent [private]

Reimplemented from GuiControl.

Reimplemented in MissionAreaEditor.


Constructor & Destructor Documentation

GuiBitmapCtrl::GuiBitmapCtrl (  ) 


Member Function Documentation

static bool GuiBitmapCtrl::setBitmapName ( void obj,
const char *  data 
) [static, protected]

static const char* GuiBitmapCtrl::getBitmapName ( void obj,
const char *  data 
) [static, protected]

GuiBitmapCtrl::DECLARE_CONOBJECT ( GuiBitmapCtrl   ) 

static void GuiBitmapCtrl::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:
addField(), addFieldV(), addDepricatedField(), addGroup(), endGroup()

Reimplemented from GuiControl.

Reimplemented in MissionAreaEditor.

bool GuiBitmapCtrl::onWake (  )  [virtual]

Called when this object is asked to wake up returns true if it's actually awake at the end.

Reimplemented from GuiControl.

Reimplemented in MissionAreaEditor.

void GuiBitmapCtrl::onSleep (  )  [virtual]

Called when this object is asked to sleep.

Reimplemented from GuiControl.

Reimplemented in MissionAreaEditor.

void GuiBitmapCtrl::inspectPostApply (  )  [virtual]

Called after any property of the object is changed in the world editor.

See also:
inspectPreApply

Reimplemented from GuiControl.

void GuiBitmapCtrl::setBitmap ( const char *  name,
bool  resize = false 
)

void GuiBitmapCtrl::setBitmap ( const TextureHandle &  handle,
bool  resize = false 
)

S32 GuiBitmapCtrl::getWidth (  )  const [inline]

S32 GuiBitmapCtrl::getHeight (  )  const [inline]

void GuiBitmapCtrl::onRender ( Point2I  offset,
const RectI updateRect 
) [virtual]

Called when this control is to render itself.

Parameters:
offset The location this control is to begin rendering
updateRect The screen area this control has drawing access to

Reimplemented from GuiControl.

Reimplemented in MissionAreaEditor.

void GuiBitmapCtrl::setValue ( S32  x,
S32  y 
)


Field Documentation

TextureHandle GuiBitmapCtrl::mTextureHandle [protected]

bool GuiBitmapCtrl::mWrap [protected]




All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen