Overview
CuboidShape is a 3D cuboid (rectangular box) shape class that extends the base Cuboid class from the OpenGeometry kernel. It provides methods for creating, configuring, and managing cuboid shapes in your 3D scene.
Constructor
Configuration options for the cuboid shape
Example
import { OpenPlans, ICuboidOptions } from '@opengeometry/openplans';
const openplans = new OpenPlans(container);
// Create a cuboid with default options
const cuboid1 = openplans.cuboid();
// Create a cuboid with custom options
const cuboid2 = openplans.cuboid({
width: 10,
height: 5,
depth: 8,
color: 0x00ff00
});
ICuboidOptions Interface
Configuration options for creating a cuboid shape.
Unique identifier for the shape. Auto-generated if not provided.
Width of the cuboid along the X-axis. Default: 1
Height of the cuboid along the Y-axis. Default: 1
Depth of the cuboid along the Z-axis. Default: 1
Hexadecimal color value for the cuboid. Default: 0xffffff
position
{ x: number, y: number, z: number }
Position of the cuboid in 3D space
rotation
{ x: number, y: number, z: number }
Rotation of the cuboid in radians
Properties
ogType
readonly ogType: string = 'CuboidShape'
subNodes
subNodes: Map<string, THREE.Object3D>
selected
Indicates whether the cuboid is currently selected.
edit
Indicates whether the cuboid is in edit mode.
propertySet
propertySet: ICuboidOptions
Methods
setOPConfig
Update the cuboid’s configuration.
New configuration options to apply
cuboid.setOPConfig({
width: 15,
height: 10,
depth: 12,
color: 0xff0000
});
Calling setOPConfig will discard the current geometry and rebuild it with the new configuration.
getOPConfig
Retrieve the current configuration of the cuboid.
Returns: ICuboidOptions
const config = cuboid.getOPConfig();
console.log(config.width, config.height, config.depth);
setOPGeometry
Update the geometry of the cuboid. This method is called internally when configuration changes.
setOPMaterial
Update the material properties of the cuboid.
Complete Example
import { OpenPlans } from '@opengeometry/openplans';
// Initialize OpenPlans
const container = document.getElementById('canvas');
const openplans = new OpenPlans(container);
await openplans.setupOpenGeometry();
// Create a cuboid
const cuboid = openplans.cuboid({
width: 20,
height: 15,
depth: 10,
color: 0x3498db
});
// Position the cuboid
cuboid.position.set(0, 7.5, 0);
// Update configuration
cuboid.setOPConfig({
width: 25,
height: 15,
depth: 10,
color: 0x2ecc71
});
// Get current properties
const properties = cuboid.getOPConfig();
console.log('Cuboid dimensions:', properties);
// Mark as selected
cuboid.selected = true;
