createSphere

createSphere

Creates a sphere primitive and adds it to the scene.

Signature

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

Parameters

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

PrimitiveSphereSettings fields

Field	Type	Description
sphereRadius	number	Radius of the sphere
sphereWidthSegments	number	Horizontal segments (longitude)
sphereHeightSegments	number	Vertical segments (latitude)
computeNormals	boolean	Recompute normals

Returns

Promise<SceneObject> - the created object.

Examples

// Create with custom radius
const sphere = await api.createSphere({
  primitiveSettings: { sphereRadius: 2.5 },
});

// Create low-poly sphere
const sphere = await api.createSphere({
  name: "LowPolySphere",
  primitiveSettings: {
    sphereRadius: 1,
    sphereWidthSegments: 8,
    sphereHeightSegments: 6,
  },
});