Click or drag to resize

GUIButton Class

The GUIButton class provides functionality for creating 2D/GUI buttons.
Inheritance Hierarchy

Namespace:  Fusee.Engine.GUI
Assembly:  Fusee.Engine.GUI (in Fusee.Engine.GUI.dll) Version: 0.0.0.0
Syntax
C#
public sealed class GUIButton : GUIElement

The GUIButton type exposes the following members.

Constructors
  NameDescription
Public methodGUIButton(Int32, Int32, Int32, Int32)
Initializes a new instance of the GUIButton class.
Public methodGUIButton(Int32, Int32, Int32, Int32, Int32)
Initializes a new instance of the GUIButton class.
Public methodGUIButton(String, FontMap, Int32, Int32, Int32, Int32)
Initializes a new instance of the GUIButton class.
Public methodGUIButton(String, FontMap, Int32, Int32, Int32, Int32, Int32)
Initializes a new instance of the GUIButton class.
Top
Properties
  NameDescription
Public propertyBorderColor
Gets or sets the color of the border.
Public propertyBorderWidth
Gets or sets the width of the border.
Public propertyButtonColor
Gets or sets the color of the button.
Public propertyGUIMesh
Gets the automatically generated GUI mesh.
(Inherited from GUIElement.)
Public propertyPosX
Gets or sets this element's x-coordinate.
(Inherited from GUIElement.)
Public propertyPosY
Gets or sets this element's y-coordinate.
(Inherited from GUIElement.)
Public propertyTag
Gets or sets the tag.
(Inherited from GUIElement.)
Public propertyText
Gets or sets this element's text.
(Inherited from GUIElement.)
Public propertyTextColor
Gets or sets the color of this element's text.
(Inherited from GUIElement.)
Public propertyTextMesh
Gets the automatically generated text mesh.
(Inherited from GUIElement.)
Public propertyXPivot
Gets or sets this element's pivot's point x-coordinate.
(Inherited from GUIElement.)
Public propertyYPivot
Gets or sets this element's pivot's point y-coordinate.
(Inherited from GUIElement.)
Public propertyZRot
Gets or sets this element's rotation about the z-axis.
(Inherited from GUIElement.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRefresh
Refreshes this element (is called when the properties of this element have been changed).
(Inherited from GUIElement.)
Public methodRender
Renders this element onto a specifie RenderContext.
(Inherited from GUIElement.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventOnGUIButtonDown
Occurs when mouse button is pressed on this button.
Public eventOnGUIButtonEnter
Occurs when the mouse cursor enters this button.
Public eventOnGUIButtonLeave
Occurs when the mouse cursor leaves this button.
Public eventOnGUIButtonUp
Occurs when mouse button is released on this button.
Top
Remarks
A GUIButton doesn't need to have a text on it. It can be modified to be a rectangle with an event listener by making its background color transparent and setting a border width of 1 or greater.
See Also