Torus

Draws a torus — a ring or donut — set by a ring radius and a tube radius, for O-rings, tires, and orbit bands.

Declarative element: <sk-torus>

Global: available as sk.Torus inside a scene <script>.

Remarks

This is a member of the AbstractMeshNode geometry-primitive family: a solid, renderable shape you position, paint, and animate like any scene node. It is the shape to reach for whenever you need a ring, a tire, or a circular band.

Key attributes. A torus is set by two radii, both animatable: major-radius is the ring's distance from center (how big the loop is) and minor-radius is the tube's thickness (how fat it is) — so a thin minor-radius reads as jewelry and a thick one as a tire. orientation (+x, -x, +y, -y, +z, -z) picks the axis the ring lies perpendicular to. major-segments tessellates around the ring and minor-segments around the tube — 24 and 16 respectively give a smooth surface. include-quad-diagonals toggles the diagonal edges shown in wireframe.

Related. Give it appearance with a sk-surface-paint (fills the faces) or an sk-edge-paint (draws the wireframe), each naming a sk-plain-material. It sits alongside the other round primitives — sk-cylinder, sk-disc — and, like every mesh, can supply clone positions to a sk-cloner.

Constructor

constructor(config?: { majorRadius?: number; majorSegments?: number; minorRadius?: number; minorSegments?: number; orientation?: AxisOrientation; includeQuadDiagonals?: boolean; cullMode?: CullMode; overlay?: boolean; overlayOccludedOpacity?: number; id?: string; x?: number; y?: number; z?: number; h?: number; p?: number; b?: number; quaternion?: Quaternion; sx?: number; sy?: number; sz?: number; s?: number; class?: string; style?: string })

Inherited from: AbstractMeshNode, RenderableNode, SceneNode, SkenraAnimatable — see those pages for inherited members.

Properties

Config Properties

Other Properties

Methods

Example

// Create a torus with default parameters (ring radius=1, tube radius=0.3)
const torus = new Torus({ id: 'my-torus' });

// Create a tire-like shape (thick tube, high quality)
const tire = new Torus({
    id: 'tire',
    majorRadius: 1.5,
    majorSegments: 32,  // Smooth main ring
    minorRadius: 0.6,   // Thick tube
    minorSegments: 16   // Smooth tube cross-section
});

// Create a thin ring (jewelry, O-ring)
const ring = new Torus({
    id: 'ring',
    majorRadius: 3,
    minorRadius: 0.1,   // Very thin tube
    majorSegments: 64   // High quality for thin profile
});

// Create a vertical torus (perpendicular to X-axis)
const verticalTorus = new Torus({ id: 'vertical', orientation: '+x' });

↑ Documentation home · ← All classes