API Docs

Class: KeepSpatialPositionXY

BIM.Relation. KeepSpatialPositionXY

A relationship where a junction lies on the XY path segment of another.

This relationship is used by dropped ceilings and raised floors to stay the same distance from one or two closest path segments.

new KeepSpatialPositionXY(element, junction, space)

Creates a new relationship between a junction and space.

Parameters:
Name Type Description
element BIM.Element

The element the follower junction belongs to.
junction BIM.Junction

The junction that lies on the path segment of the leader.
space BIM.Space

The space the junction needs to track.
Author:
  • drajmarsh

Extends

Members

:Array.<object>

closestJunctions

Stores the closest junction data.

Type
  • Array.<object>
:BIM.Element

hostElement

The element hosting the items in the relationship.

Type
Inherited From:
Overrides:
:BIM.Junction

hostJunction

The junction that tries to maintain position.

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:
:BIM.Junction

linkedJunction

The junction whose position is followed.

Type
:BIM.Space

space

The space to remain inside.

Type
:number

type

The type of relationship.

Type
  • number
Inherited From:
Overrides:

Methods

stillValid()

Checks that the relationship is still valid.

Inherited From:
Overrides:
Returns:

Returns true if the relationship is still valid.

Type
boolean

update(element)

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
element BIM.Element

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

Returns true if something changed and needs updating.

Type
boolean