Component:AxisTranslationGizmo: Difference between revisions

From Resonite Wiki
← Older edit
Visual
add info on the root space to unify meaning
add remaining info
 
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=AxisTranslationGizmoComponent.png
|Image=AxisTranslationGizmoComponent.png
|Name=Axis Translation Gizmo
|Name=Axis Translation Gizmo
}}
}}
The '''AxisTranslationGizmo''' is the squares often seen on a Gizmo to translate it along 2 axies at the same time.


<!--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 plane this will translate along.
|AxisSpace|{{RootFieldType|RootSpace}}|TypeAdv10=true| The coordinate space of <code>Axis</code>
|AxisSpace|{{RootFieldType|RootSpace}}|TypeAdv10=true| The coordinate space of <code>Axis</code>.
|PointSpace|{{RootFieldType|RootSpace}}|TypeAdv11=true| The coordinate space of <code>TargetPoint</code> drive value.
|PointSpace|{{RootFieldType|RootSpace}}|TypeAdv11=true| The coordinate space of <code>TargetPoint</code> drive value.
|TargetPoint|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:Float3|Float3]]&gt;}}|TypeAdv12=true|
|TargetPoint|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:Float3|Float3]]&gt;}}|TypeAdv12=true| A field to drive with the target point position.
|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 use for <code>TargetPoint</code>
|UseCustomVisual|Bool|
|UseCustomVisual|Bool| Whether to use a custom visual rather than the default code generated one.
|_customVisualRoot|Slot|
|_customVisualRoot|Slot| The root slot of the custom visual.
|ArrowLength|Float|
|ArrowLength|Float| The length of the arrow this gizmo is attached to.
|CreateUndoSteps|Bool|
|CreateUndoSteps|Bool| Whether to make edits done with this component undoable.
|_visualRoot|Slot|
|_visualRoot|Slot| The root slot of the visual for interaction.
|_visualRot|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv19=true|
|_visualRot|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv19=true| The rotation field of the visual.
|_arrowVector|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv20=true|
|_arrowVector|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv20=true| The vector field of the arrow mesh visual.
|_arrow|'''[[Component:ArrowMesh|ArrowMesh]]'''|TypeAdv21=true|
|_arrow|'''[[Component:ArrowMesh|ArrowMesh]]'''|TypeAdv21=true| The arrow mesh of the visual.
|_collider|{{RootFieldType|DriveRef`1|[[Component:CylinderCollider|CylinderCollider]]}}|TypeAdv22=true|
|_collider|{{RootFieldType|DriveRef`1|[[Component:CylinderCollider|CylinderCollider]]}}|TypeAdv22=true| The collider of the visual.
|_linesRoot|Slot|
|_linesRoot|Slot| the root slot of the lines visual.
|_line0|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv24=true|
|_line0|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv24=true| The segment mesh being used for the first line.
|_line1|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv25=true|
|_line1|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv25=true| The segment mesh being used for the second line.
}}
}}


Line 48: Line 48:


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

Latest revision as of 20:12, 10 February 2025

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

The AxisTranslationGizmo is the squares often seen on a Gizmo to translate it along 2 axies at the same time.

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 plane this will translate along.
AxisSpace direct RootSpace The coordinate space of Axis.
PointSpace direct RootSpace The coordinate space of TargetPoint drive value.
TargetPoint direct RelayRef`1<IField`1<Float3>> A field to drive with the target point position.
TargetValue direct RelayRef`1<IField`1<Float>> The field to use for TargetPoint
UseCustomVisual Bool Whether to use a custom visual rather than the default code generated one.
_customVisualRoot Slot The root slot of the custom visual.
ArrowLength Float The length of the arrow this gizmo is attached to.
CreateUndoSteps Bool Whether to make edits done with this component undoable.
_visualRoot Slot The root slot of the visual for interaction.
_visualRot field drive of FloatQ The rotation field of the visual.
_arrowVector field drive of Float3 The vector field of the arrow mesh visual.
_arrow ArrowMesh The arrow mesh of the visual.
_collider reference drive of CylinderCollider The collider of the visual.
_linesRoot Slot the root slot of the lines visual.
_line0 SegmentMesh The segment mesh being used for the first line.
_line1 SegmentMesh The segment mesh being used for the second line.

Usage

Used For Gizmos.

Examples

See Also

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