Component:ColorTool: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:
}}
}}
{{stub}}
{{stub}}
Color tool is a component that drives the color tool from [[Tools]]. Pressing [[Controls|Secondary]] allows for picking a color via raycast, and hitting [[Controls|Primary]] allows for setting the color of a material.


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true|
|_equipLink|{{RootFieldType|LinkTarget`1|[[Type:ITool|ITool]]}}|TypeAdv0=true| {{Template:ITool _equipLink}}
|TipReference|Slot|
|TipReference|Slot| {{Template:ITool TipReference}}
|BlockGripEquip|Bool|
|BlockGripEquip|Bool| {{Template:ITool BlockGripEquip}}
|BlockRemoteEquip|Bool|
|BlockRemoteEquip|Bool| {{Template:ITool BlockRemoteEquip}}
|EquipName|String|
|EquipName|String| {{Template:ITool EquipName}}
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true|
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}}
|_gripPosesGenerated|Bool|
|_gripPosesGenerated|Bool| {{Template:ITool _gripPosesGenerated}}
|Color|ColorX|
|Color|ColorX| The selected color for this tool.
|EnsureUniqueMaterial|Bool|
|EnsureUniqueMaterial|Bool| Creates a new material rather than changing the color of the material of a target object when hitting [[Controls|Primary]].
|ColorIndicators|{{RootFieldType|SyncList`1|[[Type:FieldDrive`1|FieldDrive`1]]<[[Type:ColorX|ColorX]]>}}|TypeAdv9=true|
|ColorIndicators|{{RootFieldType|SyncList`1|[[Type:FieldDrive`1|FieldDrive`1]]<[[Type:ColorX|ColorX]]>}}|TypeAdv9=true| The field to drive to the current picked color. used for an indicator.
|_colorDialog|{{RootFieldType|SlotCleanupRef`1|[[Component:ColorDialogInterface|ColorDialogInterface]]}}|TypeAdv10=true|
|_colorDialog|{{RootFieldType|SlotCleanupRef`1|[[Component:ColorDialogInterface|ColorDialogInterface]]}}|TypeAdv10=true| The currently open color picker dialogue.
}}
}}


Line 23: Line 24:


== Examples ==
== Examples ==
Can be used to pick colors from surfaces, or it can be used to quickly color objects.


== See Also ==
== See Also ==
Line 28: Line 30:
[[Category:Components:Tools{{#translation:}}|Color Tool]]
[[Category:Components:Tools{{#translation:}}|Color Tool]]
[[Category:Components{{#translation:}}|Color Tool]]
[[Category:Components{{#translation:}}|Color Tool]]
[[Category:ComponentStubs]]

Latest revision as of 16:51, 22 October 2024

Component image 
Color Tool component as seen in the Scene Inspector


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Color tool is a component that drives the color tool from Tools. Pressing Secondary allows for picking a color via raycast, and hitting Primary allows for setting the color of a material.

Usage

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.
_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.
Color ColorX The selected color for this tool.
EnsureUniqueMaterial Bool Creates a new material rather than changing the color of the material of a target object when hitting Primary.
ColorIndicators list of FieldDrive`1<ColorX> The field to drive to the current picked color. used for an indicator.
_colorDialog direct SlotCleanupRef`1<ColorDialogInterface> The currently open color picker dialogue.

Behavior

Examples

Can be used to pick colors from surfaces, or it can be used to quickly color objects.

See Also