TriDevs.TriEngine.UI.Label Class Reference

A simple label to display text on the screen. More...

Inheritance diagram for TriDevs.TriEngine.UI.Label:

Collaboration diagram for TriDevs.TriEngine.UI.Label:

Public Member Functions
virtual void	SetFont (Font font)
	Sets the font that this label uses. More...
override void	Update ()
	Updates the object. More...
override void	Draw ()
	Draw the object to screen. More...
Public Member Functions inherited from TriDevs.TriEngine.UI.Control
virtual void	Enable ()
	Enables the control. More...
virtual void	Disable ()
	Disables the control. More...
virtual void	Show ()
	Shows the control. More...
virtual void	Hide ()
	Hides the control. More...

Protected Member Functions
virtual void	UpdateTextObject ()
Protected Member Functions inherited from TriDevs.TriEngine.UI.Control
virtual void	OnClicked ()
virtual void	Draw (Point< int > position)

Properties
override string	Text [get, set]
override Point< int >	Position [get, set]
virtual QFontAlignment	Alignment [get, set]
	Gets or sets the QFontAlignment of this label's text. More...
Properties inherited from TriDevs.TriEngine.UI.Control
virtual bool	Enabled [get, set]
virtual bool	Visible [get, set]
virtual Color	Color [get, set]
virtual Point< int >	Position [get, set]
virtual Point< int >	Size [get, set]
virtual Rectangle	Rectangle [get, set]
virtual string	Text [get, set]
Properties inherited from TriDevs.TriEngine.UI.IControl
bool	Enabled [get, set]
	Gets or sets a value indicating whether this control can be interacted with. More...
bool	Visible [get, set]
	Gets or sets a value indicating whether this control should be drawn to the screen. More...
Color	Color [get, set]
	The color of this control. More...
Point< int >	Position [get, set]
	The position of this control, in pixel coordinates. More...
Point< int >	Size [get, set]
	Gets or sets the size of this control, in pixels. More...
Rectangle	Rectangle [get, set]
	Gets the rectangular area on the screen that this control is occupying. More...
string	Text [get, set]
	Gets or sets the text associated with this control. More...

Additional Inherited Members
Events inherited from TriDevs.TriEngine.UI.Control
ControlClickedEventHandler	Clicked
	Raised when this control is clicked on by the user. More...

Detailed Description

A simple label to display text on the screen.

Member Function Documentation

override void TriDevs.TriEngine.UI.Label.Draw ( )

virtual

Draw the object to screen.

Reimplemented from TriDevs.TriEngine.UI.Control.

        {
            base.Draw(_drawPosition);

            if (_textObject == null)
                return;

            _textObject.Draw();
        }

virtual void TriDevs.TriEngine.UI.Label.SetFont ( Font  font )

virtual

Sets the font that this label uses.

Parameters

font	The new font instance to use.

        {
            _font = font;
            UpdateTextObject();
        }

override void TriDevs.TriEngine.UI.Label.Update ( )

virtual

Updates the object.

Reimplemented from TriDevs.TriEngine.UI.Control.

        {
            // Override update logic to translate mouse click
            // positions when label is aligned in a certain way

            if (!Services.Input.MouseReleased(MouseButton.Left))
                return;

            var mousePos = Services.Input.MousePosition;
            if ((mousePos.X >= _drawPosition.X && mousePos.X <= (_drawPosition.X + Rectangle.Width))
                && (mousePos.Y >= _drawPosition.Y && mousePos.Y <= (_drawPosition.Y + Rectangle.Height)))
                OnClicked();
        }

virtual void TriDevs.TriEngine.UI.Label.UpdateTextObject ( )

protectedvirtual

        {
            if (_font == null)
                return;

            if (_textObject == null)
            {
                _textObject = new TextObject(_text, _font, Position, Alignment);
            }
            else
            {
                _textObject.Text = Text;
                _textObject.Font = _font;
                _textObject.Position = Position;
                _textObject.Alignment = Alignment;
            }

            Size = new Point<int>(_textObject.Bounds.Width, _textObject.Bounds.Height);

            switch (Alignment)
            {
                case QFontAlignment.Centre:
                    _drawPosition = new Point<int>(Position.X - Size.X / 2, Position.Y);
                    break;
                case QFontAlignment.Right:
                    _drawPosition = new Point<int>(Position.X - Size.X, Position.Y);
                    break;
                default:
                    _drawPosition = Position;
                    break;
            }
        }

Property Documentation

virtual QFontAlignment TriDevs.TriEngine.UI.Label.Alignment

getset

Gets or sets the QFontAlignment of this label's text.

override Point<int> TriDevs.TriEngine.UI.Label.Position

getset

override string TriDevs.TriEngine.UI.Label.Text

getset

---

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

• TriDevs.TriEngine/UI/Label.cs