Component:VectorGizmo: 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=Vector Gizmo
|Name=Vector Gizmo
}}
}}
{{stub}}
The '''VectorGizmo''' component is used to allow editing a gizmo via the [[Dev tool]].


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|TargetSlot|{{RootFieldType|TransformRelayRef}}|TypeAdv0=true|
|TargetSlot|{{RootFieldType|TransformRelayRef}}|TypeAdv0=true| The slot to influence or a component this is on.
|AutoPositionAtTargetSlot|Bool|
|AutoPositionAtTargetSlot|Bool| Whether to position the gizmo at <code>TargetSlot</code>.
|_interactingComponent|'''[[Component:Component|Component]]'''|TypeAdv2=true|
|_interactingComponent|Component| The component like a [[Dev tool]] that is interacting with this gizmo.
|_material|'''[[OverlayFresnelMaterial|OverlayFresnelMaterial]]'''|TypeAdv3=true|
|_material|'''[[OverlayFresnelMaterial|OverlayFresnelMaterial]]'''|TypeAdv3=true| The material being used for the gizmo visual.
|_toolPoint|Slot|
|_toolPoint|Slot| The slot to position at the interacting tool's tip slot.
|_activePoint|Slot|
|_activePoint|Slot| The slot to position at the active point.
|_lineRoot|Slot|
|_lineRoot|Slot| The slot that stores the line segment for tip based movement rather than projected mode.
|_lineSegment|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv7=true|
|_lineSegment|'''[[Component:SegmentMesh|SegmentMesh]]'''|TypeAdv7=true| The mesh being used for the line visual to the interacting tool tip.
|_snapHighlight|Slot|
|_snapHighlight|Slot| The slot storing the gizmo snap highlight visual.
|VectorSpace|{{RootFieldType|RootSpace}}|TypeAdv9=true|
|VectorSpace|{{RootFieldType|RootSpace}}|TypeAdv9=true| The space to do edits to the vector in.
|TargetVector|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:Float3|Float3]]&gt;}}|TypeAdv10=true|
|TargetVector|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:Float3|Float3]]&gt;}}|TypeAdv10=true| The target vector field to modify.
|TargetRotation|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:FloatQ|FloatQ]]&gt;}}|TypeAdv11=true|
|TargetRotation|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;[[Type:FloatQ|FloatQ]]&gt;}}|TypeAdv11=true| The target vector rotation to modify.
|FixMagnitude|Bool|
|FixMagnitude|Bool| whether to fix a magnitude during/after editing.
|FixedMagnitude|Float|
|FixedMagnitude|Float| The value to fix the vector magnitude to if <code>FixMagnitude</code> is enabled.
|VisualMagnitudeScale|Float|
|VisualMagnitudeScale|Float| The magnitude scalar of the vector visual.
|VisualThickness|Float|
|VisualThickness|Float| The thickness of the visual for the vector.
|_colliderRotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv16=true|
|_colliderRotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv16=true| The rotation field of the visual collider.
|_collider|{{RootFieldType|DriveRef`1|[[Component:CylinderCollider|CylinderCollider]]}}|TypeAdv17=true|
|_collider|{{RootFieldType|DriveRef`1|[[Component:CylinderCollider|CylinderCollider]]}}|TypeAdv17=true| The collider used for the vector.
|_mesh|{{RootFieldType|DriveRef`1|[[Component:ArrowMesh|ArrowMesh]]}}|TypeAdv18=true|
|_mesh|{{RootFieldType|DriveRef`1|[[Component:ArrowMesh|ArrowMesh]]}}|TypeAdv18=true| The arrow mesh being used to show the vector visual.
}}
}}


== Behavior ==
== Usage ==


== Examples ==
== Examples ==
Line 36: Line 36:
[[Category:Components:Uncategorized{{#translation:}}|Vector Gizmo]]
[[Category:Components:Uncategorized{{#translation:}}|Vector Gizmo]]
[[Category:Components{{#translation:}}|Vector Gizmo]]
[[Category:Components{{#translation:}}|Vector Gizmo]]
[[Category:ComponentStubs]]

Latest revision as of 19:50, 3 August 2025

Component image 
Vector Gizmo component as seen in the Scene Inspector

The VectorGizmo component is used to allow editing a gizmo via 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 influence or a component this is on.
AutoPositionAtTargetSlot Bool Whether to position the gizmo at TargetSlot.
_interactingComponent Component The component like a Dev tool that is interacting with this gizmo.
_material OverlayFresnelMaterial The material being used for the gizmo visual.
_toolPoint Slot The slot to position at the interacting tool's tip slot.
_activePoint Slot The slot to position at the active point.
_lineRoot Slot The slot that stores the line segment for tip based movement rather than projected mode.
_lineSegment SegmentMesh The mesh being used for the line visual to the interacting tool tip.
_snapHighlight Slot The slot storing the gizmo snap highlight visual.
VectorSpace direct RootSpace The space to do edits to the vector in.
TargetVector direct RelayRef`1<IField`1<Float3>> The target vector field to modify.
TargetRotation direct RelayRef`1<IField`1<FloatQ>> The target vector rotation to modify.
FixMagnitude Bool whether to fix a magnitude during/after editing.
FixedMagnitude Float The value to fix the vector magnitude to if FixMagnitude is enabled.
VisualMagnitudeScale Float The magnitude scalar of the vector visual.
VisualThickness Float The thickness of the visual for the vector.
_colliderRotation field drive of FloatQ The rotation field of the visual collider.
_collider reference drive of CylinderCollider The collider used for the vector.
_mesh reference drive of ArrowMesh The arrow mesh being used to show the vector visual.

Usage

Examples

See Also

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