LGUI2:LS1:lgui2radialgauge
Jump to navigation
Jump to search
lgui2radialgauge | |
Defined By | LavishGUI 2 |
Inherits | lgui2bordered |
Reduces To | lgui2radialgauge |
Variable Object Type | none |
Uses Sub-Types | no |
C/C++ Type | void * |
A lgui2radialgauge object provides access to a radialgauge element, and inherits from lgui2bordered.
Members
- float Origin: Where the radial layout begins, in degrees clockwise from top. 0.0 <= value < 360.0
- uint Resolution: The number of edges used to render the perimeter of a 360-degree FillerBrush circle. For optimal performance, use the lowest value that still looks good at the desired size
- float MaxValueArcLength: The full arc length, in degrees clockwise from Origin, when Value>=MaxValue -- default is 360.0
- int Value: The current Value for the FillerBrush
- int MinValue: The minimum Value for the FillerBrush Range
- int MaxValue: The maximum Value for the FillerBrush Range
- lgui2brush FillerBrush: The Brush used to render the Filler arc
- lgui2brush OverlayBrush: The Brush used to render the Overlay after rendering the Filler and any Needles
- elgui2progresstext ProgressText: The style of progress text, if any, to show on the bar
- float OuterRadius: The radius from the CenterPoint to the outer edge of the FillerBrush -- default is 0.0
- float OuterRadiusFactor: The radius factor, as a factor of the inner size (excluding padding and border) of the radialgauge, to add to OuterRadius -- default is 0.5
- float ActualOuterRadius: The actual outer radius, as calculated by (OuterRadiusFactor*Size)+OuterRadius, where Size is the smaller between the radial gauge's Width and Height
- float InnerRadius: The radius from the CenterPoint to the inner edge of the FillerBrush -- default is 0.0
- float InnerRadiusFactor: The radius factor, as a factor of the inner size (excluding padding and border) of the radialgauge, to add to InnerRadius -- default is 0.0
- float ActualInnerRadius: The actual inner radius, as calculated by (InnerRadiusFactor*Size)+InnerRadius, where Size is the smaller between the radial gauge's Width and Height
- float CenterPointX: The X coordinate of the point to use as the center for the FillerBrush and any Needles -- default is 0.0
- float CenterPointY: The Y coordinate of the point to use as the center for the FillerBrush and any Needles -- default is 0.0
- float CenterPointXFactor: The X Factor (as a factor of the actual width of the radialgauge) of the point to use as the center for the FillerBrush and any Needles -- default is 0.5
- float CenterPointYFactor: The Y Factor (as a factor of the actual height of the radialgauge) of the point to use as the center for the FillerBrush and any Needles -- default is 0.5
- uint NeedleCount: The number of Needles
- lgui2radialgaugeneedle Needle[#]: The n-th Needle (1-based) if any
- lgui2radialgaugeneedle Needle[name]: The Needle with this name, if any
Methods
- SetOrigin[#]: Sets where the radial layout begins, in degrees clockwise from top. This value will automatically adjust into the range 0.0 <= value < 360.0, meaning -1 becomes 359, and 361 becomes 1.
- SetResolution[#]: Sets the number of edges used to render the perimeter of a 360-degree FillerBrush circle. For optimal performance, use the lowest value that still looks good at the desired size
- SetMaxValueArcLength[#]: Sets the full arc length, in degrees clockwise from Origin, when Value>=MaxValue
- SetFillerBrush[json]: Sets the Brush used to render the Filler arc
- SetOverlayBrush[json]: Sets the Brush used to render the Overlay after rendering the Filler and any Needles
- SetValue[#]: Sets the new current Value for the FillerBrush
- SetRange[#,#]: Sets the new minimum and maximum Values for the FillerBrush Range
- SetProgressText[newValue]: Sets the style of progress text, if any, to show on the bar. Must be a valid elgui2progresstext value
- SetOuterRadius[#]: Sets the radius from the CenterPoint to the outer edge of the FillerBrush -- default is 0.0
- SetOuterRadiusFactor[#]: Sets the radius factor, as a factor of the inner size (excluding padding and border) of the radialgauge, to add to OuterRadius -- default is 0.5
- SetInnerRadius[#]: Sets the radius from the CenterPoint to the inner edge of the FillerBrush -- default is 0.0
- SetInnerRadiusFactor[#]: Sets the radius factor, as a factor of the inner size (excluding padding and border) of the radialgauge, to add to InnerRadius -- default is 0.0
- SetCenterPoint[#,#]: Sets the point to use as the center for the FillerBrush and any Needles -- default is 0,0
- SetCenterPointFactor[#,#]: Sets the X,Y Factor (as a factor of the actual width and height of the radialgauge) of the point to use as the center for the FillerBrush and any Needles -- default is 0.5,0.5
- SetNeedle[name,json]: Sets a Needle with the specified name, with a radialgaugeneedle definition. If a Needle already exists with the given name, it is removed
Examples
LavishGUI 2 Element Types
- Base Element Types: Element - Content Container - Headered Content Container - Item List
- Layout: anchor - border - dockpanel - dragger - expander - hud - map - page - pagecontrol -panel - popup - radialpanel - screen - scrollviewer - stackpanel - tab - tabcontrol - table - treepanel - window - wrappanel
- Display: canvas - imagebox - progressbar - radialgauge - textblock
- Interaction: button - checkbox - combobox - contextmenu - dragin - filepicker - itemview - knob - listbox - mapitemview - objectview - propertyview - scrollbar - sensitivebutton - slider - textbox
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
- Layout: lgui2anchor - lgui2border - lgui2dockpanel - lgui2dragger - lgui2expander - lgui2hud - lgui2map - lgui2page - lgui2pagecontrol - lgui2panel - lgui2popup - lgui2radialpanel - lgui2screen - lgui2scrollviewer - lgui2stackpanel - lgui2tab - lgui2tabcontrol - lgui2table - lgui2treepanel - lgui2window - lgui2wrappanel
- Display: lgui2canvas - lgui2imagebox - lgui2progressbar - lgui2radialgauge - lgui2textblock
- Interaction: lgui2button - lgui2checkbox - lgui2combobox - lgui2contextmenu - lgui2dragin - lgui2filepicker - lgui2itemview - lgui2knob - lgui2listbox - lgui2mapitemview - lgui2objectview - lgui2propertyview - lgui2scrollbar - lgui2sensitivebutton - lgui2slider - lgui2textbox