Disc

Draws a flat circle or ring — solid or with a hole punched out — for platforms, halos, and selection indicators.

Declarative element: <sk-disc>

Global: available as sk.Disc 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 circular platform, a halo, a gauge ring, or a flat cap.

Key attributes. outer-radius (animatable) is the circle's size; inner-radius (animatable) punches a hole — inner-radius="0" is a solid disc, and a positive value makes an annulus (ring), so animating it opens and closes the hole. orientation (+x, -x, +y, -y, +z, -z) picks the axis the disc faces (default +y lays it flat). rotation-segments (minimum 3) sets how round the rim is — raise it for a smooth circle; radial-segments subdivides from center to rim for radial gradients or deformation. Because a disc is flat it is double-sided by default (cull-mode="none").

Related. Give it appearance with a sk-surface-paint (fills the face) or an sk-edge-paint (draws the wireframe), each naming a sk-plain-material. It is the round counterpart of the flat sk-plane and the flat relative of the sk-torus, and, like every mesh, can supply clone positions to a sk-cloner.

Constructor

constructor(config?: { innerRadius?: number; outerRadius?: number; radialSegments?: number; rotationSegments?: number; orientation?: AxisOrientation; 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 solid disc (circle)
const disc = new Disc({ id: 'my-disc' });

// Create a ring/annulus with hole
const ring = new Disc({
    id: 'my-ring',
    innerRadius: 0.5,
    outerRadius: 1,
    radialSegments: 2,
    rotationSegments: 32
});

// Create a vertical disc perpendicular to Z axis
const wall = new Disc({
    id: 'circular-wall',
    outerRadius: 3,
    rotationSegments: 64,
    orientation: '+z'
});

↑ Documentation home · ← All classes