createCylinder

createCylinder

Creates a cylinder primitive and adds it to the scene.

Signature

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

Parameters

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

PrimitiveCylinderSettings fields

Field	Type	Description
cylinderRadiusTop	number	Top radius
cylinderRadiusBottom	number	Bottom radius
cylinderHeight	number	Height
cylinderRadiusSegments	number	Radial segments
cylinderHeightSegments	number	Height segments
cylinderCapSegments	number	Cap segments
cylinderCloseEnds	boolean	Close top/bottom caps
roundnessEnabled	boolean	Enable edge roundness
roundnessRadius	number	Roundness radius
roundnessRadiusSegments	number	Segments for roundness
computeNormals	boolean	Recompute normals

Returns

Promise<SceneObject> - the created object.

Examples

// High-detail cylinder
const cyl = await api.createCylinder({
  primitiveSettings: {
    cylinderRadius: 1,
    cylinderHeight: 4,
    cylinderRadiusSegments: 64,
  },
});

// Tapered cylinder (different top/bottom radius)
const tapered = await api.createCylinder({
  primitiveSettings: {
    cylinderRadiusTop: 0.5,
    cylinderRadiusBottom: 1.5,
    cylinderHeight: 2,
  },
});