GuiComponent Class Reference

#include <GuiComponent.h>

Inheritance diagram for GuiComponent:

List of all members.

Public Types
enum	State { HIDDEN, ENABLED, DISABLED, UPDATING }
Public Member Functions
	GuiComponent (int left, int right, int bottom, int top, int x, int y, int width, int height)
void	moveTo (int newX, int newY)
bool	hit (int x, int y)
void	enable ()
void	disable ()
void	hide ()
void	updating ()
bool	isEnabled ()
bool	isUpdating ()
bool	isHidden ()
bool	isDisabled ()
Public Attributes
State	state

---

Detailed Description

This class defines a genric GUI component. A GuiComponent is a little more than a Orthographic camera. It defines serveral states, wich determine what is getting rendered and knows its bounding box.

Version:

12-05-2005

---

Member Enumeration Documentation

enum GuiComponent::State

This enumeration holds the possible states of the self made GUI components (e.g. the Histogram, the Colorselector). The States can be set without restrictions. HIDDEN In this state, the comonent is not rendered and does not react to user interactions ENABLED In this state, the component gets rendered and respond to user interaction DISABLED In this state, the component gets rendered but does not respond to user interaction UPDATING In this state the component is updated. This state is needed to prevent refresh of the component as long as it is busy. Enumeration values: HIDDEN  ENABLED  DISABLED  UPDATING

---

Constructor & Destructor Documentation

GuiComponent::GuiComponent (  int  left, int  right, int  bottom, int  top, int  x, int  y, int  width, int  height )

Create an orthographic projection space and a viewport using the camera class. So each component exists into its own space.

---

Member Function Documentation

void GuiComponent::disable (   )

Set the state to DISABLED

void GuiComponent::enable (   )

Set the state to ENABLED

void GuiComponent::hide (   )

Set the state to HIDDEN

bool GuiComponent::hit (  int  x, int  y )

Find out if the component had been picked by the mouse. This will always return false, if the state is not equal to ENABLED

bool GuiComponent::isDisabled (   )

Return if the current state is DISABLED

bool GuiComponent::isEnabled (   )

Return if the current state is ENABLED

bool GuiComponent::isHidden (   )

Return if the current state is HIDDEN

bool GuiComponent::isUpdating (   )

Return if the current state is BUSY

void GuiComponent::moveTo (  int  newX, int  newY )

Update the lower left position of the components viewport.

void GuiComponent::updating (   )

Set the state to BUSY

---

Member Data Documentation

State GuiComponent::state

The current state of the component.

---

The documentation for this class was generated from the following files:

• D:/Study/9.Semester/Visualisierung/Lu/2/adam_stefan_vis_lu2/src/GuiComponent.h
• D:/Study/9.Semester/Visualisierung/Lu/2/adam_stefan_vis_lu2/src/GuiComponent.cpp

---