Capsule

Draws a capsule — a pill: a cylinder capped by two hemispheres — the smooth-ended alternative to a cylinder.

Declarative element: <sk-capsule>

Global: available as sk.Capsule 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 pill, a rounded bar, or a character-style collision volume with no hard edges.

Key attributes. radius (animatable) sets both the tube thickness and the rounded cap size, and height (animatable) is the length of the straight cylindrical middle — so the total length is height + 2 × radius, and stretching height telescopes the pill while radius fattens it. orientation (+x, -x, +y, -y, +z, -z) picks the axis it lies along. rotation-segments (minimum 3) sets the facets around the circumference, cap-segments the rings within each hemisphere, and height-segments the divisions along the middle. 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 is the round-ended sibling of sk-cylinder and shares its cap curvature with sk-sphere, and, like every mesh, can supply clone positions to a sk-cloner.

Constructor

constructor(config?: { radius?: number; height?: number; heightSegments?: number; capSegments?: number; rotationSegments?: 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 capsule with default parameters
const capsule = new Capsule({ id: 'my-capsule' });

// Create a capsule with custom configuration
const custom = new Capsule({ id: 'custom',
    radius: 1,
    height: 2,
    heightSegments: 2,
    capSegments: 8,
    rotationSegments: 16
});

// Create a horizontal capsule along X axis
const horizontal = new Capsule({ id: 'horizontal',
    radius: 0.3,
    height: 2,
    orientation: '+x'
});

↑ Documentation home · ← All classes