GuiBitmapCtrl
Engine/source/gui/controls/guiBitmapCtrl.h
Renders a bitmap.
Public Types
Parent
Protected Attributes
Name of the bitmap file.
Loaded texture.
bool
If true, bitmap tiles inside control. Otherwise stretches.
Protected Static Functions
const char *
getBitmapName(void * obj, const char * data)
bool
setBitmapName(void * object, const char * index, const char * data)
Public Functions
DECLARE_CATEGORY("Gui Images" )
DECLARE_DESCRIPTION("A <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> that displays <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> single, static image from <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">file.\n</a>" "The bitmap can either be tiled or stretched inside the control." )
Called after any property of the object is changed in the world editor.
bool
onWake()
Called when this object is asked to wake up returns true if it's actually awake at the end.
setBitmapHandle(GFXTexHandle handle, bool resize)
Public Static Functions
Detailed Description
Renders a bitmap.
Public Types
typedef GuiControl Parent
Protected Attributes
String mBitmapName
Name of the bitmap file.
If this is 'texhandle' the bitmap is not loaded from a file but rather set explicitly on the control.
ColorI mColor
Point2I mStartPoint
GFXTexHandle mTextureObject
Loaded texture.
bool mWrap
If true, bitmap tiles inside control. Otherwise stretches.
Protected Static Functions
getBitmapName(void * obj, const char * data)
setBitmapName(void * object, const char * index, const char * data)
Public Functions
GuiBitmapCtrl()
DECLARE_CATEGORY("Gui Images" )
DECLARE_CONOBJECT(GuiBitmapCtrl )
DECLARE_DESCRIPTION("A <a href="/coding/file/guieditctrl_8cpp/#guieditctrl_8cpp_1abb04e3738c4c5a96b3ade6fa47013a6c">control</a> that displays <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> single, static image from <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">file.\n</a>" "The bitmap can either be tiled or stretched inside the control." )
inspectPostApply()
Reimplemented from: SimObject
onRender(Point2I offset, const RectI & updateRect)
Reimplemented from: GuiControl
Reimplemented by: GuiFadeinBitmapCtrl, GuiIdleCamFadeBitmapCtrl, GuiMissionAreaCtrl, GuiCrossHairHud, GuiSpeedometerHud
onSleep()
Reimplemented from: GuiControl
Reimplemented by: GuiMissionAreaCtrl
onWake()
Reimplemented from: GuiControl
Reimplemented by: GuiFadeinBitmapCtrl, GuiIdleCamFadeBitmapCtrl, GuiMissionAreaCtrl
setBitmap(const char * name, bool resize)
setBitmapHandle(GFXTexHandle handle, bool resize)
setValue(S32 x, S32 y)
updateSizing()