createPolyhedron

createPolyhedron

Creates an icosahedron (polyhedron) primitive and adds it to the scene.

Signature

createPolyhedron(options?: CreatePrimitiveOptions): Promise<SceneObject>

Parameters

Parameter	Type	Required	Description
options	CreatePrimitiveOptions	No	Transform and primitive-specific settings

PrimitivePolyhedronSettings fields

Field	Type	Description
polyhedronRadius	number	Radius
polyhedronDetail	number	Subdivision level (0 = base icosahedron)
computeNormals	boolean	Recompute normals

Returns

Promise<SceneObject> - the created object.

Examples

// Base icosahedron
const poly = await api.createPolyhedron({
  primitiveSettings: { polyhedronRadius: 1, polyhedronDetail: 0 },
});

// Subdivided (approaching sphere)
const poly = await api.createPolyhedron({
  primitiveSettings: { polyhedronRadius: 1, polyhedronDetail: 3 },
});