Reference Source
public class | source

GroundShadowPlugin

Extends:

Plugin → GroundShadowPlugin

A Viewer plugin that provides methods for visualizing IfcBuildingStoreys.

[Run this example]

Overview

Constructor Summary

Public Constructor
public

constructor(viewer: Viewer, cfg: Object)

Member Summary

Public Members
public

A ModelGroundShadow for each model.

Method Summary

Public Methods
public

Destroys this GroundShadowPlugin.

Inherited Summary

From class Plugin
public

ID for this Plugin, unique within its Viewer.

public

The Viewer that contains this Plugin.

public

Destroys this Plugin and removes it from its Viewer.

public

error(msg: String)

Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.

public

fire(event: String, value: Object)

Fires an event at this Plugin.

public

log(msg: String)

Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.

public

on(event: String, callback: Function)

Subscribes to an event fired at this Plugin.

public

warn(msg: String)

Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.

Public Constructors

public constructor(viewer: Viewer, cfg: Object) source

Creates this Plugin and installs it into the given Viewer.

Override:

Plugin#constructor

Params:

NameTypeAttributeDescription
viewer Viewer

The Viewer.

cfg Object

Plugin configuration.

cfg.id String
  • optional
  • default: "GroundShadow"

Optional ID for this plugin, so that we can find it within Viewer#plugins.

Public Members

public groundShadows: {String: ModelGroundShadow} source

A ModelGroundShadow for each model.

These are created and destroyed automatically as models are loaded and destroyed.

Public Methods

public destroy() source

Destroys this GroundShadowPlugin.

Override:

Plugin#destroy