A checkbox class.

Inheritance:

Public Methods

	GmCheckBox () Standard constructor
virtual void	applyLayout (float minX, float minY, float minZ, float maxX, float maxY, float maxZ) Repositions and resizes this component based on parameters passed into the method.
virtual bool	getSelected () Return the selected state of this checkbox.
virtual void	mousePressEvent (GmEvent* event) Event processing function to process a mouse press event.
virtual void	mouseReleaseEvent (GmEvent* event) Event processing function to process a mouse release event.
virtual void	setAbsoluteGeometry (float x, float y, float z, float width, float height, float depth) Sets the absolute geometry to use for this drawable object.
virtual void	setBaseColor (GlmColor4* color) Sets the base color of the button.
virtual void	setBaseColor (float r, float g, float b, float a) Sets the base color of the button.
virtual void	setCheckColor (float r, float g, float b, float a) Sets the check color of the checkbox.
virtual void	setDepth (float depth) Sets the depth of the drawable object in units.
virtual void	setHeight (float height) Sets the height of the drawable object in units.
virtual void	setPosition (GlmPoint3* point) Sets the position of the drawable.
virtual void	setPosition (float x, float y, float z) Sets the position of the drawable.
virtual void	setRelativeGeometry (float x, float y, float z, float width, float height, float depth) Sets the relative geometry to use for this drawable object.
virtual void	setRelativeGeometry (float x, float y, float width, float height) Sets the relative geometry to use for this drawable object.
virtual void	setSelected (bool selected) Set the selected state of this checkbox.
virtual void	setWidth (float width) Sets the width of the drawable object in units.
virtual	~GmCheckBox () Standard destructor

Protected Fields

GlmColor4	mCheckColor The color of the check inside the checkbox
bool	mSelected The state, selected or unselected, of the checkbox

Protected Methods

virtual void	render2d (GmTypes::RenderOptionType renderOptions) Renders this button to a 2D image buffer.
virtual void	render2dSelect (GmTypes::RenderOptionType renderOptions) Renders this button to a selection buffer.

Inherited from GmButton:

Public Methods

virtual float getBorderWidth()

virtual GmTypes::ButtonStateType getState()

virtual char* getText()

GlmColor4* getTextColor()

void getTextJustification(GmTypes::JustificationType& horizontal, GmTypes::JustificationType& vertical)

float getTextPointSize()

virtual void setBorderWidth(float borderWidth)

virtual void setCoordType(GmTypes::CoordinateType coordType)

virtual void setState(GmTypes::ButtonStateType state)

virtual void setText(char* text)

void setTextColor(float r, float g, float b, float a)

void setTextColor(GlmColor4* color)

void setTextJustification(GmTypes::JustificationType horizontal, GmTypes::JustificationType vertical)

void setTextPointSize(float pointSize)

virtual void setVisible(bool visible)

Protected Fields

float mBorderWidth

GmTypes::ButtonStateType mState

GmTextWidget* mTextWidget

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 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 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)

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 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 checkbox class. Checkboxes represent a toggleable state.

bool mSelected

The state, selected or unselected, of the checkbox

GlmColor4 mCheckColor

The color of the check inside the checkbox

GmCheckBox()

Standard constructor

virtual ~GmCheckBox()

Standard destructor

virtual void setCheckColor(float r, float g, float b, float a)

Sets the check color of the checkbox. The check is the item that is displayed inside the checkbox to denote that the user has clicked on the checkbox.

Parameters:

r - the red value
g - the green value
b - the blue value
a - the alpha value

virtual void mousePressEvent(GmEvent* event)

Event processing function to process a mouse press event.

Parameters:

event - the mouse press event for this object to process

virtual void mouseReleaseEvent(GmEvent* event)

Event processing function to process a mouse release event.

Parameters:

event - the mouse release event for this object to process

virtual bool getSelected()

Return the selected state of this checkbox.

Returns:

the selected state of this checkbox.

virtual void setPosition(float x, float y, float z)

Sets the position of the drawable. The top-left most pixel of the rendered image will be located at the given point if the coordinate type is CT_ABSOLUTE. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.

Parameters:

- x the X position of the drawable object
- y the Y position of the drawable object
z - the Z position of the drawable object

virtual void setPosition(GlmPoint3* point)

Sets the position of the drawable. The top-left most pixel of the rendered image will be located at the given point if the coordinate type is CT_ABSOLUTE. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.

Parameters:

point - the point to use as the top-left rendering location of the drawable.

virtual void setBaseColor(float r, float g, float b, float a)

Sets the base color of the button. The base color is the color that will be at the center of the button. The top left and bottom right of the button will be a bit lighter and a bit darker respectively.

Parameters:

r - the red value of the button color
g - the green value of the button color
b - the blue value of the button color
a - the alpha value of the button color

virtual void setBaseColor(GlmColor4* color)

Sets the base color of the button. The base color is the color that will be at the center of the button. The top left and bottom right of the button will be a bit lighter and a bit darker respectively.

Parameters:

color - the base color of the button

virtual void setWidth(float width)

Sets the width of the drawable object in units. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.

Parameters:

width - the width to set the drawable object's width to.

virtual void setHeight(float height)

Sets the height of the drawable object in units. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.

Parameters:

height - the height to set the drawable object's height to.

virtual void setDepth(float depth)

Sets the depth of the drawable object in units. If the coordinate type for this drawable is CT_RELATIVE, the value should be from 0%-100% (0.0 to 1.0) and will be a relative to the drawable's parent container.

Parameters:

depth - the depth to set the drawable object's depth to.

virtual void setAbsoluteGeometry(float x, float y, float z, float width, float height, float depth)

Sets the absolute geometry to use for this drawable object. This method is provided merely for convenience.

Parameters:

- x the absolute X value for this drawable
- y the absolute Y value for this drawable
z - the absolute Z value for this drawable
width - the width of this drawable
height - the height of this drawable
depth - the depth of this drawable

virtual void setRelativeGeometry(float x, float y, float width, float height)

Sets the relative geometry to use for this drawable object. This method is provided merely for convenience. This method is intended to be used with 2d layouts.

Parameters:

- x the absolute X value for this drawable
- y the absolute Y value for this drawable
width - the width of this drawable
height - the height of this drawable

virtual void setRelativeGeometry(float x, float y, float z, float width, float height, float depth)

Sets the relative geometry to use for this drawable object. This method is provided merely for convenience.

Parameters:

- x the absolute X value for this drawable
- y the absolute Y value for this drawable
z - the absolute Z value for this drawable
width - the width of this drawable
height - the height of this drawable
depth - the depth of this drawable

virtual void applyLayout(float minX, float minY, float minZ, float maxX, float maxY, float maxZ)

Repositions and resizes this component based on parameters passed into the method. These parameters are usually passed in by the parent class or parent layout manager.

Parameters:

minX - the starting X position of the constraint volume
minY - the starting Y position of the constraint volume
minZ - the starting Z position of the constraint volume
maxX - the ending X position of the constraint volume
maxY - the ending X position of the constraint volume
maxZ - the ending Z position of the constraint volume

virtual void setSelected(bool selected)

Set the selected state of this checkbox.

Parameters:

selected - the new selected state

virtual void render2d(GmTypes::RenderOptionType renderOptions)

Renders this button to a 2D image buffer.

Parameters:

renderOptions - the render options to use when rendering the button.

virtual void render2dSelect(GmTypes::RenderOptionType renderOptions)

Renders this button to a selection buffer.

Parameters:

renderOptions - the render options to use when rendering the button.

Direct child classes:

GmRadioButton

Alphabetic index HTML hierarchy of classes or Java