Class ScyllaRingShape

Parametric ring (annulus) shape: a circular band with a concentric inner hole, extruded vertically to a configurable height, centered on the origin along the Y axis. Four face groups are emitted - top, bottom, outer wall, and inner wall - all with hard edges (unique vertices per group).

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

ScyllaShapeBase3D

ScyllaRingShape

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/Ring")]
public sealed class ScyllaRingShape : ScyllaShapeBase3D

Remarks

The top face lies at y = height / 2 and the bottom face at y = -height / 2. The outer wall faces outward radially and the inner wall faces inward (toward the Y axis), producing a hollow tube cross-section.

Because each of the four face groups uses independent vertices, all edges are hard-shaded. The outer wall normal is the outward radial direction per segment quad; the inner wall normal is the inward radial direction. Top and bottom face normals are uniform +Y and -Y respectively.

Total vertex count is segments * 4 * 4 (four quads per segment, four vertices per quad) and triangle index count is segments * 4 * 6. Segment count is clamped to [3, 256] at build time.

Per-vertex coloring (see FaceColoringMode) uses per-vertex dispatch: the resolver is called once per vertex with the vertex index and local position. This produces smooth spatial gradients under GradientByY and per-vertex variation under Cycle or Hash.

The static Build(Mesh, float, float, float, int, IFaceColorResolver) method can be called directly to populate any UnityEngine.Mesh without attaching a component, which is useful for procedural mesh pipelines.

Properties

Height

Vertical thickness of the ring in local units. Setting this property triggers an immediate mesh rebuild via Rebuild().

Declaration

public float Height { get; set; }

Property Value

Type	Description
float

InnerRadius

Inner radius of the ring (hole size) in local units. Setting this property triggers an immediate mesh rebuild via Rebuild().

Declaration

public float InnerRadius { get; set; }

Property Value

Type	Description
float

OuterRadius

Outer radius of the ring in local units. Setting this property triggers an immediate mesh rebuild via Rebuild().

Declaration

public float OuterRadius { get; set; }

Property Value

Type	Description
float

Segments

Number of circumferential subdivisions around the ring. Clamped to [3, 256] at build time. Setting this property triggers an immediate mesh rebuild via Rebuild().

Declaration

public int Segments { get; set; }

Property Value

Type	Description
int

Methods

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

Populates target with a parametric ring (annulus) mesh. Existing mesh data is overwritten. Segment count is clamped to [3, 256].

Declaration

public static void Build(Mesh target, float outerRadius, float innerRadius, float height, int segments, IFaceColorResolver resolver = null)

Parameters

Type	Name	Description
Mesh	target	Destination mesh. Must be non-null.
float	outerRadius	Outer radius of the ring in local units. Must be greater than `innerRadius` to produce a valid annular band.
float	innerRadius	Inner radius of the ring (hole size) in local units. Determines the size of the central opening.
float	height	Vertical thickness of the ring in local units. The top face is at `y = height / 2` and the bottom face at `y = -height / 2`.
int	segments	Circumferential subdivisions around the ring. Clamped to `[3, 256]`. Higher values produce smoother circular edges.
IFaceColorResolver	resolver	Optional per-vertex color resolver. Uses per-vertex dispatch: when non-null, a per-vertex color channel is emitted where the resolver is called once per vertex with the vertex index and local position. Yields smooth gradients under GradientByY and per-vertex speckle under Cycle or Hash. When `null`, no color channel is written.

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.