Skip to main content

Import

Inheritance: extends Polygon implements IShape

Constructor

string
number[]
required
number
number
number
number
boolean
Profile
Placement
required

Properties

string
boolean
boolean
boolean
Map<string, THREE.Object3D<THREE.Object3DEventMap>>
Map<string, THREE.Object3D<THREE.Object3DEventMap>>
CuboidOptions
number | undefined
number | undefined
number
Extrusion distance along +Y. Re-extrudes only; the footprint is untouched.
boolean
Convert the parametric box into an explicit, editable footprint. One-way to match RectanglePrimitive: once freeform, width/depth no longer drive the ring, so flipping back would silently discard edits.
Profile
number
boolean

Methods

setOPConfig

getOPConfig

setOPGeometry

setOPPlacement

Apply native placement to both the profile and its current extrusion.

setOPMaterial

Types

IShape

The package does not export this type by name.

CuboidOptions

A cuboid authored as a 2D rectangular profile extruded to a height, rather than a fixed kernel box primitive.

Placement

Local-frame transform from an asset/instance’s definition coordinates to world coordinates.
Vec3
Local-frame anchor for rotation and scale. Defaults to [0, 0, 0].
Vec3
required
Translation (world-space, meters), applied AFTER rotation and scale.
Vec3
required
Euler angles (degrees), in THREE.js default XYZ order.
Vec3
required
Per-axis scale factors.
Last modified on October 6, 2026