Class that holds details of colours for the four corners of a rectangle.
More...
List of all members.
Detailed Description
Class that holds details of colours for the four corners of a rectangle.
Member Function Documentation
colour CEGUI::ColourRect::getColourAtPoint |
( |
float |
x, |
|
|
float |
y | |
|
) |
| | const |
Get the colour at a point in the rectangle.
- Parameters:
-
| x | The x coordinate of the point |
| y | The y coordinate of the point |
- Returns:
- The colour at the specified point.
ColourRect CEGUI::ColourRect::getSubRectangle |
( |
float |
left, |
|
|
float |
right, |
|
|
float |
top, |
|
|
float |
bottom | |
|
) |
| | const |
Gets a portion of this ColourRect as a subset ColourRect.
- Parameters:
-
| left | The left side of this subrectangle (in the range of 0-1 float) |
| right | The right side of this subrectangle (in the range of 0-1 float) |
| top | The top side of this subrectangle (in the range of 0-1 float) |
| bottom | The bottom side of this subrectangle (in the range of 0-1 float) |
- Returns:
- A ColourRect from the specified range
bool CEGUI::ColourRect::isMonochromatic |
( |
|
) |
const |
Determinate the ColourRect is monochromatic or variegated.
- Returns:
- True if all four corners of the ColourRect has same colour, false otherwise.
void CEGUI::ColourRect::modulateAlpha |
( |
float |
alpha |
) |
|
Module the alpha components of each corner's colour by a constant.
- Parameters:
-
| alpha | The constant factor to modulate all alpha colour components by. |
void CEGUI::ColourRect::setAlpha |
( |
float |
alpha |
) |
|
Set the alpha value to use for all four corners of the ColourRect.
- Parameters:
-
| alpha | Alpha value to use. |
- Returns:
- Nothing.
void CEGUI::ColourRect::setBottomAlpha |
( |
float |
alpha |
) |
|
Set the alpha value to use for the bottom edge of the ColourRect.
- Parameters:
-
| alpha | Alpha value to use. |
- Returns:
- Nothing.
void CEGUI::ColourRect::setColours |
( |
const colour & |
col |
) |
|
Set the colour of all four corners simultaneously.
- Parameters:
-
| col | colour that is to be set for all four corners of the ColourRect; |
void CEGUI::ColourRect::setLeftAlpha |
( |
float |
alpha |
) |
|
Set the alpha value to use for the left edge of the ColourRect.
- Parameters:
-
| alpha | Alpha value to use. |
- Returns:
- Nothing.
void CEGUI::ColourRect::setRightAlpha |
( |
float |
alpha |
) |
|
Set the alpha value to use for the right edge of the ColourRect.
- Parameters:
-
| alpha | Alpha value to use. |
- Returns:
- Nothing.
void CEGUI::ColourRect::setTopAlpha |
( |
float |
alpha |
) |
|
Set the alpha value to use for the top edge of the ColourRect.
- Parameters:
-
| alpha | Alpha value to use. |
- Returns:
- Nothing.