Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=Slicing Volume Visualizer | |Name=Slicing Volume Visualizer | ||
}} | }} | ||
The '''SlicingVolumeVisualizer''' component is used to visualize the slicer imported with new volumes imported into the game. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Material|{{RootFieldType|RelayRef`1|[[VolumeUnlitMaterial|VolumeUnlitMaterial]]}}|TypeAdv0=true| | |Material|{{RootFieldType|RelayRef`1|[[VolumeUnlitMaterial|VolumeUnlitMaterial]]}}|TypeAdv0=true| The material to be slicing. | ||
|AutoScale|Bool| | |AutoScale|Bool| Whether to auto scale the visual to fit the object it is slicing. | ||
|_renderer|'''[[Component:MeshRenderer|MeshRenderer]]'''|TypeAdv2=true| | |_renderer|'''[[Component:MeshRenderer|MeshRenderer]]'''|TypeAdv2=true| The renderer component which this is slicing a mesh for. | ||
|_mesh|'''[[Component:BoxMesh|BoxMesh]]'''|TypeAdv3=true| | |_mesh|'''[[Component:BoxMesh|BoxMesh]]'''|TypeAdv3=true| The mesh this visual is slicing. | ||
|_collider|'''[[Component:BoxCollider|BoxCollider]]'''|TypeAdv4=true| | |_collider|'''[[Component:BoxCollider|BoxCollider]]'''|TypeAdv4=true| The box collider that is used to interact with the slicer this is attached to. | ||
|_scale|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv5=true| | |_scale|{{RootFieldType|FieldDrive`1|[[Type:Float3|Float3]]}}|TypeAdv5=true| The scale field of the slicer visual element. | ||
|Slicers|{{RootFieldType|SyncRelayList`1|[[Component:VolumePlaneSlicer|VolumePlaneSlicer]]}}|TypeAdv6=true| | |Slicers|{{RootFieldType|SyncRelayList`1|[[Component:VolumePlaneSlicer|VolumePlaneSlicer]]}}|TypeAdv6=true| A list of slicers that are slicing the object. | ||
|_slicePlanes|{{RootFieldType|DriveRef`1|[[Type:SyncList`1|SyncList`1]]<[[Type:SlicePlane|SlicePlane]]>}}|TypeAdv7=true| | |_slicePlanes|{{RootFieldType|DriveRef`1|[[Type:SyncList`1|SyncList`1]]<[[Type:SlicePlane|SlicePlane]]>}}|TypeAdv7=true| A list of slice planes that are slicing the object. | ||
|_highlights|{{RootFieldType|DriveRef`1|[[Type:SyncList`1|SyncList`1]]<[[Type:Highlight|Highlight]]>}}|TypeAdv8=true| | |_highlights|{{RootFieldType|DriveRef`1|[[Type:SyncList`1|SyncList`1]]<[[Type:Highlight|Highlight]]>}}|TypeAdv8=true| a list of highlight components for slicing the object. | ||
}} | }} | ||
== | == Usage == | ||
== Examples == | == Examples == | ||
| Line 26: | Line 26: | ||
[[Category:Components:Uncategorized{{#translation:}}|Slicing Volume Visualizer]] | [[Category:Components:Uncategorized{{#translation:}}|Slicing Volume Visualizer]] | ||
[[Category:Components{{#translation:}}|Slicing Volume Visualizer]] | [[Category:Components{{#translation:}}|Slicing Volume Visualizer]] | ||
Latest revision as of 23:26, 2 August 2025
Component image 
Slicing Volume Visualizer component as seen in the Scene Inspector
The SlicingVolumeVisualizer component is used to visualize the slicer imported with new volumes imported into the game.
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. |
Material
|
direct RelayRef`1<VolumeUnlitMaterial> | The material to be slicing. |
AutoScale
|
Bool | Whether to auto scale the visual to fit the object it is slicing. |
_renderer
|
MeshRenderer | The renderer component which this is slicing a mesh for. |
_mesh
|
BoxMesh | The mesh this visual is slicing. |
_collider
|
BoxCollider | The box collider that is used to interact with the slicer this is attached to. |
_scale
|
field drive of Float3 | The scale field of the slicer visual element. |
Slicers
|
direct SyncRelayList`1<VolumePlaneSlicer> | A list of slicers that are slicing the object. |
_slicePlanes
|
reference drive of SyncList`1<SlicePlane> | A list of slice planes that are slicing the object. |
_highlights
|
reference drive of SyncList`1<Highlight> | a list of highlight components for slicing the object. |