Component:DevTool: Difference between revisions

From Resonite Wiki
← Older edit
Visual
Automated: update Categories, SyncDelegates
add info
 
(5 intermediate revisions by 2 users not shown)
Line 5: Line 5:
Detailed information can be located at [[Dev Tool]].
Detailed information can be located at [[Dev Tool]].


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true| {{Template:ITool _equipLink}}
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true| {{Template:ITool _equipLink}}
Line 14: Line 14:
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}}
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}}
|_gripPosesGenerated|Bool| {{Template:ITool _gripPosesGenerated}}
|_gripPosesGenerated|Bool| {{Template:ITool _gripPosesGenerated}}
|SelectionMode|'''[[#Selection|Selection]]'''|TypeAdv7=true| See [[#Selection|Selection section]]
|SelectionMode|'''[[#Selection|DevTool.Selection]]'''|TypeAdv7=true| See [[#Selection|Selection section]].
|InteractionMode|'''[[#Interaction|Interaction]]'''|TypeAdv8=true|
|InteractionMode|'''[[#Interaction|DevTool.Interaction]]'''|TypeAdv8=true|See [[#Interaction|Interaction section]].
|_selectedAnchor|'''[[Component:PointAnchor|PointAnchor]]'''|TypeAdv9=true|
|_selectedAnchor|'''[[Component:PointAnchor|PointAnchor]]'''|TypeAdv9=true| The point anchor which is part of a gizmo this tool is moving currently.
|_selectedAnchorHighlight|Slot|
|_selectedAnchorHighlight|Slot| The slot being used to indicate what gizmo is currently being moved. Is an icosphere.
|_material|{{RootFieldType|DriveRef`1|[[OverlayFresnelMaterial|OverlayFresnelMaterial]]}}|TypeAdv11=true|
|_material|{{RootFieldType|DriveRef`1|[[OverlayFresnelMaterial|OverlayFresnelMaterial]]}}|TypeAdv11=true| The visual material used for the default cone mesh.
|_currentGizmo|Slot| The gizmo that the dev tool is currently targeting for gizmo options.
|_currentGizmo|Slot| The gizmo that the dev tool is currently targeting for gizmo options.
|_previousGizmo|Slot| The previous gizmo that the dev tool targeted for gizmo options.
|_previousGizmo|Slot| The previous gizmo that the dev tool targeted for gizmo options.
Line 25: Line 25:
== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|SelectParent()|[[Type:Action|Action]]|
|ToggleDevMode:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| See [[Dev Tool]].
|ToggleSpace()|[[Type:Action|Action]]|
|DeselectAll:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| See [[Dev Tool]].
|SetTranslation()|[[Type:Action|Action]]|
|OpenCreate:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| See [[Dev Tool]].
|SetRotation()|[[Type:Action|Action]]|
|OpenInspector:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| See [[Dev Tool]].
|SetScale()|[[Type:Action|Action]]|
|OpenGizmoOptions:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| See [[Dev Tool]].
|SelectParent:[[Type:Action|Action]]|[[Type:Action|Action]]|false| See [[Dev Tool]].
|ToggleSpace:[[Type:Action|Action]]|[[Type:Action|Action]]|false| See [[Dev Tool]].
|SetTranslation:[[Type:Action|Action]]|[[Type:Action|Action]]|false| See [[Dev Tool]].
|SetRotation:[[Type:Action|Action]]|[[Type:Action|Action]]|false| See [[Dev Tool]].
|SetScale:[[Type:Action|Action]]|[[Type:Action|Action]]|false| See [[Dev Tool]].
|OnOpenParent:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| See [[Dev Tool]].
|SetTranslation:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| See [[Dev Tool]].
|SetRotation:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| See [[Dev Tool]].
|SetScale:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| See [[Dev Tool]].
|ActivateGizmo:[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<[[Type:Component|Component]]>|[[Type:ButtonEventHandler`1|ButtonEventHandler`1]]<[[Type:Component|Component]]>|true| See [[Dev Tool]].
|DestroySelected:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| See [[Dev Tool]].
|DestroyConfirm:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| See [[Dev Tool]].
|OnCancelMenu:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| See [[Dev Tool]].
|OnGizmoReplaced:[[Component:SlotGizmo#SlotGizmoReplacement|SlotGizmo.SlotGizmoReplacement]]|[[Component:SlotGizmo#SlotGizmoReplacement|SlotGizmo.SlotGizmoReplacement]]|true| See [[Dev Tool]].
}}
}}


Line 35: Line 49:
{{Template:DevTool_Selection}}
{{Template:DevTool_Selection}}


== Behavior ==
== Interaction ==
The DevTool component can be used on it's own to create a [[Dev Tool|Developer Tool]] or be used in a [[Component:ToolMultiplexer|ToolMultiplexer]] to create a MultiTool.
{{Template:DevTool_Interaction}}


== Examples ==
== Examples ==
The DevTool component can be used on it's own to create a [[Dev Tool|Developer Tool]] or be used in a [[Component:ToolMultiplexer|ToolMultiplexer]] to create a MultiTool.


== See Also ==
== See Also ==
Line 45: Line 60:
[[Category:Components{{#translation:}}|Dev Tool]]
[[Category:Components{{#translation:}}|Dev Tool]]
[[Category:Components With Nested Enums{{#translation:}}|Dev Tool]]
[[Category:Components With Nested Enums{{#translation:}}|Dev Tool]]
[[Category:ComponentStub]]
[[Category:ComponentStubs]]

Latest revision as of 21:29, 19 March 2025

Component image 
Dev Tool component as seen in the Scene Inspector

Detailed information can be located at 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.
_equipLink direct LinkTarget`1<ITool> This is Internal, and is used by the engine to retrieve the component this field is a part of. It cannot be assigned to.
TipReference Slot The slot to use as the tool's tip, instead of the component's slot.
BlockGripEquip Bool Whether to prevent legacy double grip equipping from equipping this tooltip.
BlockRemoteEquip Bool Whether to prevent equipping by clicking via laser
EquipName String The name of the tool in the context menu when equipping via context menu.
_overrideActiveTool InteractionHandler The interaction handler to use instead of this tool as an interaction handler.
_gripPosesGenerated Bool Whether the Grip Pose Reference components and slots have been generated for this tool.
SelectionMode DevTool.Selection See Selection section.
InteractionMode DevTool.Interaction See Interaction section.
_selectedAnchor PointAnchor The point anchor which is part of a gizmo this tool is moving currently.
_selectedAnchorHighlight Slot The slot being used to indicate what gizmo is currently being moved. Is an icosphere.
_material reference drive of OverlayFresnelMaterial The visual material used for the default cone mesh.
_currentGizmo Slot The gizmo that the dev tool is currently targeting for gizmo options.
_previousGizmo Slot The previous gizmo that the dev tool targeted for gizmo options.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
ToggleDevMode:ButtonEventHandler ButtonEventHandler ✓ See Dev Tool.
DeselectAll:ButtonEventHandler ButtonEventHandler ✓ See Dev Tool.
OpenCreate:ButtonEventHandler ButtonEventHandler ✓ See Dev Tool.
OpenInspector:ButtonEventHandler ButtonEventHandler ✓ See Dev Tool.
OpenGizmoOptions:ButtonEventHandler ButtonEventHandler ✓ See Dev Tool.
SelectParent:Action Action X See Dev Tool.
ToggleSpace:Action Action X See Dev Tool.
SetTranslation:Action Action X See Dev Tool.
SetRotation:Action Action X See Dev Tool.
SetScale:Action Action X See Dev Tool.
OnOpenParent:ButtonEventHandler ButtonEventHandler ✓ See Dev Tool.
SetTranslation:ButtonEventHandler ButtonEventHandler ✓ See Dev Tool.
SetRotation:ButtonEventHandler ButtonEventHandler ✓ See Dev Tool.
SetScale:ButtonEventHandler ButtonEventHandler ✓ See Dev Tool.
ActivateGizmo:ButtonEventHandler`1<Component> ButtonEventHandler`1<Component> ✓ See Dev Tool.
DestroySelected:ButtonEventHandler ButtonEventHandler ✓ See Dev Tool.
DestroyConfirm:ButtonEventHandler ButtonEventHandler ✓ See Dev Tool.
OnCancelMenu:ButtonEventHandler ButtonEventHandler ✓ See Dev Tool.
OnGizmoReplaced:SlotGizmo.SlotGizmoReplacement SlotGizmo.SlotGizmoReplacement ✓ See Dev Tool.

Selection

  • Selection: Sets the selection mode for the tool (select by using the secondary action):
    • Single: Select single object. Selecting an unselected object deselects any other selected object. Selecting a selected object unselects that object.
    • Multi: Select multiple objects. Selecting an unselected object adds that object to the selected objects. Selecting a selected object unselects that object.

Interaction

  • Interaction: What gizmo transformation should be relative to:
    • Tip: Gizmo transformation is relative to the tool's tip.
    • Projection: Gizmo transformation is relative to the projected point.

Examples

The DevTool component can be used on it's own to create a Developer Tool or be used in a ToolMultiplexer to create a MultiTool.

See Also

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