GuiSliderCtrl Class Reference

#include <guiSliderCtrl.h>

Inheritance diagram for GuiSliderCtrl:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 DECLARE_CONOBJECT (GuiSliderCtrl)
 GuiSliderCtrl ()
bool onWake ()
 Called when this object is asked to wake up returns true if it's actually awake at the end.
void onMouseDown (const GuiEvent &event)
void onMouseDragged (const GuiEvent &event)
void onMouseUp (const GuiEvent &)
void onMouseLeave (const GuiEvent &)
void onMouseEnter (const GuiEvent &)
F32 getValue ()
void setScriptValue (const char *val)
 Sets the value of the variable bound to this object.
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 Types

 SliderLineLeft = 0
 SliderLineCenter
 SliderLineRight
 SliderButtonNormal
 SliderButtonHighlight
 NumBitmaps
enum  {
  SliderLineLeft = 0,
  SliderLineCenter,
  SliderLineRight,
  SliderButtonNormal,
  SliderButtonHighlight,
  NumBitmaps
}

Protected Member Functions

void updateThumb (F32 value, bool snap=true, bool onWake=false)

Protected Attributes

Point2F mRange
U32 mTicks
F32 mValue
RectI mThumb
Point2I mThumbSize
S32 mShiftPoint
S32 mShiftExtent
bool mDisplayValue
bool mDepressed
bool mMouseOver
bool mHasTexture
RectImBitmapBounds

Private Types

typedef GuiControl Parent

Member Typedef Documentation

typedef GuiControl GuiSliderCtrl::Parent [private]

Reimplemented from GuiControl.


Member Enumeration Documentation

anonymous enum [protected]

Enumerator:
SliderLineLeft 
SliderLineCenter 
SliderLineRight 
SliderButtonNormal 
SliderButtonHighlight 
NumBitmaps 


Constructor & Destructor Documentation

GuiSliderCtrl::GuiSliderCtrl (  ) 


Member Function Documentation

void GuiSliderCtrl::updateThumb ( F32  value,
bool  snap = true,
bool  onWake = false 
) [protected]

GuiSliderCtrl::DECLARE_CONOBJECT ( GuiSliderCtrl   ) 

static void GuiSliderCtrl::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

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

Reimplemented from GuiControl.

bool GuiSliderCtrl::onWake (  )  [virtual]

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

Reimplemented from GuiControl.

void GuiSliderCtrl::onMouseDown ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

void GuiSliderCtrl::onMouseDragged ( const GuiEvent event  )  [virtual]

Reimplemented from GuiControl.

void GuiSliderCtrl::onMouseUp ( const GuiEvent  )  [virtual]

Reimplemented from GuiControl.

void GuiSliderCtrl::onMouseLeave ( const GuiEvent  )  [virtual]

Reimplemented from GuiControl.

void GuiSliderCtrl::onMouseEnter ( const GuiEvent  )  [virtual]

Reimplemented from GuiControl.

F32 GuiSliderCtrl::getValue (  )  [inline]

void GuiSliderCtrl::setScriptValue ( const char *  val  )  [virtual]

Sets the value of the variable bound to this object.

Reimplemented from GuiControl.

void GuiSliderCtrl::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.


Member Data Documentation