Skip to main content
Use it for a lintel, a ridge beam or a sloped member. The section can be a rectangle, a circle or your own profile.

Import

Example

Notes

  • All values are in metres. The axis goes through the centre of the section.
  • The start point and the end point must be different.
  • A CUSTOM shape needs a customProfile. Floorkit uses only the outer ring of that profile.
  • The class makes geometry. It does not calculate structural strength.
  • Start the geometry kernel before you create this object. See Floorkit.
  • This object is live geometry. To save a building, write it in a building model.
Inheritance: extends OPElement implements IShape, IPlaceable, PlanVectorExportable

Constructor

string
string
ElementType.BEAM
BeamShape
Vec3
Axis start point (world). The axis runs through the section centroid.
Vec3
Axis end point (world). May differ in Y from start — sloped beams are supported (ridge beams, raking members).
number
Horizontal section dimension for RECTANGULAR shape.
number
Vertical section dimension for RECTANGULAR shape.
number
Radius for CIRCULAR shape.
PolygonProfile
Custom section profile (local [u, v] coordinates centered on [0, 0]: u = horizontal across the beam, v = vertical). Only the outer ring is used (swept sections cannot carry holes). Only when shape === CUSTOM.
number
ColumnMaterial
PropertySets

Properties

ElementType
string
Map<string, OPGeometry>
Map<string, OPGeometry>
boolean
boolean
boolean
BeamOptions
string
BeamShape
Vec3
Vec3
number
number
number
PolygonProfile | undefined
number
ColumnMaterial
number
Read-only. Axis length (world). Computed, read-only.
boolean
boolean
boolean

Methods

editableSchema

Self-describing editable surface; a host inspector renders this generically.

move

Translate this element by delta (world-space, meters).

rotate

Rotate this element by angleDeg around axis (default Y-up), pivoted at anchor (default the element’s own centroid).

setOPGeometry

getExportRoots

Vector-export roots (RFC §7).

toDrawing

Produce the beam’s plan footprint as a standardized region primitive from its authored 2D polygon.

setOPMaterial

getEditAnchors

Draggable handles: the two axis endpoints, each free on its own horizontal plane (its Y is preserved, so sloped beams stay sloped).

applyEditAnchor

getOPConfig

setOPConfig

beginEdit

Start one live edit; a second beginEdit before endEdit keeps the first start.

endEdit

End the live edit; its exact undo and redo, or undefined when no option changed.

dispose

Types

BeamOptions

BeamShape

Last modified on October 11, 2026