createCone

createCone

Creates a cone primitive and adds it to the scene.

Signature

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

Parameters

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

PrimitiveConeSettings fields

Field	Type	Description
coneRadiusBottom	number	Radius at the base
coneHeight	number	Height of the cone
coneRadiusSegments	number	Radial segments
coneHeightSegments	number	Height segments
coneCloseEnds	boolean	Close the bottom cap
roundnessEnabled	boolean	Enable rounded base edge
roundnessRadius	number	Roundness radius
roundnessRadiusSegments	number	Segments for roundness curve
computeNormals	boolean	Recompute normals

Returns

Promise<SceneObject> - the created object.

Examples

// Create cone with custom size and rotation
const cone = await api.createCone({
  rotation: { x: 0, y: 0, z: 90 },
  primitiveSettings: {
    coneRadiusBottom: 1.5,
    coneHeight: 3,
  },
});