Sphere

Draws a sphere — the roundest primitive — built either as an evenly-triangulated subdivided icosahedron or as a classic latitude/longitude globe.

Declarative element: <sk-sphere>

Global: available as sk.Sphere 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 ball, a dome, or a spherical source of clone positions.

Key attributes. radius sets the size, and is animatable — a sphere can pulse or grow. sphere-type picks how the mesh is built: icosahedron (default) subdivides an icosahedron into evenly distributed triangles, the best all-round choice; standard builds a latitude/longitude globe (a "UV sphere") whose triangles converge at the poles; hemisphere is a half-dome; tetrahedron, hexahedron, and octahedron expose the lower-poly platonic bases. segments controls tessellation — for the platonic types it is the subdivision count (each step quadruples the triangles, so 2–3 is already smooth); for the latitude/longitude types it is the number of divisions (16 or more for a round profile).

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 primitives — sk-cube, sk-cylinder, sk-torus — and, like every mesh, can supply clone positions to a sk-cloner.

Constructor

constructor(config?: { radius?: number; segments?: number; type?: SphereType; 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 sphere with default parameters
const sphere1 = new Sphere({ id: 'my-sphere' });

// Create a sphere with custom configuration
const sphere2 = new Sphere({ id: 'custom-sphere',
    radius: 2.0,
    segments: 3,
    type: 'icosahedron'
});

// Create a latitude/longitude sphere with more segments
const sphere3 = new Sphere({ id: 'uv-sphere',
    radius: 1,
    segments: 16,
    type: 'standard'
});

Used in guides: Scene basics

↑ Documentation home · ← All classes