#include <MyGUI_Canvas.h>

Inheritance diagram for MyGUI::Canvas:

Data Structures
struct	Event

Public Types
enum	TextureResizeMode { TRM_PT_CONST_SIZE, TRM_PT_VIEW_REQUESTED, TRM_PT_VIEW_ALL }
typedef RTTIBase	Base
typedef Canvas	RTTIBase
typedef delegates::CDelegate1 < Canvas * >	EventInfo_Canvas
typedef delegates::CDelegate2 < Canvas *, Event >	EventInfo_CanvasEvent
Public Types inherited from MyGUI::Widget
typedef Widget	RTTIBase
Public Types inherited from MyGUI::IObject
typedef IObject	RTTIBase

Public Member Functions
virtual const std::string &	getTypeName () const
virtual bool	isType (const std::type_info &_type) const
template<typename Type >
bool	isType () const
	Canvas ()
void	createTexture (TextureResizeMode _resizeMode, TextureUsage _usage=getDefaultTextureUsage(), PixelFormat _format=getDefaultTextureFormat())
	Creates texture.
void	createTexture (int _width, int _height, TextureResizeMode _resizeMode, TextureUsage _usage=getDefaultTextureUsage(), PixelFormat _format=getDefaultTextureFormat())
	Creates texture.
void	createTexture (const IntSize &_size, TextureResizeMode _resizeMode, TextureUsage _usage=getDefaultTextureUsage(), PixelFormat _format=getDefaultTextureFormat())
	Creates texture.
void	destroyTexture ()
	Destroys texture.
void	updateTexture ()
	Call user delegate update and removes old texture if it isn't original.
void *	lock (TextureUsage _usage=TextureUsage::Write)
	Locks hardware pixel buffer.
void	unlock ()
	Unlocks hardware pixel buffer.
bool	isLocked () const
	Checks lockness of hardware _pixel buffer.
int	getTextureRealWidth () const
	Returns real width of texture.
int	getTextureRealHeight () const
	Returns real height of texture.
IntSize	getTextureRealSize () const
	Returns real _size of texture.
int	getTextureSrcWidth () const
	Returns needed width while creating texture.
int	getTextureSrcHeight () const
	Returns needed height while creating texture.
IntSize	getTextureSrcSize () const
	Returns needed sizes while creating texture.
PixelFormat	getTextureFormat () const
	Returns needed sizes while creating texture.
const std::string &	getTextureName () const
	Returns name of the current texture.
virtual void	setSize (const IntSize &_value)

virtual void	setCoord (const IntCoord &_value)

void	setSize (int _width, int _height)

void	setCoord (int _left, int _top, int _width, int _height)

TextureResizeMode	getResizeMode () const
	Returns resize mode.
void	setResizeMode (TextureResizeMode _set)
	Sets resize mode of texture.
bool	isTextureSrcSize () const
	Checks if the texture has the source (required by user) size, otherwise real texture size are bigger.
bool	isTextureCreated () const
	Returns true if the texture was created (and exists), otherwise false.
bool	isTextureManaged () const
	Returns true if we own the texture, otherwise false.
ITexture *	getTexture ()
	Reurns interface texture.
void	setTextureManaged (bool _value)
	Sets the texture managed.
virtual void	_initialise (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin _info, Widget _parent, ICroppedRectangle _croppedParent, IWidgetCreator _creator, const std::string &_name)
Public Member Functions inherited from MyGUI::Widget
template<typename Type >
Type *	castType (bool _throw=true)
template<typename Type >
const Type *	castType (bool _throw=true) const
	Widget ()
Widget *	createWidgetT (const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")
Widget *	createWidgetT (const std::string &_type, const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")
Widget *	createWidgetRealT (const std::string &_type, const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")
Widget *	createWidgetRealT (const std::string &_type, const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")
template<typename T >
T *	createWidget (const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_name="")
template<typename T >
T *	createWidget (const std::string &_skin, int _left, int _top, int _width, int _height, Align _align, const std::string &_name="")
template<typename T >
T *	createWidgetReal (const std::string &_skin, const FloatCoord &_coord, Align _align, const std::string &_name="")
template<typename T >
T *	createWidgetReal (const std::string &_skin, float _left, float _top, float _width, float _height, Align _align, const std::string &_name="")
Widget *	createWidgetT (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")
template<typename T >
T *	createWidget (WidgetStyle _style, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer="", const std::string &_name="")
const std::string &	getName () const
	Get name of widget.
virtual void	setPosition (const IntPoint &_value)
void	setPosition (int _left, int _top)
void	setRealPosition (const FloatPoint &_value)
void	setRealSize (const FloatSize &_value)
void	setRealCoord (const FloatCoord &_value)
void	setRealPosition (float _left, float _top)
void	setRealSize (float _width, float _height)
void	setRealCoord (float _left, float _top, float _width, float _height)
virtual void	setVisible (bool _value)
virtual void	setAlign (Align _value)
virtual void	setCaption (const UString &_value)
virtual const UString &	getCaption ()
void	setAlpha (float _value)
float	getAlpha ()
void	setInheritsAlpha (bool _value)
bool	isInheritsAlpha ()
bool	setState (const std::string &_value)
void	setColour (const Colour &_value)
bool	isRootWidget ()
Widget *	getParent ()
EnumeratorWidgetPtr	getEnumerator ()
size_t	getChildCount ()
Widget *	getChildAt (size_t _index)
Widget *	findWidget (const std::string &_name)
void	setNeedKeyFocus (bool _value)
bool	isNeedKeyFocus ()
void	setNeedMouseFocus (bool _value)
bool	isNeedMouseFocus ()
void	setInheritsPick (bool _value)
bool	isInheritsPick ()
void	setMaskPick (const std::string &_filename)
virtual void	setEnabled (bool _value)
void	setEnabledSilent (bool _value)
bool	isEnabled ()
void	setPointer (const std::string &_value)
const std::string &	getPointer ()
const std::string &	getLayerName ()
IntCoord	getClientCoord ()
Widget *	getClientWidget ()
ISubWidgetText *	getSubWidgetText ()
ISubWidgetRect *	getSubWidgetMain ()
void	setNeedToolTip (bool _value)
bool	getNeedToolTip ()
void	setEnableToolTip (bool _value)
bool	getEnableToolTip ()
void	detachFromWidget (const std::string &_layer="")
void	attachToWidget (Widget *_parent, WidgetStyle _style=WidgetStyle::Child, const std::string &_layer="")
void	changeWidgetSkin (const std::string &_skinname)
void	setWidgetStyle (WidgetStyle _style, const std::string &_layer="")
WidgetStyle	getWidgetStyle ()
virtual void	setProperty (const std::string &_key, const std::string &_value)
virtual void	_getContainer (Widget *&_container, size_t &_index)
void	_forcePeek (Widget *_widget)
void	_setUVSet (const FloatRect &_rect)
virtual void	_setTextureName (const std::string &_texture)
virtual const std::string &	_getTextureName ()
IWidgetCreator *	_getIWidgetCreator ()
IntCoord	_getTextRegion ()
IntSize	_getTextSize ()
void	_setFontName (const std::string &_font)
const std::string &	_getFontName ()
void	_setFontHeight (int _height)
int	_getFontHeight ()
void	_setTextAlign (Align _align)
Align	_getTextAlign ()
void	_setTextColour (const Colour &_colour)
const Colour &	_getTextColour ()
void	setCaptionWithNewLine (const std::string &_value)
void	setPosition (const IntCoord &_coord)
void	setPosition (int _left, int _top, int _width, int _height)
void	enableToolTip (bool _enable)
void	setInheritsPeek (bool _inherits)
bool	isInheritsPeek ()
void	setMaskPeek (const std::string &_filename)
IntCoord	getTextCoord ()
IntSize	getTextSize ()
void	setFontName (const std::string &_font)
const std::string &	getFontName ()
void	setFontHeight (int _height)
int	getFontHeight ()
void	setTextAlign (Align _align)
Align	getTextAlign ()
void	setTextColour (const Colour &_colour)
const Colour &	getTextColour ()
Public Member Functions inherited from MyGUI::IObject
virtual	~IObject ()
Public Member Functions inherited from MyGUI::ICroppedRectangle
	ICroppedRectangle ()
virtual	~ICroppedRectangle ()
ICroppedRectangle *	getCroppedParent ()
const IntCoord &	getCoord () const
IntPoint	getPosition () const
IntSize	getSize () const
bool	isVisible () const
const IntPoint &	getAbsolutePosition () const
IntRect	getAbsoluteRect () const
IntCoord	getAbsoluteCoord () const
int	getAbsoluteLeft () const
int	getAbsoluteTop () const
Align	getAlign () const
int	getLeft () const
int	getRight () const
int	getTop () const
int	getBottom () const
int	getWidth () const
int	getHeight () const
bool	_isMargin () const
int	_getViewLeft () const
int	_getViewRight () const
int	_getViewTop () const
int	_getViewBottom () const
int	_getViewWidth () const
int	_getViewHeight () const
virtual void	_correctView ()
void	_setCroppedParent (ICroppedRectangle *_parent)
const IntRect &	_getMargin () const
int	_getMarginLeft () const
int	_getMarginRight () const
int	_getMarginTop () const
int	_getMarginBottom () const
void	show ()
void	hide ()
bool	isShow ()
Public Member Functions inherited from MyGUI::LayerItem
	LayerItem ()
virtual	~LayerItem ()
ILayer *	getLayer ()
virtual void	attachItemToNode (ILayer _layer, ILayerNode _node)
virtual void	detachFromLayer ()
virtual void	upLayerItem ()
void	setRenderItemTexture (ITexture *_texture)
void	addChildItem (LayerItem *_item)
void	removeChildItem (LayerItem *_item)
void	addChildNode (LayerItem *_item)
void	removeChildNode (LayerItem *_item)
void	addRenderItem (ISubWidget *_item)
void	removeAllRenderItems ()
void	saveLayerItem ()
void	restoreLayerItem ()
Public Member Functions inherited from MyGUI::ILayerItem
virtual	~ILayerItem ()
Public Member Functions inherited from MyGUI::UserData
	UserData ()
virtual	~UserData ()
void	setUserString (const std::string &_key, const std::string &_value)
const std::string &	getUserString (const std::string &_key)
bool	clearUserString (const std::string &_key)
bool	isUserString (const std::string &_key)
void	clearUserStrings ()
void	setUserData (Any _data)
template<typename ValueType >
ValueType *	getUserData (bool _throw=true)
void	_setInternalData (Any _data)
template<typename ValueType >
ValueType *	_getInternalData (bool _throw=true)
void *	getUserData ()
Public Member Functions inherited from MyGUI::WidgetEvent
virtual	~WidgetEvent ()
Public Member Functions inherited from MyGUI::IWidgetCreator
virtual	~IWidgetCreator ()
virtual void	_linkChildWidget (Widget *_widget)
virtual void	_unlinkChildWidget (Widget *_widget)
Public Member Functions inherited from MyGUI::delegates::IDelegateUnlink
virtual	~IDelegateUnlink ()
	IDelegateUnlink ()
bool	compare (IDelegateUnlink *_unlink) const

Static Public Member Functions
static const std::string &	getClassTypeName ()
static TextureUsage	getDefaultTextureUsage ()
	Returns default GUI texture usage.
static PixelFormat	getDefaultTextureFormat ()
	Returns default GUI texture format.

Data Fields
EventInfo_Canvas	eventPreTextureChanges
EventInfo_CanvasEvent	requestUpdateCanvas

Protected Member Functions
virtual	~Canvas ()
void	_destroyTexture (bool _sendEvent)
	Destroys texture.
void	validate (int &_width, int &_height, TextureUsage &_usage, PixelFormat &_format) const
	Update entered parameters according to current texture resize mode(size) and restore (if can) parameters of usage and format from texture.
void	createExactTexture (int _width, int _height, TextureUsage _usage, PixelFormat _format)
	Creates the texture itself.
bool	checkCreate (int _width, int _height) const
	Checks if we need to create a texture with such sizes.
void	resize (const IntSize &_size)
	Calls when resize widget.
void	correctUV ()
	Correct texture uv-coordinates.
void	baseChangeWidgetSkin (ResourceSkin *_info)

void	initialiseWidgetSkin (ResourceSkin *_info)

void	shutdownWidgetSkin ()

void	frameAdvise (bool _advise)
	For updating once per frame.
void	frameEntered (float _time)
	For updating once per frame.
virtual void	textureInvalidate (ITexture *_texture)
Protected Member Functions inherited from MyGUI::Widget
	Widget (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin _info, Widget _parent, ICroppedRectangle _croppedParent, IWidgetCreator _creator, const std::string &_name)
virtual	~Widget ()
void	_updateView ()
void	_setAlign (const IntSize &_oldsize, bool _update)
void	_setAlign (const IntCoord &_oldcoord, bool _update)
virtual Widget *	baseCreateWidget (WidgetStyle _style, const std::string &_type, const std::string &_skin, const IntCoord &_coord, Align _align, const std::string &_layer, const std::string &_name)
virtual void	_destroyChildWidget (Widget *_widget)
virtual void	_destroyAllChildWidget ()
virtual size_t	_getContainerIndex (const IntPoint &_point)
virtual void	_resetContainer (bool _update)
virtual void	baseUpdateEnable ()
virtual ILayerItem *	getLayerItemByPoint (int _left, int _top)
virtual const IntCoord &	getLayerItemCoord ()
Protected Member Functions inherited from MyGUI::ICroppedRectangle
bool	_checkPoint (int _left, int _top)
bool	_checkMargin ()
bool	_checkOutside ()
Protected Member Functions inherited from MyGUI::LayerItem
void	attachToLayerItemNode (ILayerNode *_node, bool _deep)
void	detachFromLayerItemNode (bool _deep)
Protected Member Functions inherited from MyGUI::WidgetEvent
	WidgetEvent ()
virtual void	onMouseLostFocus (Widget *_new)
virtual void	onMouseSetFocus (Widget *_old)
virtual void	onMouseDrag (int _left, int _top)
virtual void	onMouseMove (int _left, int _top)
virtual void	onMouseWheel (int _rel)
virtual void	onMouseButtonPressed (int _left, int _top, MouseButton _id)
virtual void	onMouseButtonReleased (int _left, int _top, MouseButton _id)
virtual void	onMouseButtonClick ()
virtual void	onMouseButtonDoubleClick ()
virtual void	onKeyLostFocus (Widget *_new)
virtual void	onKeySetFocus (Widget *_old)
virtual void	onKeyButtonPressed (KeyCode _key, Char _char)
virtual void	onKeyButtonReleased (KeyCode _key)
virtual void	onMouseChangeRootFocus (bool _focus)
virtual void	onKeyChangeRootFocus (bool _focus)
Protected Member Functions inherited from MyGUI::IWidgetCreator
void	_deleteWidget (Widget *_widget)

Protected Attributes
ITexture *	mTexture
	Current texture.
IntSize	mReqTexSize
	Requested bu user sizes.
std::string	mGenTexName
	Generated texture name.
TextureResizeMode	mTexResizeMode
	Texture resize mode.
uint8 *	mTexData
	Saved pointer from last calling lock.
bool	mTexManaged
	true if we own the texture (can delete it or replace by another instance), otherwise false
bool	mFrameAdvise
	For updating once per frame. True state means updating before next frame starts.
Protected Attributes inherited from MyGUI::Widget
MapWidgetStateInfo	mStateInfo
MaskPickInfo const *	mMaskPickInfo
MaskPickInfo	mOwnMaskPickInfo
VectorWidgetPtr	mWidgetChild
VectorWidgetPtr	mWidgetChildSkin
VectorSubWidget	mSubSkinChild
ISubWidgetText *	mText
ISubWidgetRect *	mMainSkin
bool	mEnabled
bool	mInheritsEnabled
bool	mSubSkinsVisible
bool	mInheritsVisible
float	mAlpha
float	mRealAlpha
bool	mInheritsAlpha
std::string	mName
std::string	mPointer
std::string	mTextureName
ITexture *	mTexture
Widget *	mParent
IWidgetCreator *	mIWidgetCreator
bool	mNeedKeyFocus
bool	mNeedMouseFocus
bool	mInheritsPick
Widget *	mWidgetClient
bool	mNeedToolTip
bool	mEnableToolTip
bool	mToolTipVisible
float	mToolTipCurrentTime
IntPoint	mToolTipOldPoint
size_t	mToolTipOldIndex
IntPoint	m_oldMousePoint
WidgetStyle	mWidgetStyle
FloatCoord	mRelativeCoord
bool	mDisableUpdateRelative
Protected Attributes inherited from MyGUI::ICroppedRectangle
bool	mIsMargin
IntRect	mMargin
IntCoord	mCoord
IntPoint	mAbsolutePosition
ICroppedRectangle *	mCroppedParent
bool	mVisible
Align	mAlign
Protected Attributes inherited from MyGUI::WidgetEvent
Widget *	mWidgetEventSender

Detailed Description

Widget wrapper over Texture - shows the texture. Implemented: resizing of texture (see TextureResizeMode); recovery after lossing device;

Definition at line 37 of file MyGUI_Canvas.h.

Member Typedef Documentation

typedef RTTIBase MyGUI::Canvas::Base

Definition at line 41 of file MyGUI_Canvas.h.

typedef delegates::CDelegate1<Canvas*> MyGUI::Canvas::EventInfo_Canvas

Definition at line 62 of file MyGUI_Canvas.h.

typedef delegates::CDelegate2<Canvas*, Event> MyGUI::Canvas::EventInfo_CanvasEvent

Definition at line 63 of file MyGUI_Canvas.h.

typedef Canvas MyGUI::Canvas::RTTIBase

Definition at line 41 of file MyGUI_Canvas.h.

Member Enumeration Documentation

enum MyGUI::Canvas::TextureResizeMode

Available resize and view modes of texture

Remarks: PT - Power of Two (size)

Enumerator:

TRM_PT_CONST_SIZE

TRM_PT_VIEW_REQUESTED

Texture doesn't resizes and fills all widget space.

TRM_PT_VIEW_ALL

You can view all pixels of texture, texture cropped by sizes of widget.

Texture resizes and fills all widget space

Definition at line 70 of file MyGUI_Canvas.h.

Constructor & Destructor Documentation

MyGUI::Canvas::Canvas ( )

Definition at line 33 of file MyGUI_Canvas.cpp.

MyGUI::Canvas::~Canvas ( )

protectedvirtual

Definition at line 48 of file MyGUI_Canvas.cpp.

Member Function Documentation

void MyGUI::Canvas::_destroyTexture ( bool _sendEvent )

protected

Destroys texture.

Definition at line 165 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::_initialise	(	WidgetStyle	_style,
		const IntCoord &	_coord,
		Align	_align,
		ResourceSkin *	_info,
		Widget *	_parent,
		ICroppedRectangle *	_croppedParent,
		IWidgetCreator *	_creator,
		const std::string &	_name
	)

virtual

Reimplemented from MyGUI::Widget.

Definition at line 43 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::baseChangeWidgetSkin ( ResourceSkin * _info )

protectedvirtual

Reimplemented from MyGUI::Widget.

Definition at line 210 of file MyGUI_Canvas.cpp.

bool MyGUI::Canvas::checkCreate	(	int	_width,
		int	_height
	)		const

protected

Checks if we need to create a texture with such sizes.

Definition at line 133 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::correctUV ( )

protected

Correct texture uv-coordinates.

Definition at line 180 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::createExactTexture	(	int	_width,
		int	_height,
		TextureUsage	_usage,
		PixelFormat	_format
	)

protected

Creates the texture itself.

Definition at line 69 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::createTexture	(	TextureResizeMode	_resizeMode,
		TextureUsage	_usage = `getDefaultTextureUsage()`,
		PixelFormat	_format = `getDefaultTextureFormat()`
	)

Creates texture.

Definition at line 53 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::createTexture	(	int	_width,
		int	_height,
		TextureResizeMode	_resizeMode,
		TextureUsage	_usage = `getDefaultTextureUsage()`,
		PixelFormat	_format = `getDefaultTextureFormat()`
	)

Creates texture.

Definition at line 96 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::createTexture	(	const IntSize &	_size,
		TextureResizeMode	_resizeMode,
		TextureUsage	_usage = `getDefaultTextureUsage()`,
		PixelFormat	_format = `getDefaultTextureFormat()`
	)

Creates texture.

Definition at line 58 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::destroyTexture ( )

Destroys texture.

Definition at line 160 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::frameAdvise ( bool _advise )

protected

For updating once per frame.

Definition at line 228 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::frameEntered ( float _time )

protected

For updating once per frame.

Reimplemented from MyGUI::Widget.

Definition at line 248 of file MyGUI_Canvas.cpp.

static const std::string& MyGUI::Canvas::getClassTypeName ( )

inlinestatic

Reimplemented from MyGUI::Widget.

Definition at line 41 of file MyGUI_Canvas.h.

static PixelFormat MyGUI::Canvas::getDefaultTextureFormat ( )

inlinestatic

Returns default GUI texture format.

Definition at line 163 of file MyGUI_Canvas.h.

static TextureUsage MyGUI::Canvas::getDefaultTextureUsage ( )

inlinestatic

Returns default GUI texture usage.

Definition at line 160 of file MyGUI_Canvas.h.

TextureResizeMode MyGUI::Canvas::getResizeMode ( ) const

inline

Returns resize mode.

Definition at line 139 of file MyGUI_Canvas.h.

ITexture* MyGUI::Canvas::getTexture ( )

inline

Reurns interface texture.

Definition at line 154 of file MyGUI_Canvas.h.

PixelFormat MyGUI::Canvas::getTextureFormat ( ) const

inline

Returns needed sizes while creating texture.

Definition at line 123 of file MyGUI_Canvas.h.

const std::string& MyGUI::Canvas::getTextureName ( ) const

inline

Returns name of the current texture.

Definition at line 126 of file MyGUI_Canvas.h.

int MyGUI::Canvas::getTextureRealHeight ( ) const

inline

Returns real height of texture.

Definition at line 108 of file MyGUI_Canvas.h.

IntSize MyGUI::Canvas::getTextureRealSize ( ) const

inline

Returns real _size of texture.

Definition at line 111 of file MyGUI_Canvas.h.

int MyGUI::Canvas::getTextureRealWidth ( ) const

inline

Returns real width of texture.

Definition at line 105 of file MyGUI_Canvas.h.

int MyGUI::Canvas::getTextureSrcHeight ( ) const

inline

Returns needed height while creating texture.

Definition at line 117 of file MyGUI_Canvas.h.

IntSize MyGUI::Canvas::getTextureSrcSize ( ) const

inline

Returns needed sizes while creating texture.

Definition at line 120 of file MyGUI_Canvas.h.

int MyGUI::Canvas::getTextureSrcWidth ( ) const

inline

Returns needed width while creating texture.

Definition at line 114 of file MyGUI_Canvas.h.

virtual const std::string& MyGUI::Canvas::getTypeName ( ) const

inlinevirtual

Get type name as string

Reimplemented from MyGUI::Widget.

Definition at line 41 of file MyGUI_Canvas.h.

void MyGUI::Canvas::initialiseWidgetSkin ( ResourceSkin * _info )

protected

Definition at line 215 of file MyGUI_Canvas.cpp.

bool MyGUI::Canvas::isLocked ( ) const

inline

Checks lockness of hardware _pixel buffer.

Definition at line 102 of file MyGUI_Canvas.h.

bool MyGUI::Canvas::isTextureCreated ( ) const

inline

Returns true if the texture was created (and exists), otherwise false.

Definition at line 148 of file MyGUI_Canvas.h.

bool MyGUI::Canvas::isTextureManaged ( ) const

inline

Returns true if we own the texture, otherwise false.

See Also: mManaged

Definition at line 151 of file MyGUI_Canvas.h.

bool MyGUI::Canvas::isTextureSrcSize ( ) const

Checks if the texture has the source (required by user) size, otherwise real texture size are bigger.

Definition at line 223 of file MyGUI_Canvas.cpp.

template<typename Type >

bool MyGUI::Canvas::isType ( ) const

inline

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 41 of file MyGUI_Canvas.h.

virtual bool MyGUI::Canvas::isType ( const std::type_info & _type ) const

inlinevirtual

Compare with selected type

Reimplemented from MyGUI::Widget.

Definition at line 41 of file MyGUI_Canvas.h.

void * MyGUI::Canvas::lock ( TextureUsage _usage = TextureUsage::Write )

Locks hardware pixel buffer.

Definition at line 196 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::resize ( const IntSize & _size )

protected

Calls when resize widget.

Definition at line 86 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::setCoord ( const IntCoord & _value )

virtual

Set widget position and size

Reimplemented from MyGUI::Widget.

Definition at line 121 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::setCoord	(	int	_left,
		int	_top,
		int	_width,
		int	_height
	)

inline

See Widget::setCoord(const IntCoord& _coord)

Reimplemented from MyGUI::Widget.

Definition at line 136 of file MyGUI_Canvas.h.

void MyGUI::Canvas::setResizeMode ( TextureResizeMode _set )

inline

Sets resize mode of texture.

See Also: TextureResizeMode

Definition at line 142 of file MyGUI_Canvas.h.

void MyGUI::Canvas::setSize ( const IntSize & _value )

virtual

Set widget size

Reimplemented from MyGUI::Widget.

Definition at line 114 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::setSize	(	int	_width,
		int	_height
	)

inline

See Widget::setSize(const IntSize& _size)

Reimplemented from MyGUI::Widget.

Definition at line 134 of file MyGUI_Canvas.h.

void MyGUI::Canvas::setTextureManaged ( bool _value )

inline

Sets the texture managed.

Remarks: Be careful with assigning managed status to texture, which wasn't created in Canvas!

See Also: mManaged

Definition at line 157 of file MyGUI_Canvas.h.

void MyGUI::Canvas::shutdownWidgetSkin ( )

protected

Definition at line 219 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::textureInvalidate ( ITexture * _texture )

protectedvirtual

Implements MyGUI::ITextureInvalidateListener.

Definition at line 276 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::unlock ( )

Unlocks hardware pixel buffer.

Definition at line 205 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::updateTexture ( )

Call user delegate update and removes old texture if it isn't original.

Definition at line 128 of file MyGUI_Canvas.cpp.

void MyGUI::Canvas::validate	(	int &	_width,
		int &	_height,
		TextureUsage &	_usage,
		PixelFormat &	_format
	)		const

protected

Update entered parameters according to current texture resize mode(size) and restore (if can) parameters of usage and format from texture.

Definition at line 144 of file MyGUI_Canvas.cpp.

Field Documentation

EventInfo_Canvas MyGUI::Canvas::eventPreTextureChanges

Event : Notify user texture instance will be changed

See Also: requestUpdateCanvas
signature : void method(MyGUI::Canvas* _canvas)

Parameters

_canvas,which will be updated

Definition at line 170 of file MyGUI_Canvas.h.

bool MyGUI::Canvas::mFrameAdvise

protected

For updating once per frame. True state means updating before next frame starts.

Definition at line 240 of file MyGUI_Canvas.h.

std::string MyGUI::Canvas::mGenTexName

protected

Generated texture name.

Definition at line 228 of file MyGUI_Canvas.h.

IntSize MyGUI::Canvas::mReqTexSize

protected

Requested bu user sizes.

Definition at line 225 of file MyGUI_Canvas.h.

uint8* MyGUI::Canvas::mTexData

protected

Saved pointer from last calling lock.

See Also: lock

Definition at line 234 of file MyGUI_Canvas.h.

bool MyGUI::Canvas::mTexManaged

protected

true if we own the texture (can delete it or replace by another instance), otherwise false

Definition at line 237 of file MyGUI_Canvas.h.

TextureResizeMode MyGUI::Canvas::mTexResizeMode

protected

Texture resize mode.

See Also: TextureResizeMode

Definition at line 231 of file MyGUI_Canvas.h.

ITexture* MyGUI::Canvas::mTexture

protected

Current texture.

Definition at line 222 of file MyGUI_Canvas.h.

EventInfo_CanvasEvent MyGUI::Canvas::requestUpdateCanvas

Event : Texture instance was changed (May be caused by resizing texture or lossing device). User have to update all references to new instance of texture.
signature : void method(MyGUI::Canvas* _canvas, MyGUI::Canvas::Event _event)

Parameters

_canvas,which	needs to update
_event

Definition at line 177 of file MyGUI_Canvas.h.

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

Data Structures

Public Types

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation