createBox

createBox

Creates a box primitive and adds it to the scene.

Signature

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

Parameters

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

PrimitiveBoxSettings fields

Field	Type	Description
boxDimensions	{ x: number; y: number; z: number }	Box size on each axis
boxSegments	{ x: number; y: number; z: number }	Subdivision segments per axis
roundnessEnabled	boolean	Enable rounded corners
roundnessRadius	number	Corner radius
roundnessRadiusSegments	number	Segments for roundness curve
computeNormals	boolean	Recompute normals

Returns

Promise<SceneObject> - the created object.

Examples

// Create with defaults
const box = await api.createBox();

// Create at a specific position with a name
const box = await api.createBox({
  name: "MyBox",
  position: { x: 0, y: 1, z: 0 },
});

// Create with custom dimensions and roundness
const box = await api.createBox({
  name: "RoundedBox",
  primitiveSettings: {
    boxDimensions: { x: 2, y: 1, z: 3 },
    roundnessEnabled: true,
    roundnessRadius: 0.1,
  },
});