Crazy Eddie's GUI System  0.8.7
CEGUI::UnifiedDim Class Reference

Dimension type that represents an Unified dimension. Implements BaseDim interface. More...

+ Inheritance diagram for CEGUI::UnifiedDim:
+ Collaboration diagram for CEGUI::UnifiedDim:

Public Member Functions

 UnifiedDim (const UDim &value, DimensionType dim)
 Constructor. More...
 
const UDimgetBaseValue () const
 Get the current value of the UnifiedDim.
 
void setBaseValue (const UDim &val)
 Set the current value of the UnifiedDim.
 
DimensionType getSourceDimension () const
 Gets the source dimension type for this WidgetDim. More...
 
void setSourceDimension (DimensionType dim)
 Sets the source dimension type for this WidgetDim. More...
 
float getValue (const Window &wnd) const
 Return a value that represents this dimension as absolute pixels. More...
 
float getValue (const Window &wnd, const Rectf &container) const
 Return a value that represents this dimension as absolute pixels. More...
 
BaseDimclone () const
 Create an exact copy of the specialised object and return it as a pointer to a BaseDim object. More...
 
- Public Member Functions inherited from CEGUI::BaseDim
virtual void writeXMLToStream (XMLSerializer &xml_stream) const
 Writes an xml representation of this BaseDim to out_stream. More...
 
virtual bool handleFontRenderSizeChange (Window &window, const Font *font) const
 perform any processing required due to the given font having changed.
 

Protected Member Functions

void writeXMLElementName_impl (XMLSerializer &xml_stream) const
 Implementataion method to output real xml element name.
 
void writeXMLElementAttributes_impl (XMLSerializer &xml_stream) const
 Implementataion method to create the element attributes.
 

Detailed Description

Dimension type that represents an Unified dimension. Implements BaseDim interface.

Constructor & Destructor Documentation

CEGUI::UnifiedDim::UnifiedDim ( const UDim value,
DimensionType  dim 
)

Constructor.

Parameters
valueUDim holding the value to assign to this UnifiedDim.
dimDimensionType value indicating what this UnifiedDim is to represent. This is required because we need to know what part of the base Window that the UDim scale component is to operate against.

Member Function Documentation

BaseDim* CEGUI::UnifiedDim::clone ( ) const
virtual

Create an exact copy of the specialised object and return it as a pointer to a BaseDim object.

Since the system needs to be able to copy objects derived from BaseDim, but only has knowledge of the BaseDim interface, this clone method is provided to prevent slicing issues.

Implements CEGUI::BaseDim.

DimensionType CEGUI::UnifiedDim::getSourceDimension ( ) const

Gets the source dimension type for this WidgetDim.

Returns
DimensionType value indicating which dimension should be used as the scale reference / base value when calculating the pixel value of this dimension.
float CEGUI::UnifiedDim::getValue ( const Window wnd) const
virtual

Return a value that represents this dimension as absolute pixels.

Parameters
wndWindow object that may be used by the specialised class to aid in calculating the final value.
Returns
float value which represents, in pixels, the same value as this BaseDim.

Implements CEGUI::BaseDim.

float CEGUI::UnifiedDim::getValue ( const Window wnd,
const Rectf container 
) const
virtual

Return a value that represents this dimension as absolute pixels.

Parameters
wndWindow object that may be used by the specialised class to aid in calculating the final value (typically would be used to obtain window/widget dimensions).
containerRect object which describes an area to be considered as the base area when calculating the final value. Basically this means that relative values are calculated from the dimensions of this Rect.
Returns
float value which represents, in pixels, the same value as this BaseDim.

Implements CEGUI::BaseDim.

void CEGUI::UnifiedDim::setSourceDimension ( DimensionType  dim)

Sets the source dimension type for this WidgetDim.

Parameters
dimDimensionType value indicating which dimension should be used as the scale reference / base value when calculating the pixel value of this dimension.