DigitalSpaces::DICEGUIImageset Struct Reference
[CEGUI]

#include <CEGUIInterfaces.h>


Public Member Functions
const char *	getName ()
	return Texture object for this Imageset
unsigned int	getImageCount ()
	return number of images defined for this Imageset
bool	isImageDefined (const char *name)
	return true if an Image with the specified name exists.
DICEGUIImage *	getImage (const char *name)
	return a copy of the Image object for the named image
void	undefineImage (const char *name)
	remove the definition for the Image with the specified name. If no such Image exists, nothing happens.
void	undefineAllImages ()
	Removes the definitions for all Image objects currently defined in the Imageset.
void	getImageSize (const char name, out_Pairf size)
	return a Size object describing the dimensions of the named image.
float	getImageWidth (const char *name)
	return the width of the named image.
float	getImageHeight (const char *name)
	return the height of the named image.
void	getImageOffset (const char name, out_Pairf offset)
	return the rendering offsets applied to the named image.
float	getImageOffsetX (const char *name)
	return the x rendering offset for the named image.
float	getImageOffsetY (const char *name)
	return the y rendering offset for the named image.
void	defineImage (const char name, in_Pairf position, in_Pairf size, in_Pairf render_offset)
	Define a new Image for this Imageset.
void	defineImage (const char name, in_Vector4f image_rect, in_Pairf *render_offset)
	Define a new Image for this Imageset.
bool	isAutoScaled ()
	Return whether this Imageset is auto-scaled.
void	getNativeResolution (out_Pairf *resolution)
	Return the native display size for this Imageset. This is only relevant if the Imageset is being auto-scaled.
void	setAutoScalingEnabled (bool setting)
	Enable or disable auto-scaling for this Imageset.
void	setNativeResolution (in_Pairf *size)
	Set the native resolution for this Imageset.
void	notifyScreenResolution (in_Pairf *size)
	Notify the Imageset of the current (usually new) display resolution.

Member Function Documentation

const char* DigitalSpaces::DICEGUIImageset::getName ( )

return Texture object for this Imageset

Returns:: Texture object that holds the imagery for this Imageset

return String object holding the name of the Imageset

Returns:: String object that holds the name of the Imageset.

unsigned int DigitalSpaces::DICEGUIImageset::getImageCount ( )

return number of images defined for this Imageset

Returns:: unsigned int value equal to the number of Image objects defined for the Imageset

bool DigitalSpaces::DICEGUIImageset::isImageDefined ( const char * name )

return true if an Image with the specified name exists.

Parameters:

name

String object holding the name of the Image to look for.

Returns:: true if an Image object named name is defined for this Imageset, else false.

DICEGUIImage* DigitalSpaces::DICEGUIImageset::getImage ( const char * name )

return a copy of the Image object for the named image

Parameters:

name

String object holding the name of the Image object to be returned

Returns:: constant Image object that has the requested name.

Exceptions:

UnknownObjectException

thrown if no Image named name is defined for the Imageset

void DigitalSpaces::DICEGUIImageset::undefineImage ( const char * name )

remove the definition for the Image with the specified name. If no such Image exists, nothing happens.

Parameters:

name

String object holding the name of the Image object to be removed from the Imageset,

Returns:: Nothing.

void DigitalSpaces::DICEGUIImageset::undefineAllImages ( )

Removes the definitions for all Image objects currently defined in the Imageset.

Returns:: Nothing

void DigitalSpaces::DICEGUIImageset::getImageSize	(	const char *	name,
		out_Pairf *	size
	)

return a Size object describing the dimensions of the named image.

Parameters:

name

String object holding the name of the Image.

Returns:: Size object holding the dimensions of the requested Image.

Exceptions:

UnknownObjectException

thrown if no Image named name is defined for the Imageset

float DigitalSpaces::DICEGUIImageset::getImageWidth ( const char * name )

return the width of the named image.

Parameters:

name

String object holding the name of the Image.

Returns:: float value equalling the width of the requested Image.

Exceptions:

UnknownObjectException

thrown if no Image named name is defined for the Imageset

float DigitalSpaces::DICEGUIImageset::getImageHeight ( const char * name )

return the height of the named image.

Parameters:

name

String object holding the name of the Image.

Returns:: float value equalling the height of the requested Image.

Exceptions:

UnknownObjectException

thrown if no Image named name is defined for the Imageset

void DigitalSpaces::DICEGUIImageset::getImageOffset	(	const char *	name,
		out_Pairf *	offset
	)

return the rendering offsets applied to the named image.

Parameters:

name

String object holding the name of the Image.

Returns:: Point object that holds the rendering offsets for the requested Image.

Exceptions:

UnknownObjectException

thrown if no Image named name is defined for the Imageset

float DigitalSpaces::DICEGUIImageset::getImageOffsetX ( const char * name )

return the x rendering offset for the named image.

Parameters:

name

String object holding the name of the Image.

Returns:: float value equal to the x rendering offset applied when drawing the requested Image.

Exceptions:

UnknownObjectException

thrown if no Image named name is defined for the Imageset

float DigitalSpaces::DICEGUIImageset::getImageOffsetY ( const char * name )

return the y rendering offset for the named image.

Parameters:

name

String object holding the name of the Image.

Returns:: float value equal to the y rendering offset applied when drawing the requested Image.

Exceptions:

UnknownObjectException

thrown if no Image named name is defined for the Imageset

void DigitalSpaces::DICEGUIImageset::defineImage	(	const char *	name,
		in_Pairf *	position,
		in_Pairf *	size,
		in_Pairf *	render_offset
	)

Define a new Image for this Imageset.

Parameters:

	name	String object holding the name that will be assigned to the new Image, which must be unique within the Imageset.
	position	Point object describing the pixel location of the Image on the image file / texture associated with this Imageset.
	size	Size object describing the dimensions of the Image, in pixels.
	render_offset	Point object describing the offsets, in pixels, that are to be applied to the Image when it is drawn.

Returns:: Nothing

Exceptions:

AlreadyExistsException

thrown if an Image named name is already defined for this Imageset

void DigitalSpaces::DICEGUIImageset::defineImage	(	const char *	name,
		in_Vector4f *	image_rect,
		in_Pairf *	render_offset
	)

Define a new Image for this Imageset.

Parameters:

	name	String object holding the name that will be assigned to the new Image, which must be unique within the Imageset.
	image_rect	Rect object describing the area on the image file / texture associated with this Imageset that will be used for the Image.
	render_offset	Point object describing the offsets, in pixels, that are to be applied to the Image when it is drawn.

Returns:: Nothing

Exceptions:

AlreadyExistsException

thrown if an Image named name is already defined for this Imageset

bool DigitalSpaces::DICEGUIImageset::isAutoScaled ( )

Return whether this Imageset is auto-scaled.

Returns:: true if Imageset is auto-scaled, false if not.

void DigitalSpaces::DICEGUIImageset::getNativeResolution ( out_Pairf * resolution )

Return the native display size for this Imageset. This is only relevant if the Imageset is being auto-scaled.

Returns:: Size object describing the native display size for this Imageset.

void DigitalSpaces::DICEGUIImageset::setAutoScalingEnabled ( bool setting )

Enable or disable auto-scaling for this Imageset.

Parameters:

setting

true to enable auto-scaling, false to disable auto-scaling.

Returns:: Nothing.

void DigitalSpaces::DICEGUIImageset::setNativeResolution ( in_Pairf * size )

Set the native resolution for this Imageset.

Parameters:

size

Size object describing the new native screen resolution for this Imageset.

Returns:: Nothing

void DigitalSpaces::DICEGUIImageset::notifyScreenResolution ( in_Pairf * size )

Notify the Imageset of the current (usually new) display resolution.

Parameters:

size

Size object describing the display resolution

Returns:: Nothing

The documentation for this struct was generated from the following file:

CEGUIInterfaces/CEGUIInterfaces.h

DigitalSpaces::DICEGUIImageset Struct Reference [CEGUI]

Public Member Functions

Member Function Documentation

DigitalSpaces::DICEGUIImageset Struct Reference
[CEGUI]