Component:VolumePlaneSlicer: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
(2 intermediate revisions by one other user not shown)
Line 3: Line 3:
|Name=Volume Plane Slicer
|Name=Volume Plane Slicer
}}
}}
{{stub}}
See [[Component:VolumeUnlitMaterial#Examples|Volume Unlit Material Examples section]] for better information on how slicers work.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Mode|VolumePlaneMode|
|Mode|VolumePlaneMode| The kind of slicer mode this slicer is doing.
|HighlightColor|ColorX|
|HighlightColor|ColorX| The color highlight to highlight the slicer with. please see [[Component:VolumeUnlitMaterial#Examples|Volume Unlit Material Examples section]] for better info.
|HighlightRange|Float|
|HighlightRange|Float| The color highlight range to use. please see [[Component:VolumeUnlitMaterial#Examples|Volume Unlit Material Examples section]] for better info.
|_colorDialog|{{RootFieldType|SlotCleanupRef`1|[[Component:ColorDialogInterface|ColorDialogInterface]]}}|TypeAdv3=true|
|_colorDialog|{{RootFieldType|SlotCleanupRef`1|[[Component:ColorDialogInterface|ColorDialogInterface]]}}|TypeAdv3=true| The dialog ui currently being used to choose a color to display for the color highlight.
|_grabGrid|Slot|
|_grabGrid|Slot| The slot to enable when grabbing the slicer to show the grid visual.
}}
 
== Sync Delegates ==
{{Table ComponentTriggers
|SelectColor:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Handles when the user requests to use the slicer.
}}
}}


== Behavior ==
== Usage ==
See [[Component:VolumeUnlitMaterial#Examples|Volume Unlit Material Examples section]].


== Examples ==
== Examples ==
See [[Component:VolumeUnlitMaterial#Examples|Volume Unlit Material Examples section]].


== See Also ==
== See Also ==
* [[Component:VolumeUnlitMaterial#Examples|Volume Unlit Material Examples section]].


[[Category:Components:Uncategorized{{#translation:}}|Volume Plane Slicer]]
[[Category:Components:Uncategorized{{#translation:}}|Volume Plane Slicer]]
[[Category:Components{{#translation:}}|Volume Plane Slicer]]
[[Category:Components{{#translation:}}|Volume Plane Slicer]]
[[Category:ComponentStubs]]

Latest revision as of 23:53, 3 May 2025

Component image 
Volume Plane Slicer component as seen in the Scene Inspector

See Volume Unlit Material Examples section for better information on how slicers work.

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.
Mode VolumePlaneMode The kind of slicer mode this slicer is doing.
HighlightColor ColorX The color highlight to highlight the slicer with. please see Volume Unlit Material Examples section for better info.
HighlightRange Float The color highlight range to use. please see Volume Unlit Material Examples section for better info.
_colorDialog direct SlotCleanupRef`1<ColorDialogInterface> The dialog ui currently being used to choose a color to display for the color highlight.
_grabGrid Slot The slot to enable when grabbing the slicer to show the grid visual.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
SelectColor:ButtonEventHandler ButtonEventHandler Handles when the user requests to use the slicer.

Usage

See Volume Unlit Material Examples section.

Examples

See Volume Unlit Material Examples section.

See Also