An UI widget. More...

#include <UiWidget.h>

Inheritance diagram for UiWidget:

Collaboration diagram for UiWidget:

Public Types
enum	Align { LEFT , RIGHT , CENTER }
	Horizontal alignment of the widget. More...

enum	VerticalAlign { TOP , BOTTOM , MIDDLE }
	Vertical alignment of the widget. More...

Public Member Functions
	UiWidget (const Ogre::String &name)
	Constructor. More...

	UiWidget (const Ogre::String &name, const Ogre::String &path_name, UiWidget *parent)
	Constructor. More...

virtual	~UiWidget ()
	Destructor. More...

void	Initialise ()
	Initializes the widget. More...

virtual void	Update ()
	Updates the widget status. More...

void	OnResize ()
	Handles resizing events. More...

virtual void	Render ()
	Renders the widget and it's children. More...

void	SetVisible (const bool visible)
	Toggles the widget visibility. More...

bool	IsVisible () const
	Checks the widget visibility. More...

const Ogre::String &	GetName () const
	Retrieves the widget name. More...

void	AddChild (UiWidget *widget)
	Add other widget as the widget's child. More...

UiWidget *	GetChild (const Ogre::String &name)
	Retrieves a children by name. More...

UiWidget *	GetChild (const unsigned int id)
	Retrieves a children by ID. More...

unsigned int	GetNumberOfChildren ()
	Counts the widget's children. More...

void	RemoveAllChildren ()
	Removes all children widgets. More...

void	AddAnimation (UiAnimation *animation)
	Adds an animation to the widget. More...

const Ogre::String &	GetCurrentAnimationName () const
	Retrieves the current animation name. More...

UiAnimation::State	GetAnimationState () const
	Retrieves the current animation state. More...

void	PlayAnimation (const Ogre::String &animation, UiAnimation::State state, const float start, const float end)
	Plays an animation. More...

void	ScriptPlayAnimation (const char *name)
	Plays an animation. More...

void	ScriptPlayAnimationStop (const char *name)
	Plays an animation. More...

void	ScriptPlayAnimation (const char *name, const float start, const float end)

void	ScriptPlayAnimationStop (const char *name, const float start, const float end)
	Plays an animation. More...

void	ScriptSetDefaultAnimation (const char *animation)
	Sets the default animation for the widget. More...

int	ScriptAnimationSync ()
	Synchronizes an animation. More...

void	SetUpdateTransformation ()
	Marks the widget as transformed. More...

virtual void	UpdateTransformation ()
	Recalculates the widget geometry. More...

void	SetAlign (const UiWidget::Align align)
	Sets the widget horizontal alignment. More...

void	SetVerticalAlign (const UiWidget::VerticalAlign valign)
	Sets the widget vertical alignment. More...

float	GetFinalZ () const
	Retrieves the final Z-index of the widget after a transformation. More...

Ogre::Vector2	GetFinalOrigin () const
	Retrieves the coordinates of the widget after a transformation. More...

Ogre::Vector2	GetFinalTranslate () const
	Retrieves the final translation of the widget after a transformation. More...

Ogre::Vector2	GetFinalSize () const
	Retrieves the final size of the widget after a transformation. More...

Ogre::Vector2	GetFinalScale () const
	Retrieves the final scale of the widget after a transformation. More...

Ogre::Vector4	GetFinalScissor (bool &scissor) const
	Retrieves the final scissor of the widget after a transformation. More...

float	GetFinalRotation () const
	Retrieves the final rotation of the widget. More...

void	SetOriginX (const float percent, const float x)
	Sets the X coordinate origin for the widget. More...

void	SetOriginY (const float percent, const float y)
	Sets the Y coordinate origin for the widget. More...

void	SetX (const float percent, const float x)
	Sets the X coordinate for the widget. More...

void	GetX (float &percent, float &x)
	Retrieves the X coordinate for the widget. More...

void	SetY (const float percent, const float y)
	Sets the Y coordinate for the widget. More...

void	GetY (float &percent, float &y)
	Retrieves the Y coordinate for the widget. More...

void	SetZ (const float z)
	Sets the widget Z-index. More...

void	SetWidth (const float percent, const float width)
	Sets the width the widget. More...

void	GetWidth (float &percent, float &width)
	Retrieves the width of the widget. More...

void	SetHeight (const float percent, const float height)
	Sets the height the widget. More...

void	GetHeight (float &percent, float &height)
	Retrieves the height of the widget. More...

void	SetScale (const Ogre::Vector2 &scale)
	Sets the widget scale. More...

void	SetRotation (const float degree)
	Sets the widget rotation. More...

void	SetScissorArea (const float percent_x1, const float x1, const float percent_y1, const float y1, const float percent_x2, const float x2, const float percent_y2, const float y2)
	Sets the widget scissor area. More...

void	SetGlobalScissor (const bool global)

void	SetColour (const float r, const float g, const float b)
	Sets the widget colour. More...

void	SetColours (const float r1, const float g1, const float b1, const float r2, const float g2, const float b2, const float r3, const float g3, const float b3, const float r4, const float g4, const float b4)
	Sets the widget colour. More...

void	SetAlpha (const float a)
	Sets the widget transparency. More...

virtual void	SetText (const char *text)
	Sets the text of the widget. More...

virtual void	SetImage (const char *image)
	Sets the text of the widget. More...

float	ScriptGetWidth ()
	Retrieves the absolute width of the widget. More...

void	ScriptSetWidth (float width)
	Sets the absolute width of the widget. More...

float	ScriptGetHeight ()
	Retrieves the absolute height of the widget. More...

void	ScriptSetHeight (float height)
	Sets the absolute height of the widget. More...

Protected Attributes
Ogre::String	name_
	The widget name. More...

Ogre::String	path_name_

UiWidget *	parent_
	The parent widget. More...

std::vector< UiWidget * >	children_
	The list of children widgets. More...

float	screen_width_
	Width, in game screen units. More...

float	screen_height_
	Height, in game screen units. More...

bool	visible_
	Indicates if the widget is visible. More...

Ogre::ColourValue	colour_1_
	Top-left corner colour. More...

Ogre::ColourValue	colour_2_
	Top-right corner colour. More...

Ogre::ColourValue	colour_3_
	Bottom-right corner colour. More...

Ogre::ColourValue	colour_4_
	Bottom-left corner colour. More...

Align	align_
	The vertical alignment. More...

VerticalAlign	vertical_align_
	The evrtical alignment. More...

bool	update_transformation_
	Indicates if the widget is marked as transformed. More...

Ogre::Vector2	final_origin_
	Final origin point after a transformation. More...

Ogre::Vector2	final_translate_
	Final translation after a transformation. More...

float	final_z_
	Final Z-index after a transformation. More...

Ogre::Vector2	final_size_
	Final size after a transformation. More...

Ogre::Vector2	final_scale_
	Final scale after a transformation. More...

float	final_rotation_
	Final rotation after a transformation. More...

float	origin_x_percent_

float	origin_x_
	The origin X coordinate. More...

float	origin_y_percent_

float	origin_y_
	The origin Y coordinate. More...

float	x_percent_

float	x_
	The widget X coordinate. More...

float	y_percent_

float	y_
	The widget Y coordinate. More...

float	z_
	The widget Z coordinate. More...

float	width_percent_

float	width_
	The widget width. More...

float	height_percent_

float	height_
	The widget height. More...

Ogre::Vector2	scale_
	The widget scale. More...

float	rotation_
	The widget rotation. More...

bool	scissor_

bool	local_scissor_

bool	global_scissor_

int	scissor_top_

float	scissor_x_percent_top_

float	scissor_x_top_

int	scissor_bottom_

float	scissor_x_percent_bottom_

float	scissor_x_bottom_

int	scissor_left_

float	scissor_y_percent_left_

float	scissor_y_left_

int	scissor_right_

float	scissor_y_percent_right_

float	scissor_y_right_

UiAnimation *	animation_current_
	The current animation. More...

std::vector< ScriptId >	animation_sync_
	The animation stack. More...

UiAnimation::State	animation_state_
	The current animation state. More...

Ogre::String	animation_default_
	The name of the default animation. More...

float	animation_end_time_
	Time for the current animation to end. More...

std::vector< UiAnimation * >	animations_
	The list of animations. More...

Private Member Functions
	UiWidget ()
	Constructor. More...

Detailed Description

An UI widget.

Member Enumeration Documentation

◆ Align

enum UiWidget::Align

Horizontal alignment of the widget.

Enumerator
LEFT	Left alignment.
RIGHT	Right alignment.
CENTER	Centered horizontally.

◆ VerticalAlign

enum UiWidget::VerticalAlign

Vertical alignment of the widget.

Enumerator
TOP	Top alignment.
BOTTOM	Bottom alignment.
MIDDLE	Centered vertically.

Constructor & Destructor Documentation

◆ UiWidget() [1/3]

UiWidget::UiWidget ( const Ogre::String & name )

Constructor.

Parameters

[in] name Name for the widget.

◆ UiWidget() [2/3]

UiWidget::UiWidget	(	const Ogre::String &	name,
		const Ogre::String &	path_name,
		UiWidget *	parent
	)

Constructor.

Parameters

[in]	name	Name for the widget.
[in]	path_name

Todo:: Understand and document.

Parameters

[in] parent Widget to be made parent of the new one.

◆ ~UiWidget()

UiWidget::~UiWidget ( )

virtual

Destructor.

◆ UiWidget() [3/3]

UiWidget::UiWidget ( )

private

Constructor.

Member Function Documentation

◆ AddAnimation()

void UiWidget::AddAnimation ( UiAnimation * animation )

Adds an animation to the widget.

Parameters

[in] animation The animation to add.

◆ AddChild()

void UiWidget::AddChild ( UiWidget * widget )

Add other widget as the widget's child.

Parameters

[in] widget Widget to be made children of this one.

◆ GetAnimationState()

UiAnimation::State UiWidget::GetAnimationState ( ) const

Retrieves the current animation state.

Returns: The current animation state.

◆ GetChild() [1/2]

UiWidget * UiWidget::GetChild ( const Ogre::String & name )

Retrieves a children by name.

Parameters

[in] name Name of the children widget to retrieve.

Returns: The children widget by the specified name. NULL if the widgets has no direct children by that name.

◆ GetChild() [2/2]

UiWidget * UiWidget::GetChild ( const unsigned int id )

Retrieves a children by ID.

Parameters

[in] id ID of the children widget to retrieve.

Returns: The children widget by the specified name. NULL if the widgets has no direct children by that ID.

◆ GetCurrentAnimationName()

const Ogre::String & UiWidget::GetCurrentAnimationName ( ) const

Retrieves the current animation name.

Returns: The current animation name. A blankstring if there is no animation.

◆ GetFinalOrigin()

Ogre::Vector2 UiWidget::GetFinalOrigin ( ) const

Retrieves the coordinates of the widget after a transformation.

Returns: The final coordinates.

◆ GetFinalRotation()

float UiWidget::GetFinalRotation ( ) const

Retrieves the final rotation of the widget.

Returns: The final orientation.

◆ GetFinalScale()

Ogre::Vector2 UiWidget::GetFinalScale ( ) const

Retrieves the final scale of the widget after a transformation.

Returns: The final scale.

◆ GetFinalScissor()

Ogre::Vector4 UiWidget::GetFinalScissor ( bool & scissor ) const

Retrieves the final scissor of the widget after a transformation.

Returns: The final scissor.

Todo:: What is a scissor?

◆ GetFinalSize()

Ogre::Vector2 UiWidget::GetFinalSize ( ) const

Retrieves the final size of the widget after a transformation.

Returns: The final size.

◆ GetFinalTranslate()

Ogre::Vector2 UiWidget::GetFinalTranslate ( ) const

Retrieves the final translation of the widget after a transformation.

Returns: The final translation.

Todo:: What is a translation here? Just a movement?

◆ GetFinalZ()

float UiWidget::GetFinalZ ( ) const

Retrieves the final Z-index of the widget after a transformation.

Returns: The final Z-index.

◆ GetHeight()

void UiWidget::GetHeight	(	float &	percent,
		float &	height
	)

Retrieves the height of the widget.

Parameters

[out] percent

Todo:

Parameters

[out] height The height will be loaded here.

◆ GetName()

const Ogre::String & UiWidget::GetName ( ) const

Retrieves the widget name.

Returns: The widget name.

◆ GetNumberOfChildren()

unsigned int UiWidget::GetNumberOfChildren ( )

Counts the widget's children.

Returns: The number of direct children.

◆ GetWidth()

void UiWidget::GetWidth	(	float &	percent,
		float &	width
	)

Retrieves the width of the widget.

Parameters

[out] percent

Todo:

Parameters

[out] width The width will be loaded here.

◆ GetX()

void UiWidget::GetX	(	float &	percent,
		float &	x
	)

Retrieves the X coordinate for the widget.

Parameters

[out] percent

Todo:

Parameters

[out] x The X coordinate will be loaded here.

◆ GetY()

void UiWidget::GetY	(	float &	percent,
		float &	y
	)

Retrieves the Y coordinate for the widget.

Parameters

[out] percent

Todo:

Parameters

[out] y The Y coordinate will be loaded here.

◆ Initialise()

void UiWidget::Initialise ( )

Initializes the widget.

It sets the widget geometry.

◆ IsVisible()

bool UiWidget::IsVisible ( ) const

Checks the widget visibility.

Returns: True if the widget is visible, false if it is invisible.

◆ OnResize()

void UiWidget::OnResize ( )

Handles resizing events.

Recalculates the widget geometry and calls OnResize for all the widget children.

◆ PlayAnimation()

void UiWidget::PlayAnimation	(	const Ogre::String &	animation,
		UiAnimation::State	state,
		const float	start,
		const float	end
	)

Plays an animation.

Parameters

[in]	animation	Animation to play.
[in]	state	Initial animation state.
[in]	start	Seconds at which to start the animation.
[in]	end	Seconds at which to end the animation. -1 to play it in full.

◆ RemoveAllChildren()

void UiWidget::RemoveAllChildren ( )

Removes all children widgets.

◆ Render()

void UiWidget::Render ( )

virtual

Renders the widget and it's children.

Reimplemented in UiSprite, and UiTextArea.

◆ ScriptAnimationSync()

int UiWidget::ScriptAnimationSync ( )

Synchronizes an animation.

Returns: Always -1.

Todo:: Understand and document better.

◆ ScriptGetHeight()

float UiWidget::ScriptGetHeight ( )

Retrieves the absolute height of the widget.

Doesn't consider percentages.

Returns: Absolute height.

◆ ScriptGetWidth()

float UiWidget::ScriptGetWidth ( )

Retrieves the absolute width of the widget.

Doesn't consider percentages.

Returns: Absolute width.

◆ ScriptPlayAnimation() [1/2]

void UiWidget::ScriptPlayAnimation ( const char * name )

Plays an animation.

The animation will be played from the start for it's full length.

Parameters

[in] name The name of the animation to play.

Todo:: It uses the parameter UiAnimation::DEFAULT. What does it do? Does it play the animation in a loop, or uses a default value of the specific animation.

◆ ScriptPlayAnimation() [2/2]

void UiWidget::ScriptPlayAnimation	(	const char *	name,
		const float	start,
		const float	end
	)

Parameters

[in]	name	Name of the animation to play.
[in]	start	Seconds at which to start the animation.
[in]	end	Seconds at which to end the animation. -1 to play it in full.

Todo:: It uses the parameter UiAnimation::DEFAULT. Whats does it do? Does it play the animation in a loop, or uses a default value of the specific animation.

◆ ScriptPlayAnimationStop() [1/2]

void UiWidget::ScriptPlayAnimationStop ( const char * name )

Plays an animation.

The animation will be played from the start for it's full length, only once.

Parameters

[in] name The name of the animation to play.

◆ ScriptPlayAnimationStop() [2/2]

void UiWidget::ScriptPlayAnimationStop	(	const char *	name,
		const float	start,
		const float	end
	)

Plays an animation.

The animation will be played only once.

Parameters

[in]	name	The name of the animation to play.
[in]	start	Seconds at which to start the animation.
[in]	end	Seconds at which to end the animation. -1 to play it in full.

◆ ScriptSetDefaultAnimation()

void UiWidget::ScriptSetDefaultAnimation ( const char * animation )

Sets the default animation for the widget.

Parameters

[in] animation The name of the default animation.

◆ ScriptSetHeight()

void UiWidget::ScriptSetHeight ( float height )

Sets the absolute height of the widget.

Doesn't modify percentages.

Parameters

[in] height Absolute height.

◆ ScriptSetWidth()

void UiWidget::ScriptSetWidth ( float width )

Sets the absolute width of the widget.

Doesn't modify percentages.

Parameters

[in] width Absolute width.

◆ SetAlign()

void UiWidget::SetAlign ( const UiWidget::Align align )

Sets the widget horizontal alignment.

Parameters

[in] align Widget alignment.

◆ SetAlpha()

void UiWidget::SetAlpha ( const float a )

Sets the widget transparency.

Parameters

[in] a Alpha value (0 opaque, 255 fully transparent).

◆ SetColour()

void UiWidget::SetColour	(	const float	r,
		const float	g,
		const float	b
	)

Sets the widget colour.

Parameters

[in]	r	Colour red component (0-255).
[in]	g	Colour green component (0-255).
[in]	b	Colour blue component (0-255).

◆ SetColours()

void UiWidget::SetColours	(	const float	r1,
		const float	g1,
		const float	b1,
		const float	r2,
		const float	g2,
		const float	b2,
		const float	r3,
		const float	g3,
		const float	b3,
		const float	r4,
		const float	g4,
		const float	b4
	)

Sets the widget colour.

It set the same colours for each corner, and blends it in the interior.

Parameters

[in]	r1	Colour red component for the top-left corner (0-255).
[in]	g1	Colour green component for the top-left corner (0-255).
[in]	b1	Colour blue component for the top-left corner (0-255).
[in]	r2	Colour red component for the top-right corner (0-255).
[in]	g2	Colour green component for the top-right corner (0-255).
[in]	b2	Colour blue component for the top-right corner (0-255).
[in]	r3	Colour red component for the bottom-right corner (0-255).
[in]	g3	Colour green component for the bottom-right corner (0-255).
[in]	b3	Colour blue component for the bottom-right corner (0-255).
[in]	r4	Colour red component for the bottom-left corner (0-255).
[in]	g4	Colour green component for the bottom-left corner (0-255).
[in]	b4	Colour blue component for the bottom-left corner (0-255).

◆ SetGlobalScissor()

void UiWidget::SetGlobalScissor ( const bool global )

Todo:: Understand and document.

Parameters

[in] global

Todo:: Understand and document.

◆ SetHeight()

void UiWidget::SetHeight	(	const float	percent,
		const float	height
	)

Sets the height the widget.

Parameters

[in] percent

Todo:

Parameters

[in] height The widget height.

◆ SetImage()

void UiWidget::SetImage ( const char * image )

virtual

Sets the text of the widget.

If the widget doesn't have an image, it won't do anything.

Parameters

[in] image Path to the image.

Reimplemented in UiSprite.

◆ SetOriginX()

void UiWidget::SetOriginX	(	const float	percent,
		const float	x
	)

Sets the X coordinate origin for the widget.

Parameters

[in] percent

Todo:

Parameters

[in] x Origin X coordinate.

◆ SetOriginY()

void UiWidget::SetOriginY	(	const float	percent,
		const float	y
	)

Sets the Y coordinate origin for the widget.

Parameters

[in] percent

Todo:

Parameters

[in] y Origin Y coordinate.

◆ SetRotation()

void UiWidget::SetRotation ( const float degree )

Sets the widget rotation.

Parameters

[in] degree The new widget rotation.

◆ SetScale()

void UiWidget::SetScale ( const Ogre::Vector2 & scale )

Sets the widget scale.

Parameters

[in] scale The new widget scale.

◆ SetScissorArea()

void UiWidget::SetScissorArea	(	const float	percent_x1,
		const float	x1,
		const float	percent_y1,
		const float	y1,
		const float	percent_x2,
		const float	x2,
		const float	percent_y2,
		const float	y2
	)

Sets the widget scissor area.

Parameters

[in] percent_x1

Todo:: Understand and document.

Parameters

[in] x1

Todo:: Understand and document.

Parameters

[in] percent_y1

Todo:: Understand and document.

Parameters

[in] y1

Todo:: Understand and document.

Parameters

[in] percent_x2

Todo:: Understand and document.

Parameters

[in] x2

Todo:: Understand and document.

Parameters

[in] percent_y2

Todo:: Understand and document.

Parameters

[in] y2

Todo:: Understand and document.

◆ SetText()

void UiWidget::SetText ( const char * text )

virtual

Sets the text of the widget.

If the widget doesn't have text, it won't do anything.

Parameters

[in] text The text to set.

Reimplemented in UiTextArea.

◆ SetUpdateTransformation()

void UiWidget::SetUpdateTransformation ( )

Marks the widget as transformed.

It means that it's geometry must be updated in the next pass. It also marks the direct children as transformed.

◆ SetVerticalAlign()

void UiWidget::SetVerticalAlign ( const UiWidget::VerticalAlign valign )

Sets the widget vertical alignment.

Parameters

[in] valign Widget alignment.

◆ SetVisible()

void UiWidget::SetVisible ( const bool visible )

Toggles the widget visibility.

Parameters

[in] visible True to make the widget visible, false to make it invisible.

◆ SetWidth()

void UiWidget::SetWidth	(	const float	percent,
		const float	width
	)

Sets the width the widget.

Parameters

[in] percent

Todo:

Parameters

[in] width The widget width.

◆ SetX()

void UiWidget::SetX	(	const float	percent,
		const float	x
	)

Sets the X coordinate for the widget.

Parameters

[in] percent

Todo:

Parameters

[in] x The X coordinate.

◆ SetY()

void UiWidget::SetY	(	const float	percent,
		const float	y
	)

Sets the Y coordinate for the widget.

Parameters

[in] percent

Todo:

Parameters

[in] y The Y coordinate.

◆ SetZ()

void UiWidget::SetZ ( const float z )

Sets the widget Z-index.

Parameters

[in] z The Z-index.

◆ Update()

void UiWidget::Update ( )

virtual

Updates the widget status.

Reimplemented in UiSprite, and UiTextArea.

◆ UpdateTransformation()

void UiWidget::UpdateTransformation ( )

virtual

Recalculates the widget geometry.

Reimplemented in UiSprite, and UiTextArea.

Member Data Documentation

◆ align_

Align UiWidget::align_

protected

The vertical alignment.

◆ animation_current_

UiAnimation* UiWidget::animation_current_

protected

The current animation.

◆ animation_default_

Ogre::String UiWidget::animation_default_

protected

The name of the default animation.

◆ animation_end_time_

float UiWidget::animation_end_time_

protected

Time for the current animation to end.

◆ animation_state_

UiAnimation::State UiWidget::animation_state_

protected

The current animation state.

◆ animation_sync_

std::vector<ScriptId> UiWidget::animation_sync_

protected

The animation stack.

Todo:: Understand and document better.

◆ animations_

std::vector<UiAnimation*> UiWidget::animations_

protected

The list of animations.

◆ children_

std::vector<UiWidget*> UiWidget::children_

protected

The list of children widgets.

◆ colour_1_

Ogre::ColourValue UiWidget::colour_1_

protected

Top-left corner colour.

◆ colour_2_

Ogre::ColourValue UiWidget::colour_2_

protected

Top-right corner colour.

◆ colour_3_

Ogre::ColourValue UiWidget::colour_3_

protected

Bottom-right corner colour.

◆ colour_4_

Ogre::ColourValue UiWidget::colour_4_

protected

Bottom-left corner colour.

◆ final_origin_

Ogre::Vector2 UiWidget::final_origin_

protected

Final origin point after a transformation.

◆ final_rotation_

float UiWidget::final_rotation_

protected

Final rotation after a transformation.

◆ final_scale_

Ogre::Vector2 UiWidget::final_scale_

protected

Final scale after a transformation.

◆ final_size_

Ogre::Vector2 UiWidget::final_size_

protected

Final size after a transformation.

◆ final_translate_

Ogre::Vector2 UiWidget::final_translate_

protected

Final translation after a transformation.

Todo:: Understand and document.

◆ final_z_

float UiWidget::final_z_

protected

Final Z-index after a transformation.

◆ global_scissor_

bool UiWidget::global_scissor_

protected

Todo:: Understand and document.

◆ height_

float UiWidget::height_

protected

The widget height.

◆ height_percent_

float UiWidget::height_percent_

protected

Todo:: Understand and document.

◆ local_scissor_

bool UiWidget::local_scissor_

protected

Todo:: Understand and document.

◆ name_

Ogre::String UiWidget::name_

protected

The widget name.

◆ origin_x_

float UiWidget::origin_x_

protected

The origin X coordinate.

◆ origin_x_percent_

float UiWidget::origin_x_percent_

protected

Todo:: Understand and document.

◆ origin_y_

float UiWidget::origin_y_

protected

The origin Y coordinate.

◆ origin_y_percent_

float UiWidget::origin_y_percent_

protected

Todo:: Understand and document.

◆ parent_

UiWidget* UiWidget::parent_

protected

The parent widget.

◆ path_name_

Ogre::String UiWidget::path_name_

protected

Todo:: Understand and document.

◆ rotation_

float UiWidget::rotation_

protected

The widget rotation.

◆ scale_

Ogre::Vector2 UiWidget::scale_

protected

The widget scale.

◆ scissor_

bool UiWidget::scissor_

protected

Todo:: Understand and document.

◆ scissor_bottom_

int UiWidget::scissor_bottom_

protected

Todo:: Understand and document.

◆ scissor_left_

int UiWidget::scissor_left_

protected

Todo:: Understand and document.

◆ scissor_right_

int UiWidget::scissor_right_

protected

Todo:: Understand and document.

◆ scissor_top_

int UiWidget::scissor_top_

protected

Todo:: Understand and document.

◆ scissor_x_bottom_

float UiWidget::scissor_x_bottom_

protected

Todo:: Understand and document.

◆ scissor_x_percent_bottom_

float UiWidget::scissor_x_percent_bottom_

protected

Todo:: Understand and document.

◆ scissor_x_percent_top_

float UiWidget::scissor_x_percent_top_

protected

Todo:: Understand and document.

◆ scissor_x_top_

float UiWidget::scissor_x_top_

protected

Todo:: Understand and document.

◆ scissor_y_left_

float UiWidget::scissor_y_left_

protected

Todo:: Understand and document.

◆ scissor_y_percent_left_

float UiWidget::scissor_y_percent_left_

protected

Todo:: Understand and document.

◆ scissor_y_percent_right_

float UiWidget::scissor_y_percent_right_

protected

Todo:: Understand and document.

◆ scissor_y_right_

float UiWidget::scissor_y_right_

protected

Todo:: Understand and document.

◆ screen_height_

float UiWidget::screen_height_

protected

Height, in game screen units.

Todo:: Understand and document.

◆ screen_width_

float UiWidget::screen_width_

protected

Width, in game screen units.

Todo:: Understand and document.

◆ update_transformation_

bool UiWidget::update_transformation_

protected

Indicates if the widget is marked as transformed.

◆ vertical_align_

VerticalAlign UiWidget::vertical_align_

protected

The evrtical alignment.

◆ visible_

bool UiWidget::visible_

protected

Indicates if the widget is visible.

◆ width_

float UiWidget::width_

protected

The widget width.

◆ width_percent_

float UiWidget::width_percent_

protected

Todo:: Understand and document.

◆ x_

float UiWidget::x_

protected

The widget X coordinate.

◆ x_percent_

float UiWidget::x_percent_

protected

Todo:: Understand and document.

◆ y_

float UiWidget::y_

protected

The widget Y coordinate.

◆ y_percent_

float UiWidget::y_percent_

protected

Todo:: Understand and document.

◆ z_

float UiWidget::z_

protected

The widget Z coordinate.

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

src/core/UiWidget.h
src/core/UiWidget.cpp

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ Align

◆ VerticalAlign

Constructor & Destructor Documentation

◆ UiWidget() [1/3]

◆ UiWidget() [2/3]

◆ ~UiWidget()

◆ UiWidget() [3/3]

Member Function Documentation

◆ AddAnimation()

◆ AddChild()

◆ GetAnimationState()

◆ GetChild() [1/2]

◆ GetChild() [2/2]

◆ GetCurrentAnimationName()

◆ GetFinalOrigin()

◆ GetFinalRotation()

◆ GetFinalScale()

◆ GetFinalScissor()

◆ GetFinalSize()

◆ GetFinalTranslate()

◆ GetFinalZ()

◆ GetHeight()

◆ GetName()

◆ GetNumberOfChildren()

◆ GetWidth()

◆ GetX()

◆ GetY()

◆ Initialise()

◆ IsVisible()

◆ OnResize()

◆ PlayAnimation()

◆ RemoveAllChildren()

◆ Render()

◆ ScriptAnimationSync()

◆ ScriptGetHeight()

◆ ScriptGetWidth()

◆ ScriptPlayAnimation() [1/2]

◆ ScriptPlayAnimation() [2/2]

◆ ScriptPlayAnimationStop() [1/2]

◆ ScriptPlayAnimationStop() [2/2]

◆ ScriptSetDefaultAnimation()

◆ ScriptSetHeight()

◆ ScriptSetWidth()

◆ SetAlign()

◆ SetAlpha()

◆ SetColour()

◆ SetColours()

◆ SetGlobalScissor()

◆ SetHeight()

◆ SetImage()

◆ SetOriginX()

◆ SetOriginY()

◆ SetRotation()

◆ SetScale()

◆ SetScissorArea()

◆ SetText()

◆ SetUpdateTransformation()

◆ SetVerticalAlign()

◆ SetVisible()

◆ SetWidth()

◆ SetX()

◆ SetY()

◆ SetZ()

◆ Update()

◆ UpdateTransformation()

Member Data Documentation

◆ align_

◆ animation_current_

◆ animation_default_

◆ animation_end_time_

◆ animation_state_

◆ animation_sync_

◆ animations_

◆ children_