omegaToolkit::ui::Image Class Reference

#include <Image.h>

Public Member Functions
	Image (Engine *srv)
virtual	~Image ()
Renderable *	createRenderable ()
PixelData *	getData ()
	Get this image contexts as a pixel data object. More...
void	setData (PixelData *data)
	Set this image contents from a pixel data object. More...
void	setTexture (TextureSource *data)
	Set this image contents from a texture source. More...
TextureSource *	getTexture ()
void	tile (bool value)
	If set to true, the image will be tiled instead of stretched to fill the image widget area. More...
void	setSourceRect (int x, int y, int w, int h)
	Sets the pixel rect in the source pixeldata to use on the image. More...
void	setDestRect (int x, int y, int w, int h)
	Sets the destination rect within the Image widget rect to use as the image output. More...
Public Member Functions inherited from omegaToolkit::ui::Widget
	Widget (Engine *server)
virtual	~Widget ()
virtual void	handleEvent (const Event &evt)
virtual void	update (const omega::UpdateContext &context)
Container *	getContainer ()
const String &	getName ()
	Returns the widget name. More...
void	setName (const String &name)
	Sets the widget name. More...
int	getId ()
	Returns the unique Widget id. More...
virtual void	layout ()
void	setStereo (bool value)
bool	isStereo ()
virtual void	autosize ()
virtual void	updateSize ()
void	requestLayoutRefresh ()
Layer	getLayer ()
void	setLayer (Layer layer)
bool	hitTest (const Vector2f &point)
	Returns true if the point is within this widget's bounding box. More...
Vector2f	transformPoint (const omega::Vector2f &point)
	Transforms a 2D point from screen space to this widget's reference frame. More...
void	setUserData (void *data)
void *	getUserData ()
bool	isDraggable ()
void	setDraggable (bool value)
bool	isDragging ()
bool	isPinned ()
	When a widget is pinned, its position will remain fixed with respect to its container. More...
void	setPinned (bool value)
void	setSizeAnchorEnabled (bool enabled)
bool	isSizeAnchorEnabled ()
void	setSizeAnchor (const Vector2f &value)
const Vector2f	getSizeAnchor ()
WidgetFactory *	getFactory ()
void	setUIEventHandler (IEventListener *value)
	Input and Events. More...
IEventListener *	getUIEventHandler ()
void	setUIEventCommand (const String &command)
bool	isButtonDown (const Event &evt, Event::Flags button)
	Returns true if the event is a button down event happening on this widget. More...
bool	isButtonUp (const Event &evt, Event::Flags button)
	Returns true if the event is a button up event happening on this widget. More...
void	setUpdateCommand (const String &cmd)
	Sets or gets a script command to be invoked on every update for this widget. More...
String	getUpdateCommand ()
void	setDragBeginCommand (const String &cmd)
	Sets or gets a script command to be invoked when this widget starts dragging. More...
String	getDragBeginCommand ()
void	setDragEndCommand (const String &cmd)
	Sets or gets a script command to be invoked when this widget ends dragging. More...
String	getDragEndCommand ()
void	setActivateCommand (const String &cmd)
	Sets or gets a script command to be invoked when this widget gets active status. More...
String	getActivateCommand ()
void	setDeactivateCommand (const String &cmd)
	Sets or gets a script command to be invoked when this widget loses active status. More...
String	getDeactivateCommand ()
const Vector2f &	getPosition ()
	Position and rotation. More...
Vector2f	getDerivedPosition ()
	Gets the widget position in screen space. More...
void	setPosition (const omega::Vector2f &value)
	Sets the widget position. More...
void	setPosition (int value, int dimension)
void	setCenter (const omega::Vector2f &value)
Vector2f	getCenter ()
void	setRotation (float value)
	Sets the widget rotation. More...
float	getRotation ()
	Gets the widget position. More...
const Vector2f &	getSize ()
	Size constraints. More...
float	getWidth ()
float	getHeight ()
void	setSize (const Vector2f &value)
	Sets the widget size. More...
void	setWidth (float value)
void	setHeight (float value)
const Vector2f &	getMinimumSize ()
const Vector2f &	getMaximumSize ()
void	setMinimumSize (const Vector2f &value)
int	getMinimumWidth ()
int	getMinimumHeight ()
void	setMaximumSize (const Vector2f &value)
int	getMaximumWidth ()
int	getMaximumHeight ()
void	setMinimumWidth (float value)
void	setMinimumHeight (float value)
void	setMaximumWidth (float value)
void	setMaximumHeight (float value)
void	clearSizeConstaints ()
void	setAutosize (bool value)
bool	getAutosize ()
bool	isVisible ()
	Flags. More...
void	setVisible (bool value)
bool	isEnabled ()
	When true, the widget is enabled, i.e. it can receive input events and takes part in navigation (can become active) More...
void	setEnabled (bool value)
bool	isActive ()
void	setActive (bool value)
virtual bool	isIn3DContainer ()
	Returns true if this widget is part of a container that will be drawn in 3D mode. More...
bool	isPointerInside ()
void	setHorizontalNextWidget (Widget *value)
	Navigation. More...
Widget *	getHorizontalNextWidget ()
void	setHorizontalPrevWidget (Widget *value)
Widget *	getHorizontalPrevWidget ()
void	setVerticalNextWidget (Widget *value)
Widget *	getVerticalNextWidget ()
void	setVerticalPrevWidget (Widget *value)
Widget *	getVerticalPrevWidget ()
bool	isNavigationEnabled ()
void	setNavigationEnabled (bool value)
bool	isGamepadInteractionEnabled ()
bool	isPointerInteractionEnabled ()
void	setStyle (const String &style)
	Appearance. More...
String	getStyleValue (const String &key, const String &defaultValue="")
void	setStyleValue (const String &key, const String &value)
void	setScale (float value)
void	setActiveStyle (const String &value)
void	setInactiveStyle (const String &value)
String	getActiveStyle ()
String	getInactiveStyle ()
float	getScale ()
	Sets the widget scale. More...
float	getDerivedScale ()
	Gets the scale of this widget, taking into account the scale of any parent container. More...
void	setAlpha (float value)
float	getAlpha ()
void	setBlendMode (BlendMode value)
BlendMode	getBlendMode ()
void	setFillColor (const Color &c)
void	setFillEnabled (bool value)
BorderStyle &	getBorderStyle (int side)
	Gets the style for one of the borders. More...
void	setShaderEnabled (bool value)
	Enables or disables shaders for this widget. More...
bool	isShaderEnabled ()
void	setShaderName (const String &name)
	Sets the name of the shader used by this widget. More...
const String &	getShaderName ()
Color	getDebugColor ()
	Debug mode. More...
void	setDebugColor (omega::Color value)
	Sets the color used when widget debug mode is enabled. More...
bool	isDebugModeEnabled ()
	Returns true if debug mode is enabled for this widget. More...
void	setDebugModeEnabled (bool value)
	Enabled or disabled debug mode for this widget. More...
void	setPreDrawCallback (PyObject *predcb)
	Scriptable draw callbacks. More...
void	setPostDrawCallback (PyObject *postdcb)
	Sets a python function to be called right before rendering of this widget terminates. More...
Public Member Functions inherited from omega::RenderableFactory
	RenderableFactory ()
virtual	~RenderableFactory ()
virtual void	initialize (Engine *srv)
void	dispose ()
void	refresh ()
virtual bool	isInitialized ()
Renderable *	getRenderable (Renderer *client)
Engine *	getEngine ()
Public Member Functions inherited from omicron::ReferenceType
	ReferenceType ()
virtual	~ReferenceType ()
void	ref ()
void	unref ()
long	refCount ()

Static Public Member Functions
static Image *	create (Container *container)
Static Public Member Functions inherited from omegaToolkit::ui::Widget
static Widget *	create (Container *parent)
template<typename W >
static W *	getSource (const Event &evt)
Static Public Member Functions inherited from omicron::ReferenceType
static void	printObjCounts ()

Protected Attributes
Ref< TextureSource >	myData
Rect	myDestRect
Rect	mySourceRect
bool	myUseFullSource
bool	myUseFullDest
bool	myTile
Protected Attributes inherited from omegaToolkit::ui::Widget
omega::Vector2f	myPosition
omega::Vector2f	mySize
float	myRotation

Friends
class	ImageRenderable

Additional Inherited Members
Public Types inherited from omegaToolkit::ui::Widget
enum	Layer { Back, Middle, Front, NumLayers }
enum	BlendMode { BlendInherit, BlendNormal, BlendAdditive, BlendDisabled }
Static Public Attributes inherited from omegaToolkit::ui::Widget
static const int	MaxWidgets = 16384
Protected Member Functions inherited from omegaToolkit::ui::Widget
bool	simpleHitTest (const omega::Vector2f &point)
virtual void	activate ()
	Called when this widget becomes the active widget. More...
virtual void	deactivate ()
	Called when this widget is not the active widget anymore. More...
virtual void	updateStyle ()
void	setContainer (Container *value)
void	dispatchUIEvent (const Event &evt)
void	playMenuScrollSound ()
bool	needLayoutRefresh ()
	internal layout management More...
void	setActualSize (int value, Orientation orientation, bool force=false)
Protected Member Functions inherited from omega::RenderableFactory
Renderable *	addRenderable (Renderer *cli)
Static Protected Member Functions inherited from omegaToolkit::ui::Widget
static bool	simpleHitTest (const omega::Vector2f &point, const omega::Vector2f &pos, const omega::Vector2f &size)
Static Protected Attributes inherited from omicron::ReferenceType
static List< ReferenceType * >	mysObjList

Inheritance diagram for omegaToolkit::ui::Image:

Constructor & Destructor Documentation

omegaToolkit::ui::Image::Image

(

Engine *

srv

)

virtual omegaToolkit::ui::Image::~Image ( )

virtual

Member Function Documentation

static Image* omegaToolkit::ui::Image::create ( Container *  container )

static

Renderable* omegaToolkit::ui::Image::createRenderable ( )

virtual

Reimplemented from omegaToolkit::ui::Widget.

PixelData * omegaToolkit::ui::Image::getData ( )

inline

Get this image contexts as a pixel data object.

Note

if the image content has been set as a texture source, this method will return null.

TextureSource * omegaToolkit::ui::Image::getTexture ( )

inline

void omegaToolkit::ui::Image::setData ( PixelData *  data )

inline

Set this image contents from a pixel data object.

void omegaToolkit::ui::Image::setDestRect	(	int	x,
		int	y,
		int	w,
		int	h
	)

Sets the destination rect within the Image widget rect to use as the image output.

If rect is set to (0,0,0,0) the full image area will be used.

void omegaToolkit::ui::Image::setSourceRect	(	int	x,
		int	y,
		int	w,
		int	h
	)

Sets the pixel rect in the source pixeldata to use on the image.

If rect is set to (0,0,0,0) the full image will be used.

void omegaToolkit::ui::Image::setTexture

(

TextureSource *

data

)

Set this image contents from a texture source.

void omegaToolkit::ui::Image::tile

(

bool

value

)

If set to true, the image will be tiled instead of stretched to fill the image widget area.

Cannot be used with sourceRect and destRect.

Friends And Related Function Documentation

friend class ImageRenderable

friend

Member Data Documentation

Ref<TextureSource> omegaToolkit::ui::Image::myData

protected

Rect omegaToolkit::ui::Image::myDestRect

protected

Rect omegaToolkit::ui::Image::mySourceRect

protected

bool omegaToolkit::ui::Image::myTile

protected

bool omegaToolkit::ui::Image::myUseFullDest

protected

bool omegaToolkit::ui::Image::myUseFullSource

protected

---

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

• C:/dev/omegalib/release/include/omegaToolkit/ui/Image.h