FalcoEngine.UIElement Class Reference

Inheritance diagram for FalcoEngine.UIElement:

Public Types
enum	CanvasHorizontalAlignment { Left , Center , Right }
	CanvasHorizontalAlignment enum More...
enum	CanvasVerticalAlignment { Top , Middle , Bottom }
	CanvasVerticalAlignment enum More...

Public Member Functions
delegate void	MouseButtonEvent (UIElement sender, int button, Vector2 cursorPosition)
delegate void	MouseMoveEvent (UIElement sender, Vector2 cursorPosition)

Properties
CanvasHorizontalAlignment	horizontalAlignment [getset]
	Get or set horizontal alignment of this element More...
CanvasVerticalAlignment	verticalAlignment [getset]
	Get or set vertical alignment of this element More...
Color	color [getset]
	Get or set the main color of this element More...
Vector2	anchor [getset]
	Get or set the anchor of this element (pivot point) More...
Vector2	size [getset]
	Get or set the size of this element (width and height) More...
bool	hovered [get]
	Returns if this element is hovered by mouse cursor More...
Canvas	canvas [get]
	Returns a canvas of this element More...
Vector3	position [getset]
Rect	rect [get]
object	userData [getset]
	Get or set the user data More...
Properties inherited from FalcoEngine.Component
bool	enabled [getset]
	Enable or disable this component More...
GameObject	gameObject [get]
	Get game object at which this component is attached More...
bool	isUiComponent [get]
	Returns if this component is derived from UIElement (or this is a canvas) or not More...

Events
MouseButtonEvent	onMouseDown
MouseButtonEvent	onMouseUp
MouseMoveEvent	onMouseMove
MouseMoveEvent	onMouseEnter
MouseMoveEvent	onMouseExit

Additional Inherited Members
Protected Member Functions inherited from FalcoEngine.Component
	Component ()

Detailed Description

Definition at line 7 of file UIElement.cs.

Member Enumeration Documentation

CanvasHorizontalAlignment

enum FalcoEngine.UIElement.CanvasHorizontalAlignment

CanvasHorizontalAlignment enum

Enumerator
Left
Center
Right

Definition at line 17 of file UIElement.cs.

CanvasVerticalAlignment

enum FalcoEngine.UIElement.CanvasVerticalAlignment

CanvasVerticalAlignment enum

Enumerator
Top
Middle
Bottom

Definition at line 22 of file UIElement.cs.

Member Function Documentation

MouseButtonEvent()

delegate void FalcoEngine.UIElement.MouseButtonEvent	(	UIElement	sender,
		int	button,
		Vector2	cursorPosition
	)

MouseMoveEvent()

delegate void FalcoEngine.UIElement.MouseMoveEvent	(	UIElement	sender,
		Vector2	cursorPosition
	)

Property Documentation

anchor

Vector2 FalcoEngine.UIElement.anchor

getset

Get or set the anchor of this element (pivot point)

Definition at line 81 of file UIElement.cs.

canvas

Canvas FalcoEngine.UIElement.canvas

get

Returns a canvas of this element

Definition at line 118 of file UIElement.cs.

color

Color FalcoEngine.UIElement.color

getset

Get or set the main color of this element

Definition at line 65 of file UIElement.cs.

horizontalAlignment

CanvasHorizontalAlignment FalcoEngine.UIElement.horizontalAlignment

getset

Get or set horizontal alignment of this element

Definition at line 35 of file UIElement.cs.

hovered

bool FalcoEngine.UIElement.hovered

get

Returns if this element is hovered by mouse cursor

Definition at line 113 of file UIElement.cs.

position

Vector3 FalcoEngine.UIElement.position

getset

Definition at line 120 of file UIElement.cs.

rect

Rect FalcoEngine.UIElement.rect

get

Definition at line 133 of file UIElement.cs.

size

Vector2 FalcoEngine.UIElement.size

getset

Get or set the size of this element (width and height)

Definition at line 97 of file UIElement.cs.

userData

object FalcoEngine.UIElement.userData

getset

Get or set the user data

Definition at line 145 of file UIElement.cs.

verticalAlignment

CanvasVerticalAlignment FalcoEngine.UIElement.verticalAlignment

getset

Get or set vertical alignment of this element

Definition at line 50 of file UIElement.cs.

Event Documentation

onMouseDown

MouseButtonEvent FalcoEngine.UIElement.onMouseDown

Definition at line 26 of file UIElement.cs.

onMouseEnter

MouseMoveEvent FalcoEngine.UIElement.onMouseEnter

Definition at line 29 of file UIElement.cs.

onMouseExit

MouseMoveEvent FalcoEngine.UIElement.onMouseExit

Definition at line 30 of file UIElement.cs.

onMouseMove

MouseMoveEvent FalcoEngine.UIElement.onMouseMove

Definition at line 28 of file UIElement.cs.

onMouseUp

MouseButtonEvent FalcoEngine.UIElement.onMouseUp

Definition at line 27 of file UIElement.cs.

---

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

• API/Components/UI/UIElement.cs