The menu class defines the functionality of all menu objects such as pop-ups and pull-downs.

Inheritance:

Public Methods

	GmMenu () Standard constructor
virtual void	addTextItem (char* textMenuItem, WidgetIDType widgetId) Adds a text-based menu item to the menu.
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 void	mousePressEvent (GmEvent* event) Event processing function to process a mouse press event.
virtual void	widgetEvent (GmEvent::WidgetEventType* widgetEvent) Called whenever a widget event occurs on a widget that this widget event handler has registered with.
virtual	~GmMenu () Virtual destructor

Protected Fields

float	mGlMenuHeight The OpenGL height of the drop-down menu
float	mGlMenuWidth The OpenGL width of the drop-down menu
vector<GmInteractiveWidget*>	mListItems The menu list item objects that are contained in this menu

Protected Methods

virtual void	render2d (GmTypes::RenderOptionType renderOptions) Renders this menu to a 2D image buffer.
virtual void	render2dSelect (GmTypes::RenderOptionType renderOptions) Renders this menu 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 mouseReleaseEvent(GmEvent* event)

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

virtual void setBorderWidth(float borderWidth)

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

virtual void setWidth(float width)

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)

virtual void setBaseColor(GlmColor4* color)

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

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:

Inherited from GmWidgetEventHandler:

Documentation

The menu class defines the functionality of all menu objects such as pop-ups and pull-downs.

vector<GmInteractiveWidget*> mListItems

The menu list item objects that are contained in this menu

float mGlMenuWidth

The OpenGL width of the drop-down menu

float mGlMenuHeight

The OpenGL height of the drop-down menu

GmMenu()

Standard constructor

virtual ~GmMenu()

Virtual destructor

virtual void addTextItem(char* textMenuItem, WidgetIDType widgetId)

Adds a text-based menu item to the menu.

Parameters:

textMenuItem - the text to use for the menu item.
widgetTokenId - the token id pneumonic to use when identifying the widget. The widget token ID is necessary for the widget event handler to uniquely identify the menu item when responding to a widget event.

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 widgetEvent(GmEvent::WidgetEventType* widgetEvent)

Called whenever a widget event occurs on a widget that this widget event handler has registered with.

Parameters:

- widgetEvent the widget event, which includes all relevant widget data.

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.

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 render2d(GmTypes::RenderOptionType renderOptions)

Renders this menu to a 2D image buffer.

Parameters:

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

virtual void render2dSelect(GmTypes::RenderOptionType renderOptions)

Renders this menu to a selection buffer.

Parameters:

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

Direct child classes:

GmPopupMenu

Alphabetic index HTML hierarchy of classes or Java