Component:PlaneTranslationGizmo: Difference between revisions

From Resonite Wiki
VisualWikitext
Automated: create new component page
 
add info
 
(One intermediate revision by one other user not shown)
Line 3: Line 3:
|Name=Plane Translation Gizmo
|Name=Plane Translation Gizmo
}}
}}
{{stub}}
The '''PlaneTranslationGizmo''' component is used to make the 3 plane axes on a translation gizmo for moving a slot using the dev tip. Used to move objects along a flat plane. Auto generated by the game.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|TargetSlot|{{RootFieldType|TransformRelayRef}}|TypeAdv0=true|
|TargetSlot|{{RootFieldType|TransformRelayRef}}|TypeAdv0=true| The slot to move.
|AutoPositionAtTargetSlot|Bool|
|AutoPositionAtTargetSlot|Bool| Whether to auto position this gizmo at the specified slot.
|_interactingComponent|'''[[Component:Component|Component]]'''|TypeAdv2=true|
|_interactingComponent|Component| the component That is interacting with this.
|_material|'''[[OverlayFresnelMaterial|OverlayFresnelMaterial]]'''|TypeAdv3=true|
|_material|'''[[OverlayFresnelMaterial|OverlayFresnelMaterial]]'''|TypeAdv3=true| The material being used to show this gizmo.
|_toolPoint|Slot|
|_toolPoint|Slot| The tool tip that is controlling this gizmo.
|_activePoint|Slot|
|_activePoint|Slot| The point for this gizmo when using tip instead of projection for the interacting tooltip.
|_lineRoot|Slot|
|_lineRoot|Slot| The root slot of the visual being used when doing tip instead of Projection for the interacting tooltip.
|_lineSegment|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv7=true|
|_lineSegment|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv7=true| The mesh being used for the line visual.
|_snapHighlight|Slot|
|_snapHighlight|Slot| The root of the snap highlight visual sphere.
|PointSpace|{{RootFieldType|RootSpace}}|TypeAdv9=true|
|PointSpace|{{RootFieldType|RootSpace}}|TypeAdv9=true| The transform space of the field this is modifying.
|TargetPoint|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<[[Type:Float3|Float3]]>}}|TypeAdv10=true|
|TargetPoint|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<[[Type:Float3|Float3]]>}}|TypeAdv10=true| The field this is targeting.
|Normal|Float3|
|Normal|Float3| The normal of where this plane gizmo should be pointing for its normal.
|NormalSpace|{{RootFieldType|RootSpace}}|TypeAdv12=true|
|NormalSpace|{{RootFieldType|RootSpace}}|TypeAdv12=true| The transform space the normal is defined in.
|UseCustomVisual|Bool|
|UseCustomVisual|Bool| Whether to use a custom visual for this gizmo.
|_customVisualRoot|Slot|
|_customVisualRoot|Slot| The root slot of the custom visual.
|HandleSize|Float2|
|HandleSize|Float2| The size of the plane used for interacting with this component.
|HandleOffset|Float2|
|HandleOffset|Float2| The offset of the plane used for interacting with this component.
|CreateUndoSteps|Bool|
|CreateUndoSteps|Bool| Whether to create Undo steps for interacting with this gizmo.
|_visualRoot|Slot|
|_visualRoot|Slot| The root slot of the visual of this gizmo.
|_visualRotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv19=true|
|_visualRotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv19=true| The rotation field of this Gizmos visual.
|_visualPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv20=true|
|_visualPosition|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv20=true| The position field of this gizmo's visual.
|_boxSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv21=true|
|_boxSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv21=true| The size of the box mesh being used for this visual.
|_linesRoot|Slot|
|_linesRoot|Slot| The root slot for the tip projection lines visual.
|_line0|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv23=true|
|_line0|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv23=true| The first line for this gizmo when interacting via tip instead of Projection with a dev tip.
|_line1|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv24=true|
|_line1|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv24=true| The second line for this gizmo when interacting via tip instead of Projection with a dev tip.
|_collider|{{RootFieldType|DriveRef`1|[[Component:BoxCollider|BoxCollider]]}}|TypeAdv25=true|
|_collider|{{RootFieldType|DriveRef`1|[[Component:BoxCollider|BoxCollider]]}}|TypeAdv25=true| The collider for interacting with this gizmo.
}}
}}


== Behavior ==
== Usage ==
See [[Gizmo]]


== Examples ==
== Examples ==


== See Also ==
== See Also ==
* [[Gizmo]]


[[Category:Components:Uncategorized{{#translation:}}|Plane Translation Gizmo]]
[[Category:Components:Uncategorized{{#translation:}}|Plane Translation Gizmo]]
[[Category:Components{{#translation:}}|Plane Translation Gizmo]]
[[Category:Components{{#translation:}}|Plane Translation Gizmo]]
[[Category:ComponentStubs]]

Latest revision as of 14:19, 7 July 2025

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

The PlaneTranslationGizmo component is used to make the 3 plane axes on a translation gizmo for moving a slot using the dev tip. Used to move objects along a flat plane. Auto generated by the game.

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 move.
AutoPositionAtTargetSlot Bool Whether to auto position this gizmo at the specified slot.
_interactingComponent Component the component That is interacting with this.
_material OverlayFresnelMaterial The material being used to show this gizmo.
_toolPoint Slot The tool tip that is controlling this gizmo.
_activePoint Slot The point for this gizmo when using tip instead of projection for the interacting tooltip.
_lineRoot Slot The root slot of the visual being used when doing tip instead of Projection for the interacting tooltip.
_lineSegment SegmentMesh The mesh being used for the line visual.
_snapHighlight Slot The root of the snap highlight visual sphere.
PointSpace direct RootSpace The transform space of the field this is modifying.
TargetPoint direct RelayRef`1<IField`1<Float3>> The field this is targeting.
Normal Float3 The normal of where this plane gizmo should be pointing for its normal.
NormalSpace direct RootSpace The transform space the normal is defined in.
UseCustomVisual Bool Whether to use a custom visual for this gizmo.
_customVisualRoot Slot The root slot of the custom visual.
HandleSize Float2 The size of the plane used for interacting with this component.
HandleOffset Float2 The offset of the plane used for interacting with this component.
CreateUndoSteps Bool Whether to create Undo steps for interacting with this gizmo.
_visualRoot Slot The root slot of the visual of this gizmo.
_visualRotation field drive of FloatQ The rotation field of this Gizmos visual.
_visualPosition field drive of Float3 The position field of this gizmo's visual.
_boxSize field drive of Float3 The size of the box mesh being used for this visual.
_linesRoot Slot The root slot for the tip projection lines visual.
_line0 SegmentMesh The first line for this gizmo when interacting via tip instead of Projection with a dev tip.
_line1 SegmentMesh The second line for this gizmo when interacting via tip instead of Projection with a dev tip.
_collider reference drive of BoxCollider The collider for interacting with this gizmo.

Usage

See Gizmo

Examples

See Also

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