Automated: update Fields |
add info |
||
Line 3: | Line 3: | ||
|Name=Volume Translation Gizmo | |Name=Volume Translation Gizmo | ||
}} | }} | ||
The '''VolumeTranslationGizmo''' component is used to move around and edit a volume object. | |||
== | == 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| | |_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. | ||
|PointSpace|{{RootFieldType|RootSpace}}|TypeAdv9=true| | |PointSpace|{{RootFieldType|RootSpace}}|TypeAdv9=true| The space that the translation point is in. | ||
|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 in which to drive for the target point editing. | ||
|UseCustomVisual|Bool| | |UseCustomVisual|Bool| Whether or not to use a custom visual. | ||
|_customVisualRoot|Slot| | |_customVisualRoot|Slot| The root of the custom visual element. | ||
|_visualRoot|Slot| | |_visualRoot|Slot| The root of the default visual. | ||
|CubeSize|Float| | |CubeSize|Float| The size of the visual root. | ||
|CreateUndoSteps|Bool| | |CreateUndoSteps|Bool| Whether or not to create [[Undo]] steps for this gizmo. | ||
|_cubeSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv16=true| | |_cubeSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv16=true| The field to drive with the cube size. | ||
|_colliderSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv17=true| | |_colliderSize|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv17=true| The field to drive with the collider size. | ||
}} | }} | ||
== | == Usage == | ||
== Examples == | == Examples == | ||
Line 35: | Line 35: | ||
[[Category:Components:Uncategorized{{#translation:}}|Volume Translation Gizmo]] | [[Category:Components:Uncategorized{{#translation:}}|Volume Translation Gizmo]] | ||
[[Category:Components{{#translation:}}|Volume Translation Gizmo]] | [[Category:Components{{#translation:}}|Volume Translation Gizmo]] | ||
Latest revision as of 20:31, 3 August 2025
Component image 
Volume Translation Gizmo component as seen in the Scene Inspector

The VolumeTranslationGizmo component is used to move around and edit a volume object.
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. |
PointSpace
|
direct RootSpace | The space that the translation point is in. |
TargetPoint
|
direct RelayRef`1<IField`1<Float3>> | The field in which to drive for the target point editing. |
UseCustomVisual
|
Bool | Whether or not to use a custom visual. |
_customVisualRoot
|
Slot | The root of the custom visual element. |
_visualRoot
|
Slot | The root of the default visual. |
CubeSize
|
Float | The size of the visual root. |
CreateUndoSteps
|
Bool | Whether or not to create Undo steps for this gizmo. |
_cubeSize
|
field drive of Float3 | The field to drive with the cube size. |
_colliderSize
|
field drive of Float3 | The field to drive with the collider size. |