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
CUSTOMshape needs acustomProfile. 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.
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
move
delta (world-space, meters).
rotate
angleDeg around axis (default Y-up), pivoted at anchor (default the element’s own centroid).
setOPGeometry
getExportRoots
toDrawing
setOPMaterial
getEditAnchors
applyEditAnchor
getOPConfig
setOPConfig
beginEdit
beginEdit before endEdit keeps the first start.