Elements

Overview

Elements are high-level architectural components that represent real-world building objects. They are composed of multiple geometric primitives and shapes, providing parametric control over complex architectural features.

Elements automatically manage their internal geometry and sub-components. When you modify element properties, all related geometry updates automatically.

Available Elements

Doors

Parametric door elements with frames, panels, and configurable swing directions. Source: src/elements/base-door.ts:50

const door = openPlans.baseDoor({
  labelName: 'Main Entry Door',
  type: ElementType.DOOR,
  dimensions: {
    start: { x: -0.45, y: 0, z: 0 },
    end: { x: 0.45, y: 0, z: 0 },
    length: 0.9
  },
  doorPosition: [5, 0, 2],
  doorType: DoorType.WOOD,
  doorHeight: 2.1,
  doorThickness: 0.05,
  frameThickness: 0.15,
  frameColor: 0x8B4513,
  doorColor: 0xD2691E,
  doorRotation: 1.5,    // Controls swing angle (1-2)
  doorQuadrant: 1       // Controls swing direction (1-4)
});

// Modify door properties
door.doorLength = 1.0;
door.doorHeight = 2.2;
door.doorRotation = 1.8;
door.doorQuadrant = 2;

Properties

labelName

string

required

Display name for the door

dimensions.length

number

required

Width of the door opening (use doorLength setter)

doorPosition

[number, number, number]

required

Position of the door in 3D space

doorHeight

number

required

Height of the door panel (default: 2.1m)

doorThickness

number

required

Thickness of the door panel (default: 0.05m)

frameThickness

number

required

Thickness of the door frame (default: 0.15m)

doorRotation

number

required

Door swing rotation factor (1-2, where 1 = 90°, 2 = 45°)

doorQuadrant

number

required

Swing direction quadrant (1-4)

1: Opens outward-right
2: Opens outward-left
3: Opens inward-left
4: Opens inward-right

Door Components

Doors consist of multiple sub-elements: Source: src/elements/base-door.ts:280

// Frame creation (left, right, and top frames)
private createFrame() {
  const leftFrame = new Cuboid({ /* ... */ });
  const rightFrame = new Cuboid({ /* ... */ });
  const topFrame = new Cuboid({ /* ... */ });
  
  const frameGroup = new THREE.Group();
  frameGroup.add(leftFrame, rightFrame, topFrame);
  this.subElements.set('frame', frameGroup);
}

// Door panel creation
private createDoor() {
  const doorPanel = new Cuboid({
    width: this.propertySet.dimensions.length - 0.1,
    height: this.propertySet.doorHeight - 0.1,
    depth: this.propertySet.doorThickness
  });
  this.subElements.set('panel', doorPanel);
}

Windows

Single Window

Parametric window elements with frames, sills, and glass panels. Source: src/elements/base-single-window.ts:39

const window = openPlans.baseSingleWindow({
  labelName: 'Living Room Window',
  type: ElementType.WINDOW,
  dimensions: {
    start: { x: -0.6, y: 0, z: 0 },
    end: { x: 0.6, y: 0, z: 0 },
    length: 1.2
  },
  windowPosition: [0, 0, 5],
  windowType: WindowType.CASEMENT,
  windowHeight: 1.4,
  windowThickness: 0.05,
  frameThickness: 0.15,
  windowColor: 0x87CEEB,
  frameColor: 0x000000,
  sillHeight: 0.9
});

// Modify window properties
window.windowLength = 1.5;
window.windowThickness = 0.08;
window.frameThickness = 0.2;

Properties

windowHeight

number

required

Height of the window panel (default: 1.2m)

sillHeight

number

required

Height from floor to window bottom (default: 0.9m)

windowThickness

number

required

Thickness of the window glass (default: 0.05m)

frameThickness

number

required

Thickness of the window frame (default: 0.15m)

Window Components

Source: src/elements/base-single-window.ts:156

// Frame includes left, right, top, and sill
private createFrame() {
  const leftFrame = new Cuboid({ /* ... */ });
  const rightFrame = new Cuboid({ /* ... */ });
  const topFrame = new Cuboid({ /* ... */ });
  const sillFrame = new Cuboid({ /* ... */ });
  
  const frameGroup = new THREE.Group();
  frameGroup.add(leftFrame, rightFrame, topFrame, sillFrame);
  this.subElements.set('frame', frameGroup);
}

Double Window

Similar to single windows but with dual panels:

const doubleWindow = openPlans.baseDoubleWindow({
  labelName: 'Master Bedroom Window',
  dimensions: { length: 2.0 },
  windowPosition: [10, 0, 5],
  windowHeight: 1.5,
  sillHeight: 0.9
});

Slabs

Horizontal structural elements like floors and ceilings. Source: src/elements/base-slab.ts:34

const slab = openPlans.baseSlab({
  labelName: 'Ground Floor Slab',
  type: ElementType.SLAB,
  dimensions: {
    start: { x: -5, y: 0, z: -5 },
    end: { x: 5, y: 0, z: 5 },
    width: 10,
    length: 10
  },
  slabPosition: [0, 0, 0],
  slabThickness: 0.2,
  slabColor: 0xCCCCCC,
  slabMaterial: 'concrete'
});

// Modify slab dimensions
slab.slabWidth = 12;
slab.slabLength = 15;
slab.slabThickness = 0.25;
slab.slabColor = 0xA9A9A9;

Properties

dimensions.width

number

required

Width of the slab (X-axis dimension)

dimensions.length

number

required

Length of the slab (Z-axis dimension)

slabThickness

number

required

Thickness of the slab (Y-axis dimension, default: 0.2m)

slabColor

number

required

Color of the slab in hexadecimal format

slabMaterial

string

required

Material type (e.g., ‘concrete’, ‘wood’)

Slab Coordinates

Source: src/elements/base-slab.ts:153 Slabs automatically calculate corner coordinates:

private calculateCoordinatesByConfig() {
  this.propertySet.coordinates = [
    [startX, y, startZ],  // Bottom-left
    [endX, y, startZ],    // Bottom-right
    [endX, y, endZ],      // Top-right
    [startX, y, endZ],    // Top-left
  ];
}

Stairs

Parametric staircase elements with automatic step calculation. Source: src/elements/base-stair.ts:36

const stair = openPlans.baseStair({
  labelName: 'Main Staircase',
  type: ElementType.STAIR,
  stairType: StairType.STRAIGHT,
  dimensions: {
    width: 1.2,
    totalHeight: 3.0,
    totalLength: 4.5
  },
  stairPosition: [0, 0, 0],
  riserHeight: 0.17,      // Desired riser height
  treadDepth: 0.28,       // Depth of each step
  numberOfSteps: 15,      // Auto-calculated
  stairColor: 0x8B7355,
  stairMaterial: 'wood'
});

// Modify stair properties
stair.stairWidth = 1.5;
stair.totalHeight = 3.2;
stair.riserHeight = 0.18;
stair.stairColor = 0xA0522D;

Properties

dimensions.width

number

required

Width of the staircase (default: 1.2m)

dimensions.totalHeight

number

required

Total vertical rise (default: 3.0m)

riserHeight

number

required

Target height of each step (default: 0.17m)

treadDepth

number

required

Depth of each step tread (default: 0.28m)

stairType

StairType

required

Type of staircase: STRAIGHT, LSHAPED, USHAPED, SPIRAL, or WINDER

Automatic Step Calculation

Source: src/elements/base-stair.ts:127 Stairs automatically calculate the optimal number of steps:

private calculateSteps() {
  // Calculate steps based on total height and desired riser
  const calculatedSteps = Math.ceil(
    this.propertySet.dimensions.totalHeight / this.propertySet.riserHeight
  );
  
  this.propertySet.numberOfSteps = Math.max(2, calculatedSteps);
  
  // Calculate actual riser height for even distribution
  this.actualRiserHeight = 
    this.propertySet.dimensions.totalHeight / this.propertySet.numberOfSteps;
}

Element Architecture

Sub-Elements System

All elements use a subElements map to manage their components:

subElements: Map<SubElementType, THREE.Object3D> = new Map();

// Example: Door sub-elements
this.subElements.set('frame', frameGroup);
this.subElements.set('panel', doorPanel);

// Example: Window sub-elements
this.subElements.set('frame', frameGroup);
this.subElements.set('panel', windowPanel);

Geometry Management

Source: src/elements/base-door.ts:335 Elements automatically recreate geometry when properties change:

setOPGeometry(): void {
  // Remove old geometry
  if (this.children.length > 1) {
    this.remove(...this.children.slice(1));
  }

  // Create fresh geometry
  this.createFrame();
  this.createDoor();
}

Opening Elements

Doors and windows extend the Opening class from the kernel, which provides:

Automatic opening geometry
Wall integration
Visibility management

Source: src/elements/base-door.ts:50

export class BaseDoor extends Opening implements IShape {
  // Extends kernel Opening class
}

Profile Views

Elements support profile view rendering for technical drawings: Source: src/elements/base-door.ts:353

// Toggle profile view mode
door.showProfileView(true);   // Show outline only
door.showProfileView(false);  // Show full 3D

This feature:

Hides filled geometry
Shows only outlines
Useful for creating 2D technical drawings

Best Practices

Use semantic naming

Give elements meaningful labels for easier project management:

const door = openPlans.baseDoor({
  labelName: 'Master Bedroom Entry',
  // ...
});

Set positions carefully

Element positions are in 3D space coordinates:

// Position at wall location
door.doorPosition = [5, 0, 2];  // [x, y, z]

Respect building codes

Use realistic dimensions following building standards:

// Standard door
doorHeight: 2.1,      // 2.1m standard height
doorLength: 0.9,      // 0.9m standard width

// Standard stair
riserHeight: 0.17,    // 17cm max riser
treadDepth: 0.28,     // 28cm min tread

Example: Complete Room

// Create a floor slab
const floor = openPlans.baseSlab({
  labelName: 'Living Room Floor',
  dimensions: { width: 8, length: 10 },
  slabPosition: [0, 0, 0],
  slabThickness: 0.2,
  slabColor: 0xE0E0E0
});

// Add entry door
const entryDoor = openPlans.baseDoor({
  labelName: 'Main Entry',
  dimensions: { length: 0.9 },
  doorPosition: [0, 0, 5],
  doorHeight: 2.1,
  doorQuadrant: 1
});

// Add windows
const window1 = openPlans.baseSingleWindow({
  labelName: 'Window 1',
  dimensions: { length: 1.5 },
  windowPosition: [4, 0, 0],
  windowHeight: 1.4,
  sillHeight: 0.9
});

const window2 = openPlans.baseSingleWindow({
  labelName: 'Window 2',
  dimensions: { length: 1.5 },
  windowPosition: [-4, 0, 0],
  windowHeight: 1.4,
  sillHeight: 0.9
});

// Add stairs to upper floor
const stairs = openPlans.baseStair({
  labelName: 'Main Stairs',
  stairPosition: [2, 0, 2],
  dimensions: {
    width: 1.2,
    totalHeight: 3.0
  },
  riserHeight: 0.17,
  treadDepth: 0.28
});

Getting Started

Core Concepts

Guides

Examples

Overview

Available Elements

Doors

Properties

Door Components

Windows

Single Window

Properties

Window Components

Double Window

Slabs

Properties

Slab Coordinates

Stairs

Properties

Automatic Step Calculation

Element Architecture

Sub-Elements System

Geometry Management

Opening Elements

Profile Views

Best Practices

Example: Complete Room

Getting Started

Core Concepts

Guides

Examples

​Overview

​Available Elements

​Doors

​Properties

​Door Components

​Windows

​Single Window

​Properties

​Window Components

​Double Window

​Slabs

​Properties

​Slab Coordinates

​Stairs

​Properties

​Automatic Step Calculation

​Element Architecture

​Sub-Elements System

​Geometry Management

​Opening Elements

​Profile Views

​Best Practices

​Example: Complete Room

Overview

Available Elements

Doors

Properties

Door Components

Windows

Single Window

Properties

Window Components

Double Window

Slabs

Properties

Slab Coordinates

Stairs

Properties

Automatic Step Calculation

Element Architecture

Sub-Elements System

Geometry Management

Opening Elements

Profile Views

Best Practices

Example: Complete Room