Crazy Eddie's GUI System  0.8.2
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
CEGUI::Image Class Referenceabstract

Interface for Image. More...

+ Inheritance diagram for CEGUI::Image:
+ Collaboration diagram for CEGUI::Image:

Public Member Functions

virtual const StringgetName () const =0
 
virtual const SizefgetRenderedSize () const =0
 
virtual const Vector2fgetRenderedOffset () const =0
 
virtual void render (GeometryBuffer &buffer, const Rectf &dest_area, const Rectf *clip_area, const ColourRect &colours) const =0
 
virtual void notifyDisplaySizeChanged (const Sizef &size)=0
 
void render (GeometryBuffer &buffer, const Vector2f &position, const Rectf *clip_area=0) const
 
void render (GeometryBuffer &buffer, const Vector2f &position, const Rectf *clip_area, const ColourRect &colours) const
 
void render (GeometryBuffer &buffer, const Vector2f &position, const Sizef &size, const Rectf *clip_area=0) const
 
void render (GeometryBuffer &buffer, const Vector2f &position, const Sizef &size, const Rectf *clip_area, const ColourRect &colours) const
 
- Public Member Functions inherited from CEGUI::ChainedXMLHandler
const StringgetSchemaName () const
 Retrieves the schema file name to use with resources handled by this handler.
 
const StringgetDefaultResourceGroup () const
 Retrieves the default resource group to be used when handling files.
 
void elementStart (const String &element, const XMLAttributes &attributes)
 Method called to notify the handler at the start of each XML element encountered. More...
 
void elementEnd (const String &element)
 Method called to notify the handler at the end of each XML element encountered. More...
 
bool completed () const
 returns whether this chained handler has completed.
 
- Public Member Functions inherited from CEGUI::XMLHandler
 XMLHandler (void)
 XMLHandler base class constructor.
 
virtual ~XMLHandler (void)
 XMLHandler base class destructor.
 
void handleContainer (const RawDataContainer &source)
 Takes given RawDataContainer containing XML and handles it. More...
 
void handleFile (const String &fileName, const String &resourceGroup)
 Takes given file containing XML and handles it. More...
 
void handleString (const String &source)
 Takes given string containing XML source and handles it. More...
 
virtual void text (const String &text)
 Method called to notify text node, several successiv text node are agregated. More...
 

Static Public Member Functions

static void computeScalingFactors (AutoScaledMode mode, const Sizef &display_size, const Sizef &native_display_size, float &x_scale, float &y_scale)
 Helper able to compute scaling factors for auto scaling. More...
 

Protected Member Functions

void elementStartLocal (const String &element, const XMLAttributes &attributes)
 Function that handles elements locally (used at end of handler chain)
 
void elementEndLocal (const String &element)
 Function that handles elements locally (used at end of handler chain)
 
- Protected Member Functions inherited from CEGUI::ChainedXMLHandler
void cleanupChainedHandler ()
 clean up any chained handler.
 

Additional Inherited Members

- Protected Attributes inherited from CEGUI::ChainedXMLHandler
ChainedXMLHandlerd_chainedHandler
 chained xml handler object.
 
bool d_completed
 is the chained handler completed.
 
bool d_deleteChaniedHandler
 should the chained handler be deleted by us?
 

Detailed Description

Interface for Image.

In CEGUI, an Image is some object that can render itself into a given GeometryBuffer object. This may be something as simple as a basic textured quad, or something more complex.

Member Function Documentation

static void CEGUI::Image::computeScalingFactors ( AutoScaledMode  mode,
const Sizef display_size,
const Sizef native_display_size,
float &  x_scale,
float &  y_scale 
)
static

Helper able to compute scaling factors for auto scaling.

Note
This is mostly for internal use, unless you know what you are doing, please don't touch this method!