Abstract interface for a generic 'dimension' class.
More...
Inherited by CEGUI::AbsoluteDim, CEGUI::FontDim, CEGUI::ImageDim, CEGUI::PropertyDim, CEGUI::UnifiedDim, and CEGUI::WidgetDim.
List of all members.
Detailed Description
Abstract interface for a generic 'dimension' class.
Member Function Documentation
Create an exact copy of the specialised class 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.
- Returns:
- BaseDim object pointer
Return the DimensionOperator set for this BaseDim based object.
- Returns:
- One of the DimensionOperator enumerated values representing a mathematical operation to be performed upon this BaseDim using the set operand.
Return a pointer to the BaseDim set to be used as the other operand.
- Returns:
- Pointer to the BaseDim object.
Return a value that represents this dimension as absolute pixels.
- Parameters:
-
wnd | Window 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.
Return a value that represents this dimension as absolute pixels.
- Parameters:
-
wnd | Window 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). |
container | Rect 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.
Set the DimensionOperator set for this BaseDim based object.
- Parameters:
-
op | One of the DimensionOperator enumerated values representing a mathematical operation to be performed upon this BaseDim using the set operand. |
- Returns:
- Nothing.
Set the BaseDim set to be used as the other operand in calculations for this BaseDim.
- Parameters:
-
operand | sub-class of BaseDim representing the 'other' operand. The given object will be cloned; no transfer of ownership occurrs for the passed object. |
- Returns:
- Nothing.
Writes an xml representation of this BaseDim to out_stream.
- Parameters:
-
xml_stream | Stream where xml data should be output. |
- Returns:
- Nothing.