LGUI2:LS1:lgui2radialitem

From Lavish Software Wiki
Jump to navigation Jump to search
Object Type Vitals
lgui2radialitem
Defined By LavishGUI 2
Inherits none
Reduces To lgui2radialitem
Variable Object Type none
Uses Sub-Types no
C/C++ Type void *

A lgui2radialitem object provides access to a Radial Item


Members

  • lgui2radialpanel RadialPanel: The Radial Panel containing this Radial Item
  • lgui2element Element: The Child of Radial Panel represented by this Radial Item
  • float ArcLength: The desired arc length, in degrees, of this Radial Item
  • float ActualArcLength: The actual arc length, in degrees, of this Radial Item, after layout
  • float InnerRadius: The inner radius (distance from the center of the panel) of this Radial Item
  • float OuterRadius: The outer radius (distance from the center of the panel) of this Radial Item. (OuterRadius >= InnerRadius)
  • float ActualArcLocation: The actual arc location of this Radial Item, after layout
  • bool Contains[degreesClockwise,distance]: TRUE if this Radial Item contains the point at the given vector from the center of the RadialPanel
  • bool ContainsPoint[#,#]: TRUE if this Radial Item contains the given X,Y coordinate (relative to the Layer, i.e. the game window)
  • bool IsMouseOver: TRUE if the mouse cursor is over the Radial Item (i.e. ContainsPoint[${Mouse}])
  • lgui2margins BorderThickness: Retrieves the thickness of the border
  • lgui2brush BackgroundBrush: Retrieves the Brush for the background of the area surrounded by the border, if applicable
  • lgui2brush BorderBrush: Retrieves the Brush for the border itself, if applicable
  • jsonvalue Style[name]: Retrieves a Style by name
  • float Opacity: Opacity value for the Radial Item (usually between 0.0 and 1.0, with 1.0 being 100% opaque and 0.0 being fully transparent)

Methods

  • SetArcLength[#]: Sets the desired arc length, in degrees, of this Radial Item
  • SetInnerRadius[#]: Sets the inner radius (distance from the center of the panel) of this Radial Item
  • SetOuterRadius[#]: Sets the outer radius (distance from the center of the panel) of this Radial Item. (OuterRadius >= InnerRadius)
  • SetArcMargins[#]: Sets the left and right arc margins (in degrees) to this value
  • SetBorderThickness[#]: Sets all of this element's BorderThickness values to this #
  • SetBorderThickness[#,#]: Sets Left/Right and Top/Bottom (Inner/Outer) BorderThickness values to these #'s (in that order)
  • SetBorderThickness[#,#,#,#]: Sets Left, Top (Outer), Right, Bottom (Inner) BorderThickness values to these #'s (in that order)
  • SetBorderBrush[json]: Sets the Brush used for the border around the Radial Item
  • SetBackgroundBrush[json]: Sets the Brush used for the background of the area surrounded by the border, if applicable
  • ApplyStyle[name]: Applies a Style by name
  • ApplyStyleJSON[json]: Applies a Style defined by the provided json
  • SetStyle[name,json]: Adds a Style with the provided name to the element
  • RemoveStyle[name]: Removes a Style by name
  • SetOpacity[#]: Sets the Opacity value for the Radial Item, with 0.0 being transparent and 1.0 being opaque

Examples

LavishGUI 2 Element Types

LavishGUI 2 LavishScript Object Types

Core API (see Using LavishGUI 2 from LavishScript)
lgui2 - lgui2animateargs - lgui2animationtype - lgui2elementref - lgui2eventargs - lgui2eventhandler - lgui2elementtype - lgui2itemviewgeneratorargs - lgui2inputbinding - lgui2layer - lgui2skin - lgui2trigger
Enums
elgui2animationframestate - elgui2dpad - elgui2edge - elgui2fontflags - elgui2horizontalalignment - elgui2imageorientation - elgui2progresstext - elgui2scrollbar - elgui2sizetocontent - elgui2verticalignment - elgui2visibility
Element Components
lgui2animation - lgui2brush - lgui2fontstyle - lgui2margins - lgui2item - lgui2property - lgui2radialitem - lgui2radialgaugeneedle
Element Base Types
lgui2element - lgui2bordered - lgui2contentbase - lgui2headeredcontentbase - lgui2itemlist
Elements