#include <OpenGUI_Face.h>
Faces are used to join several previously defined Imagery together in an HTML table-like fashion, providing minimum widths and heights, selective growth, and column/row spanning. They are drawn as a single unit, automatically scaling as necessary to fit the desired coverage area, while doing their best to scale only in designated directions.
Public Types | |
| FM_UNITS = 0 | |
| The size is in Screen units. | |
| FM_PIXELS = 1 | |
| The size is in pixels of the native display. | |
| enum | FaceMetric { FM_UNITS = 0, FM_PIXELS = 1 } |
| Used to dictate the metric of measurement used in Face related objects. More... | |
Public Member Functions | |
| const std::string & | getName () |
| Returns the name of this Face. | |
| void | getColumnWidths (float totalWidth, FaceDimArray &columnArray_out) |
fills the columnArray_out with column widths to fit the totalWidth | |
| void | getRowHeights (float totalHeight, FaceDimArray &rowArray_out) |
fills the rowArray_out with row heights to fit the totalHeight | |
| const SliceList & | getSlices () |
| returns a reference to the list of Slices used in this Face | |
Static Public Member Functions | |
| static FacePtr | Create (const std::string &faceName, const FaceDef &faceDefinition) |
| Takes a FaceDef (Face definition) and generates a Face which is returned in a reference counted pointer. | |
Public Attributes | |
| const FaceMetric | Metric |
| Indicates the metric that should be used when rendering this Face. | |
| void OpenGUI::Face::getColumnWidths | ( | float | totalWidth, | |
| FaceDimArray & | columnArray_out | |||
| ) |
fills the columnArray_out with column widths to fit the totalWidth
| const std::string& OpenGUI::Face::getName | ( | ) | [inline] |
Returns the name of this Face.
| void OpenGUI::Face::getRowHeights | ( | float | totalHeight, | |
| FaceDimArray & | rowArray_out | |||
| ) |
fills the rowArray_out with row heights to fit the totalHeight
| const SliceList & OpenGUI::Face::getSlices | ( | ) |
returns a reference to the list of Slices used in this Face
Indicates the metric that should be used when rendering this Face.