Component:AxisRotationGizmo: Difference between revisions

From Resonite Wiki
← Older edit
Visual
add info on the root space to unify meaning
add info
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AxisRotationGizmoComponent.png
|Image=AxisRotationGizmoComponent.png
|Name=Axis Rotation Gizmo
|Name=Axis Rotation Gizmo
}}
}}
The '''AxisRotationGizmo''' component is used for one of the any 3 axies of rotation for a rotation gizmo that can be interacted with through the [[Dev Tool]].


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|TargetSlot|{{RootFieldType|TransformRelayRef}}|TypeAdv0=true|
|TargetSlot|{{RootFieldType|TransformRelayRef}}|TypeAdv0=true| The slot to translate and edit.
|AutoPositionAtTargetSlot|Bool|
|AutoPositionAtTargetSlot|Bool| Whether to automatically position this at the target slot.
|_interactingComponent|Component|
|_interactingComponent|Component| the component This is interacting with.
|_material|'''[[OverlayFresnelMaterial|OverlayFresnelMaterial]]'''|TypeAdv3=true|
|_material|'''[[OverlayFresnelMaterial|OverlayFresnelMaterial]]'''|TypeAdv3=true| The material being used for the visual.
|_toolPoint|Slot|
|_toolPoint|Slot| The point that follows the interacting tool's tip.
|_activePoint|Slot|
|_activePoint|Slot| The point that follows the gizmo visual.
|_lineRoot|Slot|
|_lineRoot|Slot| the root of the line visual from the gizmo to the interacting tool's tip.
|_lineSegment|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv7=true|
|_lineSegment|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv7=true| The segment mesh being used for the line visual.
|_snapHighlight|Slot|
|_snapHighlight|Slot| the root of the snap highlight for snapping.
|Axis|Float3|
|Axis|Float3| The direction of the 2d axis this will rotate along.
|AxisSpace|{{RootFieldType|RootSpace}}|TypeAdv10=true| The coordinate space of the <code>Axis</code> value.
|AxisSpace|{{RootFieldType|RootSpace}}|TypeAdv10=true| The coordinate space of <code>Axis</code>.
|RotationSpace|{{RootFieldType|RootSpace}}|TypeAdv11=true| The coordinate space of the <code>TargetRotation</code> drive target.
|RotationSpace|{{RootFieldType|RootSpace}}|TypeAdv11=true| The coordinate space of the <code>TargetRotation</code> drive target.
|TargetRotation|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:FloatQ|FloatQ]]&gt;}}|TypeAdv12=true|
|TargetRotation|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:FloatQ|FloatQ]]&gt;}}|TypeAdv12=true| A field to drive with the target rotation
|TargetValue|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:Float|Float]]&gt;}}|TypeAdv13=true|
|TargetValue|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:Float|Float]]&gt;}}|TypeAdv13=true| The field to drive <code>TargetRotation</code> with.
|CircleRadius|Float|
|CircleRadius|Float| The radius of the rotation circle gizmo.
|CircleThickness|Float|
|CircleThickness|Float| The thickness of the torus of the rotation gizmo.
|_visualRoot|Slot|
|_visualRoot|Slot| The root slot of the visual for interaction.
|_visualRot|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv17=true|
|_visualRot|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv17=true| The rotation field of the visual.
|_circle|{{RootFieldType|DriveRef`1|[[Component:TorusMesh|TorusMesh]]}}|TypeAdv18=true|
|_circle|{{RootFieldType|DriveRef`1|[[Component:TorusMesh|TorusMesh]]}}|TypeAdv18=true| The torus mesh being used to make the rotation gizmo interact visual.
|_circleColliderMesh|{{RootFieldType|DriveRef`1|[[Component:TorusMesh|TorusMesh]]}}|TypeAdv19=true|
|_circleColliderMesh|{{RootFieldType|DriveRef`1|[[Component:TorusMesh|TorusMesh]]}}|TypeAdv19=true| The collider for the circle rotation gizmo visual.
|_referenceLine|{{RootFieldType|DriveRef`1|[[Component:SegmentMesh|SegmentMesh]]}}|TypeAdv20=true|
|_referenceLine|{{RootFieldType|DriveRef`1|[[Component:SegmentMesh|SegmentMesh]]}}|TypeAdv20=true| The reference line mesh component.
|_linesRoot|Slot|
|_linesRoot|Slot| The root of the visuals for the lines.
|_line0|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv22=true|
|_line0|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv22=true| The line along the rotation plane to below the tooltip.
|_line1|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv23=true|
|_line1|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv23=true| The line from the end of <code>_line0</code> to the tooltip.
}}
}}


Line 44: Line 44:


== Examples ==
== Examples ==
{{stub}}


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Axis Rotation Gizmo]]
[[Category:Components{{#translation:}}|Axis Rotation Gizmo]]
[[Category:Components:Uncategorized{{#translation:}}|Axis Rotation Gizmo]]
[[Category:Components:Uncategorized{{#translation:}}|Axis Rotation Gizmo]]

Latest revision as of 21:18, 10 February 2025

Component image 
Axis Rotation Gizmo component as seen in the Scene Inspector

The AxisRotationGizmo component is used for one of the any 3 axies of rotation for a rotation gizmo that can be interacted with through the Dev Tool.

Fields

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 to translate and edit.
AutoPositionAtTargetSlot Bool Whether to automatically position this at the target slot.
_interactingComponent Component the component This is interacting with.
_material OverlayFresnelMaterial The material being used for the visual.
_toolPoint Slot The point that follows the interacting tool's tip.
_activePoint Slot The point that follows the gizmo visual.
_lineRoot Slot the root of the line visual from the gizmo to the interacting tool's tip.
_lineSegment SegmentMesh The segment mesh being used for the line visual.
_snapHighlight Slot the root of the snap highlight for snapping.
Axis Float3 The direction of the 2d axis this will rotate along.
AxisSpace direct RootSpace The coordinate space of Axis.
RotationSpace direct RootSpace The coordinate space of the TargetRotation drive target.
TargetRotation direct RelayRef`1<IField`1<FloatQ>> A field to drive with the target rotation
TargetValue direct RelayRef`1<IField`1<Float>> The field to drive TargetRotation with.
CircleRadius Float The radius of the rotation circle gizmo.
CircleThickness Float The thickness of the torus of the rotation gizmo.
_visualRoot Slot The root slot of the visual for interaction.
_visualRot field drive of FloatQ The rotation field of the visual.
_circle reference drive of TorusMesh The torus mesh being used to make the rotation gizmo interact visual.
_circleColliderMesh reference drive of TorusMesh The collider for the circle rotation gizmo visual.
_referenceLine reference drive of SegmentMesh The reference line mesh component.
_linesRoot Slot The root of the visuals for the lines.
_line0 SegmentMesh The line along the rotation plane to below the tooltip.
_line1 SegmentMesh The line from the end of _line0 to the tooltip.

Usage

Used for Gizmos.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:AxisRotationGizmo&oldid=96224"