
Public Member Functions | |
| Dimension () | |
| Constructor. | |
| ~Dimension () | |
| Destructor. | |
| Dimension (const BaseDim &dim, DimensionType type) | |
| Constructor. | |
| Dimension (const Dimension &other) | |
| Copy constructor. | |
| Dimension & | operator= (const Dimension &other) |
| Assignment operator. | |
| const BaseDim & | getBaseDimension () const |
| return the BaseDim object currently used as the value for this Dimension. | |
| void | setBaseDimension (const BaseDim &dim) |
| set the current value for this Dimension. | |
| DimensionType | getDimensionType () const |
| Return a DimensionType value indicating what this Dimension represents. | |
| void | setDimensionType (DimensionType type) |
| Sets what this Dimension represents. | |
| void | writeXMLToStream (XMLSerializer &xml_stream) const |
| Writes an xml representation of this Dimension to out_stream. | |
The key thing to understand about Dimension is that it contains not just a dimensional value, but also a record of what the dimension value is supposed to represent. (e.g. a co-ordinate on the x axis, or the height of something).
| CEGUI::Dimension::Dimension | ( | const BaseDim & | dim, | |
| DimensionType | type | |||
| ) |
Constructor.
| dim | object based on subclass of BaseDim which holds the dimensional value. | |
| type | DimensionType value indicating what dimension this object is to represent. |
References CEGUI::BaseDim::clone().
| const BaseDim & CEGUI::Dimension::getBaseDimension | ( | ) | const |
return the BaseDim object currently used as the value for this Dimension.
Referenced by CEGUI::ComponentArea::getPixelRect().
| DimensionType CEGUI::Dimension::getDimensionType | ( | ) | const |
Return a DimensionType value indicating what this Dimension represents.
Referenced by CEGUI::ComponentArea::getPixelRect().
| void CEGUI::Dimension::setBaseDimension | ( | const BaseDim & | dim | ) |
set the current value for this Dimension.
| dim | object based on a subclass of BaseDim which holds the dimensional value. |
References CEGUI::BaseDim::clone().
| void CEGUI::Dimension::setDimensionType | ( | DimensionType | type | ) |
Sets what this Dimension represents.
| type | one of the DimensionType enumerated values. |
| void CEGUI::Dimension::writeXMLToStream | ( | XMLSerializer & | xml_stream | ) | const |
Writes an xml representation of this Dimension to out_stream.
| xml_stream | Stream where xml data should be output. |
References CEGUI::XMLSerializer::attribute(), CEGUI::XMLSerializer::closeTag(), CEGUI::XMLSerializer::openTag(), and CEGUI::BaseDim::writeXMLToStream().
Referenced by CEGUI::ComponentArea::writeXMLToStream().
1.5.7.1