Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CEGUI::Dimension Class Reference

Class representing some kind of dimension. More...

#include <CEGUIFalDimensions.h>

Collaboration diagram for CEGUI::Dimension:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Dimension ()
 Constructor.
 ~Dimension ()
 Destructor.
 Dimension (const BaseDim &dim, DimensionType type)
 Constructor.
 Dimension (const Dimension &other)
 Copy constructor.
Dimensionoperator= (const Dimension &other)
 Assignment operator.
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 (OutStream &out_stream) const
 Writes an xml representation of this Dimension to out_stream.

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

Definition at line 481 of file CEGUIFalDimensions.h.


Constructor & Destructor Documentation

CEGUI::Dimension::Dimension  ) 
 

Constructor.

Definition at line 529 of file CEGUIFalDimensions.cpp.

References CEGUI::DT_INVALID.

CEGUI::Dimension::~Dimension  ) 
 

Destructor.

Definition at line 535 of file CEGUIFalDimensions.cpp.

CEGUI::Dimension::Dimension const BaseDim dim,
DimensionType  type
 

Constructor.

Parameters:
dim object based on subclass of BaseDim which holds the dimensional value.
type DimensionType value indicating what dimension this object is to represent.

Definition at line 541 of file CEGUIFalDimensions.cpp.

References CEGUI::BaseDim::clone().

CEGUI::Dimension::Dimension const Dimension other  ) 
 

Copy constructor.

Definition at line 547 of file CEGUIFalDimensions.cpp.

References CEGUI::BaseDim::clone(), d_type, and d_value.


Member Function Documentation

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.

Definition at line 564 of file CEGUIFalDimensions.cpp.

Referenced by CEGUI::ComponentArea::getPixelRect().

DimensionType CEGUI::Dimension::getDimensionType  )  const
 

Return a DimensionType value indicating what this Dimension represents.

Returns:
one of the DimensionType enumerated values.

Definition at line 578 of file CEGUIFalDimensions.cpp.

Referenced by CEGUI::ComponentArea::getPixelRect().

Dimension & CEGUI::Dimension::operator= const Dimension other  ) 
 

Assignment operator.

Definition at line 553 of file CEGUIFalDimensions.cpp.

References CEGUI::BaseDim::clone(), d_type, and d_value.

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

set the current value for this Dimension.

Parameters:
dim object based on a subclass of BaseDim which holds the dimensional value.
Returns:
Nothing.

Definition at line 570 of file CEGUIFalDimensions.cpp.

References CEGUI::BaseDim::clone().

void CEGUI::Dimension::setDimensionType DimensionType  type  ) 
 

Sets what this Dimension represents.

Parameters:
type one of the DimensionType enumerated values.
Returns:
Nothing.

Definition at line 583 of file CEGUIFalDimensions.cpp.

Referenced by CEGUI::Falagard_xmlHandler::elementStart().

void CEGUI::Dimension::writeXMLToStream OutStream out_stream  )  const
 

Writes an xml representation of this Dimension to out_stream.

Parameters:
out_stream Stream where xml data should be output.
Returns:
Nothing.

Definition at line 588 of file CEGUIFalDimensions.cpp.

References CEGUI::FalagardXMLHelper::dimensionTypeToString(), and CEGUI::BaseDim::writeXMLToStream().

Referenced by CEGUI::ComponentArea::writeXMLToStream().


The documentation for this class was generated from the following files:
Generated on Wed Sep 7 10:10:03 2005 for Crazy Eddies GUI System by  doxygen 1.4.3