Automated: create new component page |
m typo |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
|Name=Sphere Gizmo | |Name=Sphere Gizmo | ||
}} | }} | ||
The '''SphereGizmo''' component is used to control the radius of certain sphere elements. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|TargetSlot|{{RootFieldType|TransformRelayRef}}|TypeAdv0=true| | |TargetSlot|{{RootFieldType|TransformRelayRef}}|TypeAdv0=true| The slot this should position at. | ||
|AutoPositionAtTargetSlot|Bool| | |AutoPositionAtTargetSlot|Bool| whether the gizmo should auto position at <code>TargetSlot</code> | ||
|_interactingComponent| | |_interactingComponent|Component| the tool interacting with this component. | ||
|_material|'''[[OverlayFresnelMaterial|OverlayFresnelMaterial]]'''|TypeAdv3=true| | |_material|'''[[OverlayFresnelMaterial|OverlayFresnelMaterial]]'''|TypeAdv3=true| The material that is being used for the visual. | ||
|_toolPoint|Slot| | |_toolPoint|Slot| The tool tip that is interacting with. | ||
|_activePoint|Slot| | |_activePoint|Slot| The active point slot for reference to an interacting tool. | ||
|_lineRoot|Slot| | |_lineRoot|Slot| The line root from this gizmo to a tool tip. | ||
|_lineSegment|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv7=true| | |_lineSegment|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv7=true| The line mesh from this gizmo to a tool tip. | ||
|_snapHighlight|Slot| | |_snapHighlight|Slot| The slot used for highlighting snap targets. | ||
|TargetRadius|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>}}|TypeAdv9=true| | |TargetRadius|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>}}|TypeAdv9=true| The field this gizmo is editing (also known as the radius field) | ||
|RadiusSpace|{{RootFieldType|RootSpace}}|TypeAdv10=true| | |RadiusSpace|{{RootFieldType|RootSpace}}|TypeAdv10=true| The transform space the radius is in. | ||
|RimRadius|Float| | |RimRadius|Float| The radius of the rim of the target radius. | ||
|RimRadiusDistanceScale|Float| | |RimRadiusDistanceScale|Float| How to scale the radius for the rim by distance. | ||
|_handles|{{RootFieldType|SyncList`1|[[#Handle|Handle]]}}|TypeAdv13=true| | |_handles|{{RootFieldType|SyncList`1|[[#Handle|SphereGizmo.Handle]]}}|TypeAdv13=true| a list of handles for this gizmo. usually a set of 3 rings. | ||
}} | |||
== Handle == | |||
{{Table TypeFields | |||
|RelativeRadius|Float| The relative radius between the gizmo and this mesh. | |||
|root|Slot| The root of this handle visual. | |||
|mesh|{{RootFieldType|DriveRef`1|[[Component:TorusMesh|TorusMesh]]}}|TypeAdv2=true| The torus mesh used for this visual. | |||
}} | }} | ||
== | == Usage == | ||
Not used directly by the user. May have been one of the first components [[User:Frooxius|Frooxius]] ever made for the game, considering that it doesn't follow some naming conventions that are never broken across all components, especially [[#Handle|SphereGizmo.Handle]] on this page. | |||
== Examples == | == Examples == | ||
| Line 32: | Line 40: | ||
[[Category:Components{{#translation:}}|Sphere Gizmo]] | [[Category:Components{{#translation:}}|Sphere Gizmo]] | ||
[[Category:Components With Nested Types{{#translation:}}|Sphere Gizmo]] | [[Category:Components With Nested Types{{#translation:}}|Sphere Gizmo]] | ||
Latest revision as of 00:43, 3 August 2025
Component image 
Sphere Gizmo component as seen in the Scene Inspector
The SphereGizmo component is used to control the radius of certain sphere elements.
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. |
TargetSlot
|
direct TransformRelayRef | The slot this should position at. |
AutoPositionAtTargetSlot
|
Bool | whether the gizmo should auto position at TargetSlot
|
_interactingComponent
|
Component | the tool interacting with this component. |
_material
|
OverlayFresnelMaterial | The material that is being used for the visual. |
_toolPoint
|
Slot | The tool tip that is interacting with. |
_activePoint
|
Slot | The active point slot for reference to an interacting tool. |
_lineRoot
|
Slot | The line root from this gizmo to a tool tip. |
_lineSegment
|
SegmentMesh | The line mesh from this gizmo to a tool tip. |
_snapHighlight
|
Slot | The slot used for highlighting snap targets. |
TargetRadius
|
direct RelayRef`1<IField`1<Float>> | The field this gizmo is editing (also known as the radius field) |
RadiusSpace
|
direct RootSpace | The transform space the radius is in. |
RimRadius
|
Float | The radius of the rim of the target radius. |
RimRadiusDistanceScale
|
Float | How to scale the radius for the rim by distance. |
_handles
|
list of SphereGizmo.Handle | a list of handles for this gizmo. usually a set of 3 rings. |
Handle
| Name | Type | Description |
|---|---|---|
RelativeRadius
|
Float | The relative radius between the gizmo and this mesh. |
root
|
Slot | The root of this handle visual. |
mesh
|
reference drive of TorusMesh | The torus mesh used for this visual. |
Usage
Not used directly by the user. May have been one of the first components Frooxius ever made for the game, considering that it doesn't follow some naming conventions that are never broken across all components, especially SphereGizmo.Handle on this page.