Torque Game Engine Documentation
TGE Version 1.5.2

GuiBitmapButtonCtrl Class Reference

#include <guiBitmapButtonCtrl.h>

Inheritance diagram for GuiBitmapButtonCtrl:

[legend]

Detailed Description

------------------------------------- Bitmap Button Contrl Set 'bitmap' comsole field to base name of bitmaps to use.

This control will append '_n' for normal append '_h' for hilighted append '_d' for depressed

if bitmap cannot be found it will use the default bitmap to render.

if the extent is set to (0,0) in the gui editor and apply hit, this control will set it's extent to be exactly the size of the normal bitmap (if present)

Public Member Functions

DECLARE_CONOBJECT (GuiBitmapButtonCtrl)

GuiBitmapButtonCtrl ()

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)

void onRender (Point2I offset, const RectI &updateRect)

Called when this control is to render itself.

Static Public Member Functions

static void initPersistFields ()

Register dynamic fields in a subclass of ConsoleObject.

Protected Member Functions

void renderButton (TextureHandle &texture, Point2I &offset, const RectI &updateRect)

Protected Attributes

StringTableEntry mBitmapName

TextureHandle mTextureNormal

TextureHandle mTextureHilight

TextureHandle mTextureDepressed

TextureHandle mTextureInactive

Private Types

typedef GuiButtonCtrl Parent