CEGUI::FalagardSlider Class Reference

Slider class for the FalagardBase module. More...

Inheritance diagram for CEGUI::FalagardSlider:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::FalagardSlider:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 FalagardSlider (const String &type)
 type name for this widget.
bool isVertical () const
void setVertical (bool setting)
bool isReversedDirection () const
void setReversedDirection (bool setting)
void render ()
 Populate render cache.
void performChildWindowLayout ()
 Method called to perform extended laying out of the window's attached child windows.

Static Public Attributes

static const utf8 TypeName [] = "Falagard/Slider"

Protected Member Functions

void updateThumb (void)
 update the size and location of the thumb to properly represent the current state of the slider
float getValueFromThumb (void) const
 return value that best represents current slider value given the current location of the thumb.
float getAdjustDirectionFromPoint (const Point &pt) const
 Given window location pt, return a value indicating what change should be made to the slider.

Protected Attributes

bool d_vertical
 True if slider operates in vertical direction.
bool d_reversed
 true if slider operates in reversed direction to 'normal'.

Static Protected Attributes

static
FalagardSliderProperties::VerticalSlider 
d_verticalProperty
static
FalagardSliderProperties::ReversedDirection 
d_reversedProperty


Detailed Description

Slider class for the FalagardBase module.

This class requires LookNFeel to be assigned. The LookNFeel should provide the following:

States:

Named Areas:

Child Widgets: Thumb based widget with name suffix "__auto_thumb__"

Property initialiser definitions:


Constructor & Destructor Documentation

CEGUI::FalagardSlider::FalagardSlider ( const String type  ) 

type name for this widget.

Constructor

References CEGUI::WindowRenderer::registerProperty().


Member Function Documentation

float CEGUI::FalagardSlider::getAdjustDirectionFromPoint ( const Point pt  )  const [protected, virtual]

Given window location pt, return a value indicating what change should be made to the slider.

Parameters:
pt Point object describing a pixel position in window space.
Returns:
  • -1 to indicate slider should be moved to a lower setting.
  • 0 to indicate slider should not be moved.
  • +1 to indicate slider should be moved to a higher setting.

Implements CEGUI::SliderWindowRenderer.

References d_reversed, d_vertical, CEGUI::WindowRenderer::d_window, CEGUI::Vector2::d_x, CEGUI::Vector2::d_y, CEGUI::Slider::getThumb(), and CEGUI::Window::getUnclippedPixelRect().

float CEGUI::FalagardSlider::getValueFromThumb ( void   )  const [protected, virtual]

return value that best represents current slider value given the current location of the thumb.

Returns:
float value that, given the thumb widget position, best represents the current value for the slider.

Implements CEGUI::SliderWindowRenderer.

References CEGUI::Size::d_height, d_reversed, d_vertical, CEGUI::Size::d_width, CEGUI::WindowRenderer::d_window, CEGUI::NamedArea::getArea(), CEGUI::Window::getHeight(), CEGUI::WindowRenderer::getLookNFeel(), CEGUI::Slider::getMaxValue(), CEGUI::WidgetLookFeel::getNamedArea(), CEGUI::ComponentArea::getPixelRect(), CEGUI::Window::getPixelSize(), and CEGUI::Slider::getThumb().

void CEGUI::FalagardSlider::render (  )  [virtual]

Populate render cache.

This method must be implemented by all window renderers and should perform the rendering operations needed for this widget. Normally using the Falagard API...

Implements CEGUI::WindowRenderer.

References CEGUI::WindowRenderer::d_window, CEGUI::WindowRenderer::getLookNFeel(), CEGUI::WidgetLookFeel::getStateImagery(), CEGUI::Window::isDisabled(), and CEGUI::StateImagery::render().


Generated on Thu Nov 27 20:34:45 2008 for Crazy Eddies GUI System by  doxygen 1.5.7.1