createTube

createTube

Creates a tube (hollow cylinder) primitive and adds it to the scene.

Signature

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

Parameters

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

PrimitiveTubeSettings fields

Field	Type	Description
tubeRadiusIn	number	Inner radius
tubeRadiusOut	number	Outer radius
tubeHeight	number	Height
tubeRadiusSegments	number	Radial segments
tubeHeightSegments	number	Height segments
tubeSideSegments	number	Side segments (wall thickness)
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

const tube = await api.createTube({
  primitiveSettings: {
    tubeRadiusIn: 0.5,
    tubeRadiusOut: 1,
    tubeHeight: 3,
  },
});