class GmRangeWidget

A class to handle floating point bounded ranges

Inheritance:

Public Methods
Protected Fields

Inherited from GmInteractiveWidget:

Public Fields
GmFocusEventHandler* focusEventHandler
GmKeyEventHandler* keyEventHandler
GmAnimation* mFocusGainAnim
GmAnimation* mFocusLoseAnim
GmTypes::FocusType mFocusState
unsigned int mFocusTimestamp
GmAnimation* mKeyPressAnim
GmAnimation* mKeyReleaseAnim
GmAnimation* mMouseExitAnim
GmAnimation* mMouseOverAnim
GmAnimation* mMousePressAnim
GmAnimation* mMouseReleaseAnim
WidgetIDType mWidgetId
GmToolTip* mWidgetToolTip
GmMouseEventHandler* mouseEventHandler
GmUserEventHandler* userEventHandler
GmWidgetEventHandler* widgetEventHandler

Public Methods
virtual void focusGainEvent(GmEvent* event)
virtual void focusLoseEvent(GmEvent* event)
virtual WidgetIDType getWidgetId()
virtual void keyPressEvent(GmEvent* event)
virtual void keyReleaseEvent(GmEvent* event)
virtual void mouseDragEvent(GmEvent* event)
virtual void mouseMoveEvent(GmEvent* event)
virtual void mousePressEvent(GmEvent* event)
virtual void mouseReleaseEvent(GmEvent* event)
virtual void setFocusEventHandler(GmFocusEventHandler* focusHandler, WidgetIDType widgetId)
virtual void setKeyEventHandler(GmKeyEventHandler* keyHandler, WidgetIDType widgetId)
virtual void setMouseEventHandler(GmMouseEventHandler* mouseHandler, WidgetIDType widgetId)
virtual void setToolTip(GmToolTip* tooltip)
virtual void setUserEventHandler(GmUserEventHandler* userHandler, WidgetIDType widgetId)
virtual void setWidgetEventHandler(GmWidgetEventHandler* widgetHandler, WidgetIDType widgetId)
virtual void userEvent(GmEvent* event)
virtual void wheelMoveEvent(GmEvent* event)

Protected Methods
virtual void render2dToolTip(GmTypes::RenderOptionType renderOptions)

Inherited from GmAnimatedWidget:

Public Methods
virtual void animationFinished(GmTypes::AnimationType animationType)
virtual void applyAnimationTransforms()
virtual void setEventAnimation(GmTypes::AnimationType animType, GmAnimation* animation)

Protected Fields
GmAnimation* mAppearAnimation
GmTypes::AnimationType mCurrentAnimation
GmAnimation* mIdleAnimation
GmAnimation* mVanishAnimation

Inherited from GmDrawable:

Public Methods
virtual void applyLayout(float minX, float minY, float minZ, float maxX, float maxY, float maxZ)
virtual GlmColor4* getBaseColor()
virtual GmTypes::CoordinateType getCoordType()
virtual float getDepth()
virtual float getGlDepth()
virtual void getGlExtents(float& width, float& height)
virtual float getGlHeight()
virtual GlmPoint3* getGlPosition()
virtual float getGlWidth()
virtual float getHeight()
virtual void getMinimumGeometry(float& width, float& height, float& depth)
virtual GlmPoint3* getPosition()
virtual bool getVisible()
virtual float getWidth()
virtual void render(GmTypes::RenderOptionType renderOptions)
virtual void setAbsoluteGeometry(float x, float y, float z, float width, float height, float depth)
virtual void setBaseColor(GlmColor4* color)
virtual void setBaseColor(float r, float g, float b, float a)
virtual void setCoordType(GmTypes::CoordinateType coordType)
virtual void setDepth(float depth)
virtual void setHeight(float height)
virtual void setPosition(GlmPoint3* point)
virtual void setPosition(float x, float y, float z)
virtual void setRelativeGeometry(float x, float y, float width, float height)
virtual void setRelativeGeometry(float x, float y, float z, float width, float height, float depth)
virtual void setVisible(bool visible)
virtual void setWidth(float width)

Protected Fields
GlmColor4 mBaseColor
GmTypes::CoordinateType mCoordType
float mDepth
bool mDisplayListGenerate
int mDisplayListId
float mGlDepth
float mGlHeight
GlmPoint3 mGlPosition
float mGlWidth
float mHeight
GlmPoint3 mPosition
bool mVisible
float mWidth

Protected Methods
virtual bool getDisplayListGenerate()
virtual int getDisplayListId()
virtual void render2d(GmTypes::RenderOptionType renderOptions)
virtual void render2dSelect(GmTypes::RenderOptionType renderOptions)
virtual void setDisplayListGenerate(bool generate)
virtual void setDisplayListId(int id)

Inherited from GmObject:

Public Methods
unsigned short getObjectId()

Protected Fields
The object ID is used to uniquely identify each GmObject unsigned short mObjectId

Inherited from GmAnimationEventHandler:

Documentation

A class to handle floating point bounded ranges

float mMinimumValue

The floor of the range

float mMaximumValue

The ceiling of the range

float mCurrentValue

The currently set value of the range

float mLineStep

The step size of a line

float mPageStep

The step size of a page

GmRangeWidget()

Standard constructor

virtual ~GmRangeWidget()

Virtual destructor

virtual void setMinimumValue(float minValue)

Set the floor value for the range.


Parameters:: minValue - the new minimum

virtual float getMinimumValue()

Get the floor value for the range.


Returns:: the minimum

virtual void setMaximumValue(float maxValue)

Set the ceiling value for the range.


Parameters:: maxValue - the new maximum

virtual float getMaximumValue()

Get the ceiling value for the range.


Returns:: the maximum

virtual void setCurrentValue(float currentValue)

Set the currently set value for the range.


Parameters:: currentValue - the new current value

virtual float getCurrentValue()

Get the currently set value for the range.


Returns:: the current value

virtual float getCurrentPercentage()

Get the current percentage of the range that is occupied by the space between minimum and current values.


Returns:: the current percentage, value is between 0.0 and 1.0

virtual void setCurrentPercentage(float currentPercentage)

Set the currently set value for the range via a percentage value.


Parameters:: currentPercentage - the new current percentage value

virtual void setRange(float minValue, float maxValue)

Simultaneously set the floor and ceiling values for the range.


Parameters:: minValue - the new minimum
maxValue - the new maximum

virtual void setLineStep(float lineStep)

Set the step size of a line.


Parameters:: lineStep - the new line step size

virtual float getLineStep()

Get the step size of a line.


Returns:: the line step size

virtual void setPageStep(float pageStep)

Set the step size of a page.


Parameters:: pageStep - the new page step size

virtual float getPageStep()

Get the step size of a page.


Returns:: the page step size

virtual void setSteps(float lineStep, float pageStep)

Simultaneously set the line and page step sizes for the range.


Parameters:: lineStep - the new line step size
pageStep - the new page step size

virtual void addPage()

Increment the current range value by a page. (If the result is in the minimum/maximum bounds.)

virtual void subtractPage()

Decrement the current range value by a page. (If the result is in the minimum/maximum bounds.)

virtual void addLine()

Increment the current range value by a line. (If the result is in the minimum/maximum bounds.)

virtual void subtractLine()

Decrement the current range value by a line. (If the result is in the minimum/maximum bounds.)

Direct child classes:: GmSlider
GmScrollbar
GmMeter

Alphabetic index HTML hierarchy of classes or Java

This page was generated with the help of DOC++.

	GmRangeWidget () Standard constructor
virtual void	addLine () Increment the current range value by a line.
virtual void	addPage () Increment the current range value by a page.
virtual float	getCurrentPercentage () Get the current percentage of the range that is occupied by the space between minimum and current values.
virtual float	getCurrentValue () Get the currently set value for the range.
virtual float	getLineStep () Get the step size of a line.
virtual float	getMaximumValue () Get the ceiling value for the range.
virtual float	getMinimumValue () Get the floor value for the range.
virtual float	getPageStep () Get the step size of a page.
virtual void	setCurrentPercentage (float currentPercentage) Set the currently set value for the range via a percentage value.
virtual void	setCurrentValue (float currentValue) Set the currently set value for the range.
virtual void	setLineStep (float lineStep) Set the step size of a line.
virtual void	setMaximumValue (float maxValue) Set the ceiling value for the range.
virtual void	setMinimumValue (float minValue) Set the floor value for the range.
virtual void	setPageStep (float pageStep) Set the step size of a page.
virtual void	setRange (float minValue, float maxValue) Simultaneously set the floor and ceiling values for the range.
virtual void	setSteps (float lineStep, float pageStep) Simultaneously set the line and page step sizes for the range.
virtual void	subtractLine () Decrement the current range value by a line.
virtual void	subtractPage () Decrement the current range value by a page.
virtual	~GmRangeWidget () Virtual destructor

float	mCurrentValue The currently set value of the range
float	mLineStep The step size of a line
float	mMaximumValue The ceiling of the range
float	mMinimumValue The floor of the range
float	mPageStep The step size of a page