Component:GenericSlicer: Difference between revisions

Revision as of 16:50, 2 March 2025

Component image

**Generic Slicer** component as seen in the Scene Inspector

The GenericSlicer component is used to drive and handle the slicing of materials like volumes and PBS Slice.

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.
`Targets`	list of SliceDrive	The Slicer Fields on materials to drive.
`Space`	direct RootSpace	The transform space to do slicing in.
`_grabbedVisual`	Slot	The visual to show and hide when this Slicer is grabbed.

SliceDrive

Fields
Name	Type	Description
`Position`	field drive of Float3	The position of a material slice entry to drive
`Normal`	field drive of Float3	The Normal of a material slice entry to drive
`Destroyed`	delegate of identity Action`1<SliceDrive>	The Sync delegate to call when this is destroyed, passing this entry as an argument.

Usage

See Object Slicer Tool.

Examples

See Object Slicer Tool.

@@ Line 3: / Line 3: @@
 |Name=Generic Slicer
 }}
-{{stub}}
+The '''GenericSlicer''' component is used to drive and handle the slicing of materials like volumes and PBS Slice.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|Targets|{{RootFieldType|SyncList`1|[[#SliceDrive|SliceDrive]]}}|TypeAdv0=true|
+|Targets|{{RootFieldType|SyncList`1|[[#SliceDrive|SliceDrive]]}}|TypeAdv0=true| The Slicer Fields on materials to drive.
-|Space|{{RootFieldType|RootSpace}}|TypeAdv1=true|
+|Space|{{RootFieldType|RootSpace}}|TypeAdv1=true| The transform space to do slicing in.
-|_grabbedVisual|Slot|
+|_grabbedVisual|Slot| The visual to show and hide when this Slicer is grabbed.
+}}
+== SliceDrive ==
+{{Table TypeFields
+|Position|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv0=true| The position of a material slice entry to drive
+|Normal|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv1=true| The Normal of a material slice entry to drive
+|Destroyed|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]&lt;[[#SliceDrive|SliceDrive]]&gt;}}|TypeAdv2=true| The Sync delegate to call when this is destroyed, passing this entry as an argument.
 }}
-== Behavior ==
+== Usage ==
+See [[Object Slicer Tool]].
 == Examples ==
+See [[Object Slicer Tool]].
 == See Also ==
+* [[Object Slicer Tool]]
 [[Category:Components:Uncategorized{{#translation:}}|Generic Slicer]]
 [[Category:Components{{#translation:}}|Generic Slicer]]
 [[Category:Components With Nested Types{{#translation:}}|Generic Slicer]]
-[[Category:ComponentStubs]]