API Docs

Class: SurfaceMounted

BIM.Relation. SurfaceMounted

A relationship where an element lies on the wall surface of a junction.

This relationship is used by sensors, switches and light fittings that lie on the surface of a wall extruded from a wall/space junction.

new SurfaceMounted(element, junction)

Creates a new relationship between two tracking junctions.

Parameters:
Name Type Description
element BIM.Element

The element that follows the junction.
junction BIM.Junction

The junction defining the path segment.
Author:
  • drajmarsh

Extends

Members

:number

distance

The distance from closest end of the segment.

Type
  • number
:BIM.Element

hostElement

The element hosting the items in the relationship.

Type
Inherited From:
Overrides:
:BIM.Junction

hostJunction

The junction whose surface the element is mounted on.

Type
:boolean

isActive

Whether or not the relationship is active.

Type
  • boolean
Inherited From:
Overrides:
:boolean

isRelation <readonly>

A flag identifying this object as a relationship.

Type
  • boolean
Inherited From:
Overrides:
:number

type

The type of relationship.

Type
  • number
Inherited From:
Overrides:
:number

u

The distance along the junction line segment.

This is a fractional value between 0 and 1 based on the current length of the segment.

Type
  • number
:number

v

The distance up the wall.

This is a fractional value between 0 and 1 based on the current height of the segment facet.

Type
  • number

Methods

stillValid()

Checks that the relationship is still valid.

Inherited From:
Overrides:
Returns:

Returns true if the relationship is still valid.

Type
boolean

update(The)

Updates the relationship.

Any party to the relationship should be able to update the relationship by calling this method with itself as the argument.

Parameters:
Name Type Description
The BIM.Element

element that is updating the relationship.
Inherited From:
Overrides:
Returns:

Returns true if something changed and needs updating.

Type
boolean