Documentation - v20.0.0-dev
    Preparing search index...

    One point of a MeasureLine: an engine object of two parts, its head (a box between the ends of the line, a cone at an end, pointing along its segment) and the segment from the anchor before it (a line SEGMENT_WIDTH_PIXELS wide; none for the first anchor), drawn over the objects and under the sprites (MeshLayer.Layer3). Its sprite shows that segment's distance. Its engine object is made by its controller, again when its type or its place in the line changes.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _proxies: readonly MeshProxy[] = NO_PROXIES

    Its engine objects (one, or none); BimMesh has one per geometry type.

    anchorType: AnchorType = 'box'

    Box between the ends of the line, arrow (cone) at an end.

    children: SceneObject[] = ...
    controller: SceneObjectController<SceneObject> | null = null

    The controller handling it while it is in the scene, set when that controller adds it (see SceneObjectController.addObject); null out of the scene.

    isMeasureLineAnchor: true
    isRaycastable: boolean = true

    Whether the viewport's picking may hit it.

    isSceneMesh: true
    isSceneObject: true
    isSelectable: boolean = true

    Indicates whether the object is selectable in the scene

    isTransformable: boolean = true
    matrix: Matrix4 = ...

    Its world matrix: its head's (its position, its cone's direction).

    measureLine: MeasureLine

    The line it belongs to.

    name: string = ''
    parent: SceneObject | null = null
    savedIndex: number | null = null

    Its index in its line, saved when it is removed, to insert it back there.

    The sprite showing the distance of the segment before it.

    userData: Record<string, any> = {}
    uuid: string

    Unique identifier of the object

    TRANSPARENCY_THRESHOLD: 0.95

    Accessors

    • get diffuseColor(): ColorRepresentation

      Its diffuse colour: of its first part, set on every part.

      Returns ColorRepresentation

    • set diffuseColor(value: ColorRepresentation): void

      Parameters

      Returns void

    • get edgesColor(): ColorRepresentation

      The colour of its sharp edges: of its first part, set on every part.

      Returns ColorRepresentation

    • set edgesColor(value: ColorRepresentation): void

      Parameters

      Returns void

    • get edgesOpacity(): number

      The opacity of its edges; not drawn yet.

      Returns number

    • set edgesOpacity(value: number): void

      Parameters

      • value: number

      Returns void

    • get edgesVisible(): boolean

      Whether its sharp edges are shown (see MeshProxy.edgesVisible). Its own state, its edges drawn only when its controller's renderState shows them too.

      Returns boolean

    • set edgesVisible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get emissiveColor(): ColorRepresentation

      Its emissive colour: of its first part, set on every part.

      Returns ColorRepresentation

    • set emissiveColor(value: ColorRepresentation): void

      Parameters

      Returns void

    • get facesVisible(): boolean

      Whether its faces are shown (see MeshProxy.facesVisible): without, edges only. Its own state, its faces drawn only when its controller's renderState shows them too.

      Returns boolean

    • set facesVisible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get hasSegment(): boolean

      Whether its engine object has the segment before it.

      Returns boolean

    • get hover(): boolean

      Whether the pointer is over it; not drawn yet.

      Returns boolean

    • set hover(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ignoreCuttingPlanes(): boolean

      Whether the cutting planes leave it whole (see MeshProxy.ignoreCuttingPlanes): every part drawn and picked as without planes.

      Returns boolean

    • set ignoreCuttingPlanes(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get index(): number

      Returns number

    • get isFirst(): boolean

      Returns boolean

    • get isLast(): boolean

      Returns boolean

    • get isTransparent(): boolean

      Returns boolean

    • get layer(): MeshLayer

      The layer it is drawn in (the engine's MeshLayer, Layer1 by default): a layer is drawn over the layers below it, whatever their depth. Given to its engine objects; kept only by an object without.

      Returns MeshLayer

    • set layer(value: MeshLayer): void

      The layer it is drawn in (the engine's MeshLayer, Layer1 by default): a layer is drawn over the layers below it, whatever their depth. Given to its engine objects; kept only by an object without.

      Parameters

      Returns void

    • get lineStyle(): LineStyle | null

      The style of its segments, its lines or its sharp edges (see LineStyle): ribbons of a width and dashes, in pixels; null when drawn 1 pixel wide. Read from its first part, set on every part of its engine objects, and on those linked later (e.g. a BimMesh's 2D one).

      Returns LineStyle | null

    • set lineStyle(value: LineStyle | null): void

      Parameters

      Returns void

    • get metalness(): number

      Its metalness, in 0..1: of its first part, set on every part.

      Returns number

    • set metalness(value: number): void

      Parameters

      • value: number

      Returns void

    • get opacity(): number

      Its opacity, in 0..1: of its first part, set on every part.

      Returns number

    • set opacity(value: number): void

      Parameters

      • value: number

      Returns void

    • get proxies(): readonly MeshProxy[]

      Its engine objects: one, or none without geometry.

      Returns readonly MeshProxy[]

    • get roughness(): number

      Its roughness, in 0..1: of its first part, set on every part.

      Returns number

    • set roughness(value: number): void

      Parameters

      • value: number

      Returns void

    • get selected(): boolean

      Whether it is selected; its controller's onObjectSelectedChanged tells a change.

      Returns boolean

    • set selected(value: boolean): void

      Whether it is selected; its controller's onObjectSelectedChanged tells a change.

      Parameters

      • value: boolean

      Returns void

    • get type(): string

      Returns string

    • get visible(): boolean

      Whether it is shown; its controller's onObjectVisibilityChanged tells a change.

      Returns boolean

    • set visible(value: boolean): void

      Whether it is shown; its controller's onObjectVisibilityChanged tells a change.

      Parameters

      • value: boolean

      Returns void

    • get xRay(): boolean

      Whether it is seen through (see MeshProxy.xRay): its own state, drawn x-ray too when its controller's renderState is.

      Returns boolean

    • set xRay(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    Methods

    • Its engine objects described (getJsonFromMeshProxy), in order.

      Returns Record<string, unknown>

    • The proxy its material getters read; null without any, or once removed from the engine.

      Returns MeshProxy | null

    • Its state for toJson: a subclass adds its own after these.

      Returns Record<string, unknown>

    • Its material (named after its first part's, '' without a name), its edges', then its engine objects (_getEngineJson).

      Returns Record<string, unknown>

    • Whether this engine object of it is of the geometry type it shows (BimMesh shows one).

      Parameters

      Returns boolean

    • Whether this engine object of it is drawn: its own visibility and its controller's.

      Parameters

      Returns boolean

    • Sets the proxy's owner and its state on it (after its geometry type is known).

      Parameters

      Returns void

    • Returns void

    • The bounds of its engine object (of its active geometry type for a BimMesh), shown or not; empty without any, or once removed from the engine.

      Parameters

      Returns Box3

    • The parts of its engine object, at its place: its head, by its type, and the segment before it unless it is the first anchor (placed by update).

      Returns InputMeshPart[]

    • Returns void

    • Draws its head and segment in color, flat.

      Parameters

      • color: string

      Returns void

    • Places it, its neighbour segments and sprites following (unless updateMeasureLine is false, while its line places it).

      Parameters

      • matrix: Matrix4
      • updateMeasureLine: boolean = true

      Returns void

    • Links its engine object, the proxy's owner set to it, and sets its state on it.

      Parameters

      Returns void

    • Shows or hides a box of its bounds in helperGroup, as they are when shown.

      Parameters

      • helperGroup: Group
      • value: boolean

      Returns void

    • Shows or hides the normals of its shown engine objects in helperGroup, as they are when shown (see the engine's MeshNormalsHelper).

      Parameters

      • helperGroup: Group
      • value: boolean

      Returns void

    • Everything about it for a debug view (the infobox's 3D data), in sections and in this order: identity, state, transform, its type's own sections (_getTypeJson: a mesh's material, edges and engine objects), userData, and its children by name, uuid and type. Not a persistence format.

      Returns Record<string, any>

    • Places its segments (before and after it) and their sprites, and its line's total.

      Returns void

    • Places the segment after it.

      Returns void

    • Places the segment before it.

      Returns void