FloorplanManager

class Communicator.FloorplanManager()

Main interface into the 2D floorplan functionality for the viewer. Can show a 2-dimensional floorplan of a BIM-enabled model. The floorplan display will include an avatar that represents the camera position of the 3D view.


Methods

activate

FloorplanManager.activate()

Activate the floorplan overlay.

Return type

Promise <void>

deactivate

FloorplanManager.deactivate()

Deactivate the floorplan overlay. Once explicitly deactivated via this call, auto-activation will be suppressed for any new model that is loaded. Auto-activation can be reenabled by calling setAutoActivate

Return type

Promise <void>

getAvatarNodeId

FloorplanManager.getAvatarNodeId()

Gets the NodeId of the floorplan avatar.

Return type

NodeId | null

getConfiguration

FloorplanManager.getConfiguration()

Returns a copy of the current floorplan configuration.

Return type

FloorplanConfig()

getCurrentFloorNodeId

FloorplanManager.getCurrentFloorNodeId()

Gets the NodeId of the current storey.

Return type

NodeId | null

getFloorLock

FloorplanManager.getFloorLock()

Returns true if displayed floor has been locked with setFloorLock

Return type

boolean

insideOverlay

FloorplanManager.insideOverlay(point)

Returns true if the given point is inside the floorplan overlay and false otherwise.

Arguments
Return type

boolean

isActive

FloorplanManager.isActive()

Returns true if the FloorplanManager is fully active.

Return type

boolean

setAutoActivate

FloorplanManager.setAutoActivate(autoActivate)

Sets the auto-activate capability for any models loaded after this call. See FloorplanConfig.autoActivate for detailed information.

Arguments
Return type

Promise <void>

setAvatarColor

FloorplanManager.setAvatarColor(color)

Sets the avatar primary color. See FloorplanConfig.avatarColor for detailed information.

Arguments
Return type

Promise <void>

setAvatarOpacity

FloorplanManager.setAvatarOpacity(opacity)

Sets the avatar opacity. See FloorplanConfig.avatarOpacity for detailed information.

Arguments
  • opacity (number()) –

Return type

Promise <void>

setAvatarOutlineColor

FloorplanManager.setAvatarOutlineColor(color)

Sets the avatar outline color. See FloorplanConfig.avatarOutlineColor for detailed information.

Arguments
Return type

Promise <void>

setAvatarScale

FloorplanManager.setAvatarScale(scale)

Sets the avatar scale. See FloorplanConfig.avatarScale for detailed information.

Arguments
  • scale (number()) –

Return type

Promise <void>

setBackgroundColor

FloorplanManager.setBackgroundColor(color)

Sets the overlay background color. See FloorplanConfig.backgroundColor for detailed information.

Arguments
Return type

Promise <void>

setBackgroundOpacity

FloorplanManager.setBackgroundOpacity(opacity)

Sets the overlay background opacity. See FloorplanConfig.backgroundOpacity for detailed information.

Arguments
  • opacity (number()) –

Return type

Promise <void>

setBorderColor

FloorplanManager.setBorderColor(color)

Sets the overlay border color. See FloorplanConfig.borderColor for detailed information.

Arguments
Return type

Promise <void>

setBorderOpacity

FloorplanManager.setBorderOpacity(opacity)

Sets the overlay border opacity. See FloorplanConfig.borderOpacity for detailed information.

Arguments
  • opacity (number()) –

Return type

Promise <void>

setConfiguration

FloorplanManager.setConfiguration(config)

Updates the floorplan to use the given configuration. This function allows the user to set all configuration values with a single operation. There are also set<config-value>() functions for easily setting individual configuration values.

Note that when using this function, all settings in the given configuration are used and thus overwrite any individual settings changed with a prior set<config-value>() call.

All values from the passed configuration will be copied as part of this operation.

Arguments
Return type

Promise <void>

Note that when using this function, all settings in the given configuration are used and thus overwrite any individual settings changed with a prior set<config-value>() call.

All values from the passed configuration will be copied as part of this operation.

setCustomAvatar

FloorplanManager.setCustomAvatar(customAvatarNodeId)

Sets a custom avatar. See FloorplanConfig.customAvatar for detailed information.

Arguments
  • customAvatarNodeId (NodeId | null) –

Return type

Promise <void>

setFixedAvatarScale

FloorplanManager.setFixedAvatarScale(fixedScale)

Sets the avatar size to fixed scale. See FloorplanConfig.fixedAvatarScale for detailed information.

Arguments
  • fixedScale (boolean()) –

Return type

Promise <void>

setFloorLock

FloorplanManager.setFloorLock(lock)

Locks floorplan to current floor such that changing floors will not change the displayed floorplan.

Arguments
  • lock (boolean()) –

Return type

Promise <void>

setFloorplanOrientation

FloorplanManager.setFloorplanOrientation(orientation)

Sets the floorplan display orientation. See FloorplanConfig.floorplanOrientation for detailed information.

Arguments
Return type

Promise <void>

setOverlayAnchor

FloorplanManager.setOverlayAnchor(anchor)

Sets the anchor position of the floorplan overlay window. See FloorplanConfig.overlayAnchor for detailed information.

Arguments
Return type

Promise <void>

setOverlayFeetPerPixel

FloorplanManager.setOverlayFeetPerPixel(feetPerPixel)

Sets the overlay scaling. See FloorplanConfig.overlayFeetPerPixel for detailed information.

Arguments
  • feetPerPixel (number()) –

Return type

Promise <void>

setOverlayOffset

FloorplanManager.setOverlayOffset(offset)

Sets the offset position of the floorplan overlay window. See FloorplanConfig.overlayOffset for detailed information.

Arguments
Return type

Promise <void>

setOverlaySize

FloorplanManager.setOverlaySize(size, widthUnits, heightUnits)

Sets the size of the floorplan overlay window. See FloorplanConfig.overlaySize for detailed information.

Arguments
Return type

Promise <void>

setTrackCameraEnabled

FloorplanManager.setTrackCameraEnabled(enabled)

Sets the floorplan tracking mode. See FloorplanConfig.trackCameraEnabled for detailed information.

Arguments
  • enabled (boolean()) –

Return type

Promise <void>

setUseTightBoundings

FloorplanManager.setUseTightBoundings(tightBoundings)

Makes floorplans use tight boundings during creation which can result in a better fit for the overlay. This involves recreating any already existing floorplans. This can be significantly more time consuming than using loose boundings if your floors are complex. Defaults to false.

Arguments
  • tightBoundings (boolean()) –

Return type

Promise <void>

setZoomLevel

FloorplanManager.setZoomLevel(zoomLevel)

Sets the overlay zoom level. See FloorplanConfig.zoomLevel for detailed information.

Arguments
  • zoomLevel (number()) –

Return type

Promise <void>

snapAvatarToPoint

FloorplanManager.snapAvatarToPoint(point)

Moves the camera such that the avatar will appear at the provided point on the overlay. This is only available when the floorplan is not tracking the camera.

Arguments
  • point (Point2()) – Point in canvas within overlay

Return type

void