Dimension type that represents some dimension of a named Image. Implements BaseDim interface. More...

Inheritance diagram for CEGUI::ImageDim:

Collaboration diagram for CEGUI::ImageDim:

Public Member Functions
	ImageDim (const String &imageset, const String &image, DimensionType dim)
	Constructor. More...

void	setSourceImage (const String &imageset, const String &image)
	Sets the source image information for this ImageDim. More...

void	setSourceDimension (DimensionType dim)
	Sets the source dimension type for this ImageDim. More...

Public Member Functions inherited from CEGUI::BaseDim
float	getValue (const Window &wnd) const
	Return a value that represents this dimension as absolute pixels. More...

float	getValue (const Window &wnd, const Rect &container) const
	Return a value that represents this dimension as absolute pixels. More...

BaseDim *	clone () const
	Create an exact copy of the specialised class and return it as a pointer to a BaseDim object. More...

DimensionOperator	getDimensionOperator () const
	Return the DimensionOperator set for this BaseDim based object. More...

void	setDimensionOperator (DimensionOperator op)
	Set the DimensionOperator set for this BaseDim based object. More...

const BaseDim *	getOperand () const
	Return a pointer to the BaseDim set to be used as the other operand. More...

void	setOperand (const BaseDim &operand)
	Set the BaseDim set to be used as the other operand in calculations for this BaseDim. More...

void	writeXMLToStream (XMLSerializer &xml_stream) const
	Writes an xml representation of this BaseDim to out_stream. More...

Protected Member Functions
float	getValue_impl (const Window &wnd) const
	Implementataion method to return the base value for this BaseDim. This method should not attempt to apply the mathematical operator; this is handled automatically.

float	getValue_impl (const Window &wnd, const Rect &container) const
	Implementataion method to return the base value for this BaseDim. This method should not attempt to apply the mathematical operator; this is handled automatically by BaseDim.

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.

BaseDim *	clone_impl () const
	Implementataion method to return a clone of this sub-class of BaseDim. This method should not attempt to clone the mathematical operator or operand; theis is handled automatically by BaseDim.

Detailed Description

Dimension type that represents some dimension of a named Image. Implements BaseDim interface.

Constructor & Destructor Documentation

Constructor.

Parameters

imageset	String object holding the name of the imagseset which contains the image.
image	String object holding the name of the image.
dim	DimensionType value indicating which dimension of the described image that this ImageDim is to represent.

Referenced by clone_impl().

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

Sets the source dimension type for this ImageDim.

Parameters

dim	DimensionType value indicating which dimension of the described image that this ImageDim is to represent.

void CEGUI::ImageDim::setSourceImage	(	const String &	imageset,
		const String &	image
	)

Sets the source image information for this ImageDim.

Parameters

imageset	String object holding the name of the imagseset which contains the image.
image	String object holding the name of the image.