Class ScyllaShelvedWallShape

Parametric wall with N evenly-spaced horizontal shelves extruding from the front face. Shelf height, inter-shelf gap, and top/bottom margins are all equal - auto-computed as s = height / (2 * shelfCount + 1) - so the wall reads as a regular pattern. The back face is flat.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

ScyllaShapeBase3D

ScyllaShelvedWallShape

Inherited Members

ScyllaShapeBase3D.Tint

ScyllaShapeBase3D.DoubleSided

ScyllaShapeBase3D.ColliderMode

ScyllaShapeBase3D.SharedMesh

ScyllaShapeBase3D.Bounds

ScyllaShapeBase3D.IsManuallyEdited

ScyllaShapeBase3D.FaceColoringMode

ScyllaShapeBase3D.ColorPaletteName

ScyllaShapeBase3D.ColorSeed

ScyllaShapeBase3D.UniformColorIndex

ScyllaShapeBase3D.FaceColoringPalette

ScyllaShapeBase3D.TintPaletteName

ScyllaShapeBase3D.TintEntryName

ScyllaShapeBase3D.Rebuild()

ScyllaShapeBase3D.RebuildAndGet()

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.transformHandle

Component.gameObject

Component.tag

Object.GetEntityId()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

Object.InstantiateAsync<T>(T, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.InstantiateAsync<T>(T, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion, InstantiateParameters, CancellationToken)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, InstantiateParameters, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

Object.Instantiate<T>(T, InstantiateParameters)

Object.Instantiate<T>(T, Vector3, Quaternion, InstantiateParameters)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsByType(Type)

Object.FindObjectsByType(Type, FindObjectsInactive)

Object.DontDestroyOnLoad(Object)

Object.FindAnyObjectByType<T>()

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsByType<T>()

Object.FindObjectsByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType(Type)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Scylla.Core.Util.Geom

Assembly: ScyllaCore.dll

Syntax

[AddComponentMenu("Scylla/Geometry/Shelved Wall")]
public sealed class ScyllaShelvedWallShape : ScyllaShapeBase3D

Remarks

The wall is centered at the origin. The total wall footprint is Length x Height x Thickness. Layout from bottom to top: gap, shelf 0, gap, shelf 1, ..., gap, shelf N-1, gap. Each shelf spans the full wall length, has thickness s on Y, and extrudes outward on the +Z side by ShelfDepth.

Each shelf contributes 5 quads: top face, bottom face, outer front face, left end, and right end. The wall body emits shelfCount + 1 front-face strips (the gap regions), plus flat back, top, bottom, and two end faces.

For per-face coloring, ColoringMode selects between WallAndShelves (the default, 2 resolver indices: wall surface vs all shelves) and PerShelf (shelfCount + 1 indices: wall + one per shelf bottom-to-top). Per-face coloring requires a FaceColoringMode other than None and a valid ColorPaletteName.

The Build(Mesh, float, float, float, int, float, ShelvedWallColoringMode, IFaceColorResolver) static method can be called directly to populate an arbitrary UnityEngine.Mesh without attaching a component.

Properties

ColoringMode

Selects the per-face color granularity applied when a IFaceColorResolver is active. Geometry is identical in all modes; only how many distinct resolver indices the wall emits changes. See ShelvedWallColoringMode for the index-to-region mapping. Setting this triggers an immediate mesh rebuild via Rebuild().

Declaration

public ShelvedWallColoringMode ColoringMode { get; set; }

Property Value

Type	Description
ShelvedWallColoringMode

Height

Wall extent along the Y axis (the wall's full vertical height). Values below 0.0001 are clamped at build time. The total height is divided into 2 * ShelfCount + 1 equal zones. Setting this triggers an immediate mesh rebuild via Rebuild().

Declaration

public float Height { get; set; }

Property Value

Type	Description
float

Length

Wall extent along the X axis (the wall's horizontal run). Values below 0.0001 are clamped at build time. Setting this triggers an immediate mesh rebuild via Rebuild().

Declaration

public float Length { get; set; }

Property Value

Type	Description
float

ShelfCount

Number of shelves to generate. Clamped to [0, 32] at build time. A value of 0 produces a plain flat-front wall. Setting this triggers an immediate mesh rebuild via Rebuild().

Declaration

public int ShelfCount { get; set; }

Property Value

Type	Description
int

ShelfDepth

Outward +Z extrusion depth of each shelf beyond the wall's front surface. Clamped to >= 0 at build time. A value of 0 produces shelves with zero protrusion (effectively invisible). Setting this triggers an immediate mesh rebuild via Rebuild().

Declaration

public float ShelfDepth { get; set; }

Property Value

Type	Description
float

Thickness

Wall body extent along the Z axis. Values below 0.0001 are clamped at build time. Setting this triggers an immediate mesh rebuild via Rebuild().

Declaration

public float Thickness { get; set; }

Property Value

Type	Description
float

Methods

Build(Mesh, float, float, float, int, float, ShelvedWallColoringMode, IFaceColorResolver)

Populates target with a parametric shelved-wall mesh. Existing mesh data is cleared and overwritten. All dimension parameters are clamped at build time so the method always produces valid geometry.

Declaration

public static void Build(Mesh target, float length, float height, float thickness, int shelfCount, float shelfDepth, ShelvedWallColoringMode coloringMode = ShelvedWallColoringMode.WallAndShelves, IFaceColorResolver resolver = null)

Parameters

Type	Name	Description
Mesh	target	Destination mesh to populate. Must not be `null`.
float	length	Wall extent along X (horizontal run). Values below `0.0001` are clamped to `0.0001`.
float	height	Wall extent along Y (full vertical height). Values below `0.0001` are clamped to `0.0001`.
float	thickness	Wall body extent along Z. Values below `0.0001` are clamped to `0.0001`.
int	shelfCount	Number of shelves. Clamped to `[0, 32]`. A value of `0` produces a plain flat-front wall with no shelves.
float	shelfDepth	Outward `+Z` extrusion depth of each shelf. Clamped to `>= 0`. A value of `0` produces shelves with zero thickness.
ShelvedWallColoringMode	coloringMode	Selects how resolver indices are assigned. WallAndShelves (the default) uses two indices total - `0` for the wall surface and `1` shared across all shelves. PerShelf uses `shelfCount + 1` indices: `0` wall, `1..N` each individual shelf bottom to top. Ignored when `resolver` is `null`.
IFaceColorResolver	resolver	Optional per-face color resolver (see IFaceColorResolver). When non-null, a per-vertex color channel is emitted with one solid color per logical region. When `null`, no vertex color channel is written and the mesh renders using the material's intrinsic color.

Remarks

Shelf height, inter-shelf gap, and top/bottom margins are all auto-computed as height / (2 * shelfCount + 1) so each zone is the same size and the layout reads as a regular pattern regardless of wall height.

This method is the pure-static entry point used by the component's BuildMesh(Mesh) implementation. It can also be called directly to fill an arbitrary UnityEngine.Mesh without attaching a component.

The mesh uses per-region dispatch: Resolve(int, int, Vector3) is called once per logical color group (2 calls for WallAndShelves, or shelfCount + 1 calls for PerShelf). See ShelvedWallColoringMode for the index-to-region mapping.

The generated mesh uses UnityEngine.Rendering.IndexFormat.UInt16 unless the vertex count exceeds 65 000, in which case UnityEngine.Rendering.IndexFormat.UInt32 is used automatically.

BuildMesh(Mesh)

Subclass extension point: write vertex / triangle / normal / uv data into target from the shape's serialized parameters. The base class calls Clear(bool) before invoking this method and UnityEngine.Mesh.RecalculateBounds() afterwards, so subclasses should not invoke either themselves.

Declaration

protected override void BuildMesh(Mesh target)

Parameters

Type	Name	Description
Mesh	target	The owned mesh to populate. Already cleared by the base class.

Overrides

ScyllaShapeBase3D.BuildMesh(Mesh)

GetMeshName()

Returns the shape's mesh name as it should appear on the generated mesh asset. Defaults to the subclass type name; override to provide a friendlier label.