Crazy Eddie's GUI System 0.8.7
Loading...
Searching...
No Matches
CEGUI::Dimension Class Reference

Class representing some kind of dimension. More...

#include <Dimensions.h>

+ Inheritance diagram for CEGUI::Dimension:
+ Collaboration diagram for CEGUI::Dimension:

Public Member Functions

 Dimension (const Dimension &other)
 
Dimensionoperator= (const Dimension &other)
 
 Dimension (const BaseDim &dim, DimensionType type)
 Constructor.
 
const BaseDimgetBaseDimension () 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.
 
bool handleFontRenderSizeChange (Window &window, const Font *font) const
 perform any processing required due to the given font having changed.
 
- Public Member Functions inherited from CEGUI::AllocatedObject< Dimension >

Detailed Description

Class representing some kind of dimension.

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

Constructor & Destructor Documentation

◆ Dimension()

CEGUI::Dimension::Dimension ( const BaseDim & dim,
DimensionType type )

Constructor.

Parameters
dimobject based on subclass of BaseDim which holds the dimensional value.
typeDimensionType value indicating what dimension this object is to represent.

Member Function Documentation

◆ getBaseDimension()

const BaseDim & CEGUI::Dimension::getBaseDimension ( ) const

return the BaseDim object currently used as the value for this Dimension.

Returns
const reference to the BaseDim sub-class object which contains the value for this Dimension.

◆ getDimensionType()

DimensionType CEGUI::Dimension::getDimensionType ( ) const

Return a DimensionType value indicating what this Dimension represents.

Returns
one of the DimensionType enumerated values.

◆ setBaseDimension()

void CEGUI::Dimension::setBaseDimension ( const BaseDim & dim)

set the current value for this Dimension.

Parameters
dimobject based on a subclass of BaseDim which holds the dimensional value.

◆ setDimensionType()

void CEGUI::Dimension::setDimensionType ( DimensionType type)

Sets what this Dimension represents.

Parameters
typeone of the DimensionType enumerated values.

◆ writeXMLToStream()

void CEGUI::Dimension::writeXMLToStream ( XMLSerializer & xml_stream) const

Writes an xml representation of this Dimension to out_stream.

Parameters
xml_streamStream where xml data should be output.