Component:OutlinedArc: Difference between revisions

Latest revision as of 22:53, 25 October 2024

Component image

**OutlinedArc** component as seen in the Scene Inspector

The OutlinedArc component takes in many parameters to create a circular image or design and can be controlled using those parameters. Then this renders onto the UIX.

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
`Arc`	Float	The amount to arc around the center.
`Offset`	Float	The amount to rotate around the center.
`OuterRadiusRatio`	Float	The outer distance for this arc from the center.
`InnerRadiusRatio`	Float	The inner distance for this arc from the center.
`RoundedCornerRadius`	Float	The amount of how rounded the edges of the arc end points are.
`FillColor`	ColorX	The inner color (filled in color) of this arc.
`OutlineColor`	ColorX	The outer color (the outline) of this arc.
`OutlineThickness`	Float	The amount to thicken for the outline.
`Material`	Material	Uses a material for the arc.

Usage

A user could make fancy effects like a loading circular throbber, or menu buttons that arc around.

Examples

Similar to how the context menu arcs around.

Related Components

Context menu components

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=OutlinedArcComponent.png
@@ Line 9: / Line 8: @@
 <!--T:2-->
-== Intoduction ==
+The '''OutlinedArc''' component takes in many parameters to create a circular image or design and can be controlled using those parameters. Then this renders onto the [[UIX]].
 <!--T:3-->
-== Usage ==
 {{Table ComponentFields
-|Arc|Float|
+|Arc|Float|The amount to arc around the center.
-|Offset|Float|
+|Offset|Float|The amount to rotate around the center.
-|OuterRadiusRatio|Float|
+|OuterRadiusRatio|Float|The outer distance for this arc from the center.
-|InnerRadiusRatio|Float|
+|InnerRadiusRatio|Float|The inner distance for this arc from the center.
-|RoundedCornerRadius|Float|
+|RoundedCornerRadius|Float|The amount of how rounded the edges of the arc end points are.
-|FillColor|ColorX|
+|FillColor|ColorX|The inner color (filled in color) of this arc.
-|OutlineColor|ColorX|
+|OutlineColor|ColorX|The outer color (the outline) of this arc.
-|OutlineThickness|Float|
+|OutlineThickness|Float|The amount to thicken for the outline.
-|Material|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv8=true|
+|Material|{{RootFieldType|AssetRef`1|[[Type:Material|Material]]}}|TypeAdv8=true|Uses a material for the arc.
 }}
 <!--T:4-->
-== Behavior ==
+== Usage ==
+A user could make fancy effects like a [https://en.wikipedia.org/wiki/Throbber loading circular throbber], or menu buttons that arc around.
 <!--T:5-->
 == Examples ==
+Similar to how the [[Context menu|context menu]] arcs around.
 <!--T:6-->
 == Related Components ==
+* [[:Category:Components:Radiant UI:Context Menu|Context menu components]]
 </translate>
 [[Category:Components{{#translation:}}|Outlined Arc]]
-[[Category:ComponentStubs]]
 [[Category:Components:UIX:Graphics{{#translation:}}|Outlined Arc]]