LGUI2:LS1:lgui2radialgaugeneedle

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

A lgui2radialgaugeneedle object provides access to a Radial Gauge Needle


Members

  • lgui2radialgauge RadialGauge: The Radial Gauge containing this Radial Gauge Needle
  • unistring Name: The Name of the needle
  • jsonobject JSON: The needle properties as JSON
  • lgui2brush BackgroundBrush: Retrieves the Brush for the background of the needle
  • float Origin: The Origin used for this specific needle, or NULL if not specified (the Radial Gauge's origin is used)
  • float OuterRadius: The outer radius (distance from the gauge's specified center point) for this needle
  • float OuterRadiusFactor: The outer radius factor for this needle, as a factor of the radial gauge's Actual Outer Radius, to be added to OuterRadius
  • float ActualOuterRadius: The actual outer radius, as calculated by (OuterRadiusFactor*RadialGauge.ActualOuterRadius)+OuterRadius
  • float InnerRadius: The inner radius (distance from the gauge's specified center point) for this needle
  • float InnerRadiusFactor: The inner radius factor for this needle, as a factor of the radial gauge's Actual Outer Radius, to be added to InnerRadius
  • float ActualInnerRadius: The actual inner radius, as calculated by (InnerRadiusFactor*RadialGauge.ActualOuterRadius)+InnerRadius
  • int Value: The current Value for the needle positioning
  • int MinValue: The minimum Value for the needle positioning, or NULL if not specified (the Radial Gauge's Range is used)
  • int MaxValue: The maximum Value for the needle positioning, or NULL if not specified (the Radial Gauge's Range is used)
  • uint Segments: Number of segments (2 triangles each) used to render the needle
  • float MaxValueArcLength: The arc length used for the needle position when Value>=MaxValue, in degrees clockwise from Origin, or NULL if not specified (the Radial Gauge's MaxValueArcLength is used)
  • float InnerArcLength: The arc length, in degrees, used for the inner edge of the needle
  • float OuterArcLength: The arc length, in degrees, used for the outer edge of the needle

Methods

  • SetName[name]: Sets the Name for the Needle
  • SetBackgroundBrush[json]: Sets the Brush used for the Needle
  • SetOrigin[#]: Sets the Origin used for this specific needle, in degrees clockwise from the top
  • SetOuterRadius[#]: Sets the outer radius (distance from the gauge's specified center point) for this needle
  • SetInnerRadius[#]: Sets the inner radius (distance from the gauge's specified center point) for this needle
  • SetOuterRadiusFactor[#]: Sets the outer radius factor for this needle, as a factor of the radial gauge's Actual Outer Radius, to be added to OuterRadius
  • SetInnerRadiusFactor[#]: Sets the inner radius factor for this needle, as a factor of the radial gauge's Actual Outer Radius, to be added to InnerRadius
  • SetValue[#]: Sets the new current Value for the Needle position
  • SetRange[#,#]: Sets the new minimum and maximum Values for the Needle Range
  • SetSegments[#]: Sets the number of segments (2 triangles each) used to render the needle
  • SetMaxValueArcLength[#]: Sets the arc length used for the needle position when Value>=MaxValue, in degrees clockwise from Origin
  • SetInnerArcLength[#]: Sets the arc length, in degrees, used for the inner edge of the needle
  • SetOuterArcLength[#]: Sets the arc length, in degrees, used for the outer edge of the needle
  • ApplyStyleJSON[json]: Applies a Style defined by the provided json
  • Remove: Removes the Needle from the gauge


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 - lgui2radialitem - lgui2radialgaugeneedle
Element Base Types
lgui2element - lgui2bordered - lgui2contentbase - lgui2headeredcontentbase - lgui2itemlist
Elements