geom¶

Classes¶

Iterator¶

Defined in: ifcopenshell-js/src/geom/iterator.ts:18

Synchronous native iterator. Load schema, mapping and kernel plugins before construction.

Extends¶

IfcOpenshellGeomIterator

Constructors¶

Constructor¶

new Iterator(settings, file, options?): Iterator

Defined in: ifcopenshell-js/src/geom/iterator.ts:21

Parameters¶

Overrides¶

IfcOpenshellGeomIterator.constructor

Properties¶

ptr¶

readonly ptr: number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:445

Inherited from¶

IfcOpenshellGeomIterator.ptr

settings¶

readonly settings: Settings

Defined in: ifcopenshell-js/src/geom/iterator.ts:22

Methods¶

[asyncDispose]()¶

[asyncDispose](): Promise<void>

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:449

Returns¶

Promise<void>

Inherited from¶

IfcOpenshellGeomIterator.[asyncDispose]

[dispose]()¶

[dispose](): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:448

Returns¶

void

Inherited from¶

IfcOpenshellGeomIterator.[dispose]

boundsMax()¶

boundsMax(): IfcOpenshellGeomTaxonomyPoint3

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:450

Returns¶

IfcOpenshellGeomTaxonomyPoint3

Inherited from¶

IfcOpenshellGeomIterator.boundsMax

boundsMin()¶

boundsMin(): IfcOpenshellGeomTaxonomyPoint3

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:451

Returns¶

IfcOpenshellGeomTaxonomyPoint3

Inherited from¶

IfcOpenshellGeomIterator.boundsMin

computeBounds()¶

computeBounds(with_geometry): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:452

Parameters¶

with_geometry¶

boolean

Returns¶

void

Inherited from¶

IfcOpenshellGeomIterator.computeBounds

create()¶

create(): IfcOpenshellInstance

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:453

Returns¶

IfcOpenshellInstance

Inherited from¶

IfcOpenshellGeomIterator.create

destroy()¶

destroy(): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:446

Returns¶

void

Inherited from¶

IfcOpenshellGeomIterator.destroy

dispose()¶

dispose(): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:447

Returns¶

void

Inherited from¶

IfcOpenshellGeomIterator.dispose

file()¶

file(): IfcOpenshellFile | null

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:454

Returns¶

IfcOpenshellFile | null

Inherited from¶

IfcOpenshellGeomIterator.file

get()¶

get(): IfcOpenshellGeomElement | null

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:455

Returns¶

IfcOpenshellGeomElement | null

Inherited from¶

IfcOpenshellGeomIterator.get

getAsBrepElement()¶

getAsBrepElement(): IfcOpenshellGeomBrepElement | null

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:456

Returns¶

IfcOpenshellGeomBrepElement | null

Inherited from¶

IfcOpenshellGeomIterator.getAsBrepElement

getAsSerializedElement()¶

getAsSerializedElement(): IfcOpenshellGeomSerializedElement | null

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:457

Returns¶

IfcOpenshellGeomSerializedElement | null

Inherited from¶

IfcOpenshellGeomIterator.getAsSerializedElement

getAsTriangulationElement()¶

getAsTriangulationElement(): IfcOpenshellGeomTriangulationElement | null

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:458

Returns¶

IfcOpenshellGeomTriangulationElement | null

Inherited from¶

IfcOpenshellGeomIterator.getAsTriangulationElement

getLog()¶

getLog(): string

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:459

Returns¶

string

Inherited from¶

IfcOpenshellGeomIterator.getLog

getNative()¶

getNative(): IfcOpenshellGeomBrepElement | null

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:460

Returns¶

IfcOpenshellGeomBrepElement | null

Inherited from¶

IfcOpenshellGeomIterator.getNative

getObject()¶

getObject(id): IfcOpenshellGeomElement | null

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:461

Parameters¶

id¶

number

Returns¶

IfcOpenshellGeomElement | null

Inherited from¶

IfcOpenshellGeomIterator.getObject

getTaskItems()¶

getTaskItems(): IfcOpenshellGeomTaxonomyItem[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:462

Returns¶

IfcOpenshellGeomTaxonomyItem[]

Inherited from¶

IfcOpenshellGeomIterator.getTaskItems

getTaskProducts()¶

getTaskProducts(): IfcOpenshellInstance[][]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:463

Returns¶

IfcOpenshellInstance[][]

Inherited from¶

IfcOpenshellGeomIterator.getTaskProducts

hadErrorProcessingElements()¶

hadErrorProcessingElements(): boolean

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:464

Returns¶

boolean

Inherited from¶

IfcOpenshellGeomIterator.hadErrorProcessingElements

initialize()¶

initialize(): boolean

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:465

Returns¶

boolean

Inherited from¶

IfcOpenshellGeomIterator.initialize

next()¶

next(): boolean

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:466

Returns¶

boolean

Inherited from¶

IfcOpenshellGeomIterator.next

progress()¶

progress(): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:467

Returns¶

number

Inherited from¶

IfcOpenshellGeomIterator.progress

unitMagnitude()¶

unitMagnitude(): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:468

Returns¶

number

Inherited from¶

IfcOpenshellGeomIterator.unitMagnitude

unitName()¶

unitName(): string

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:469

Returns¶

string

Inherited from¶

IfcOpenshellGeomIterator.unitName

Settings¶

Defined in: ifcopenshell-js/src/geom/settings.ts:8

Owned wrapper for native geometry interpretation settings.

Extends¶

IfcOpenshellGeomSettings

Constructors¶

Constructor¶

new Settings(): Settings

Defined in: ifcopenshell-js/src/geom/settings.ts:9

Returns¶

Settings

Overrides¶

IfcOpenshellGeomSettings.constructor

Properties¶

ptr¶

readonly ptr: number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:568

Inherited from¶

IfcOpenshellGeomSettings.ptr

Methods¶

destroy()¶

destroy(): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:569

Returns¶

void

Inherited from¶

IfcOpenshellGeomSettings.destroy

get()¶

get(name): string | number | boolean | string[] | number[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:589

Parameters¶

name¶

string

Returns¶

string | number | boolean | string[] | number[]

Inherited from¶

IfcOpenshellGeomSettings.get

getBool()¶

getBool(name): boolean

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:570

Parameters¶

name¶

string

Returns¶

boolean

Inherited from¶

IfcOpenshellGeomSettings.getBool

getDouble()¶

getDouble(name): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:571

Parameters¶

name¶

string

Returns¶

number

Inherited from¶

IfcOpenshellGeomSettings.getDouble

getDoubleList()¶

getDoubleList(name): number[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:572

Parameters¶

name¶

string

Returns¶

number[]

Inherited from¶

IfcOpenshellGeomSettings.getDoubleList

getInt()¶

getInt(name): number

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:573

Parameters¶

name¶

string

Returns¶

number

Inherited from¶

IfcOpenshellGeomSettings.getInt

getIntSet()¶

getIntSet(name): number[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:574

Parameters¶

name¶

string

Returns¶

number[]

Inherited from¶

IfcOpenshellGeomSettings.getIntSet

getString()¶

getString(name): string

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:575

Parameters¶

name¶

string

Returns¶

string

Inherited from¶

IfcOpenshellGeomSettings.getString

getStringList()¶

getStringList(name): string[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:576

Parameters¶

name¶

string

Returns¶

string[]

Inherited from¶

IfcOpenshellGeomSettings.getStringList

getStringSet()¶

getStringSet(name): string[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:577

Parameters¶

name¶

string

Returns¶

string[]

Inherited from¶

IfcOpenshellGeomSettings.getStringSet

getType()¶

getType(name): string

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:578

Parameters¶

name¶

string

Returns¶

string

Inherited from¶

IfcOpenshellGeomSettings.getType

names()¶

names(): string[]

Defined in: ifcopenshell-js/src/geom/settings.ts:17

Returns¶

string[]

set()¶

set(name, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:588

Parameters¶

name¶

string

value¶

string | number | boolean | string[] | number[]

Returns¶

void

Inherited from¶

IfcOpenshellGeomSettings.set

setBool()¶

setBool(name, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:579

Parameters¶

name¶

string

value¶

boolean

Returns¶

void

Inherited from¶

IfcOpenshellGeomSettings.setBool

setDouble()¶

setDouble(name, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:580

Parameters¶

name¶

string

value¶

number

Returns¶

void

Inherited from¶

IfcOpenshellGeomSettings.setDouble

setDoubleList()¶

setDoubleList(name, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:581

Parameters¶

name¶

string

value¶

number[]

Returns¶

void

Inherited from¶

IfcOpenshellGeomSettings.setDoubleList

setInt()¶

setInt(name, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:582

Parameters¶

name¶

string

value¶

number

Returns¶

void

Inherited from¶

IfcOpenshellGeomSettings.setInt

setIntSet()¶

setIntSet(name, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:583

Parameters¶

name¶

string

value¶

number[]

Returns¶

void

Inherited from¶

IfcOpenshellGeomSettings.setIntSet

setString()¶

setString(name, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:584

Parameters¶

name¶

string

value¶

string

Returns¶

void

Inherited from¶

IfcOpenshellGeomSettings.setString

setStringList()¶

setStringList(name, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:585

Parameters¶

name¶

string

value¶

string[]

Returns¶

void

Inherited from¶

IfcOpenshellGeomSettings.setStringList

setStringSet()¶

setStringSet(name, value): void

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:586

Parameters¶

name¶

string

value¶

string[]

Returns¶

void

Inherited from¶

IfcOpenshellGeomSettings.setStringSet

settingNames()¶

settingNames(): string[]

Defined in: ifcopenshell-wasm/wasm/ifcopenshell_api.d.ts:587

Returns¶

string[]

Inherited from¶

IfcOpenshellGeomSettings.settingNames

value()¶

value(name): SettingInput

Defined in: ifcopenshell-js/src/geom/settings.ts:13

Parameters¶

name¶

string

Returns¶

SettingInput

Interfaces¶

IteratorOptions¶

Defined in: ifcopenshell-js/src/geom/iterator.ts:10

Optional native iterator configuration.

Properties¶

exclude?¶

optional exclude?: IteratorFilter

Defined in: ifcopenshell-js/src/geom/iterator.ts:13

geometryLibrary?¶

optional geometryLibrary?: string

Defined in: ifcopenshell-js/src/geom/iterator.ts:14

include?¶

optional include?: IteratorFilter

Defined in: ifcopenshell-js/src/geom/iterator.ts:12

numThreads?¶

optional numThreads?: number

Defined in: ifcopenshell-js/src/geom/iterator.ts:11

Type Aliases¶

IteratorFilter¶

IteratorFilter = number[] | string[]

Defined in: ifcopenshell-js/src/geom/iterator.ts:7

Entity ids or IFC type names, matching the native include/exclude filters.

SettingInput¶

SettingInput = boolean | number | string | number[] | string[]

Defined in: ifcopenshell-js/src/geom/settings.ts:6

Value accepted by a geometry setting setter.

Functions¶

createShape()¶

createShape(settings, instance, representation?, geometryLibrary?): IfcOpenshellGeomElement | null

Defined in: ifcopenshell-js/src/geom/shape.ts:7

Create one shape. Load the schema mapping and geometry kernel beforehand.

Parameters¶

settings¶

Settings

instance¶

EntityInstance

representation?¶

EntityInstance

geometryLibrary?¶

string = 'opencascade'

Returns¶

IfcOpenshellGeomElement | null

geom¶

Classes¶

Iterator¶

Extends¶

Constructors¶

Constructor¶

Parameters¶

settings¶

file¶

options?¶

Returns¶

Overrides¶

Properties¶

ptr¶

Inherited from¶

settings¶

Methods¶

[asyncDispose]()¶

Returns¶

Inherited from¶

[dispose]()¶

Returns¶

Inherited from¶

boundsMax()¶

Returns¶

Inherited from¶

boundsMin()¶

Returns¶

Inherited from¶

computeBounds()¶

Parameters¶

with_geometry¶

Returns¶

Inherited from¶

create()¶

Returns¶

Inherited from¶

destroy()¶

Returns¶

Inherited from¶

dispose()¶

Returns¶

Inherited from¶

file()¶

Returns¶

Inherited from¶

get()¶

Returns¶

Inherited from¶

getAsBrepElement()¶

Returns¶

Inherited from¶

getAsSerializedElement()¶

Returns¶

Inherited from¶

getAsTriangulationElement()¶

Returns¶

Inherited from¶

getLog()¶

Returns¶

Inherited from¶

getNative()¶

Returns¶

Inherited from¶

getObject()¶

Parameters¶

id¶

Returns¶

Inherited from¶

getTaskItems()¶

Returns¶

Inherited from¶

getTaskProducts()¶

Returns¶

Inherited from¶

hadErrorProcessingElements()¶

Returns¶

Inherited from¶

initialize()¶

Returns¶