Class ScyllaTorusShape

Parametric torus (donut) shape with configurable major radius, minor radius, ring segments, and tube segments, centered on the origin in the XZ plane. Normals are smooth around both axes; UVs map the ring angle to u and the tube angle to v.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

ScyllaShapeBase3D

ScyllaTorusShape

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

Remarks

The major radius (MajorRadius) is the distance from the torus center to the center of the tube. The minor radius (MinorRadius) is the radius of the tube cross-section. The torus lies in the XZ plane and is centered at the origin; the tube sweeps a full 360 degrees around the Y axis.

Both segment counts are clamped to [3, 256]. Vertex count is (ringSegments + 1) * (tubeSegments + 1) and triangle index count is ringSegments * tubeSegments * 6. Vertices on opposite seam edges are duplicated so that UVs wrap cleanly without a discontinuity artifact.

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 (which varies the color by tube elevation) and per-vertex variation under Cycle or Hash.

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

Properties

MajorRadius

Distance from the torus center to the center of the tube cross-section, in local units. Values below 0.0001 are clamped when set and at build time. Setting this property triggers an immediate mesh rebuild via Rebuild().

Declaration

public float MajorRadius { get; set; }

Property Value

Type	Description
float

MinorRadius

Radius of the tube cross-section in local units. Values below 0.0001 are clamped when set and at build time. Setting this property triggers an immediate mesh rebuild via Rebuild().

Declaration

public float MinorRadius { get; set; }

Property Value

Type	Description
float

RingSegments

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

Declaration

public int RingSegments { get; set; }

Property Value

Type	Description
int

TubeSegments

Number of subdivisions around the tube cross-section. Clamped to [3, 256] when set and at build time. Setting this property triggers an immediate mesh rebuild via Rebuild().

Declaration

public int TubeSegments { get; set; }

Property Value

Type	Description
int

Methods

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

Populates target with a parametric torus mesh. Existing mesh data is overwritten. Both segment counts are clamped to [3, 256].

Declaration

public static void Build(Mesh target, float majorRadius, float minorRadius, int ringSegments, int tubeSegments, IFaceColorResolver resolver = null)

Parameters

Type	Name	Description
Mesh	target	Destination mesh. Must be non-null.
float	majorRadius	Distance from the torus center to the tube center in local units. Determines the overall diameter of the donut. Clamped to a minimum of `0.0001`.
float	minorRadius	Radius of the tube cross-section in local units. Determines the thickness of the donut ring. Values larger than `majorRadius` produce a self-intersecting mesh. Clamped to a minimum of `0.0001`.
int	ringSegments	Number of subdivisions around the main ring (around the Y axis). Clamped to `[3, 256]`. Higher values produce a smoother circular profile.
int	tubeSegments	Number of subdivisions around the tube cross-section. Clamped to `[3, 256]`. Higher values produce a rounder tube.
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.