API Docs

Class: Sprite

BIM.Sensors. Sprite

Generates sensor geometry using a THREE.Sprite.

                               , - ~ ' ~ - ,
                           , '               ' ,
                         ,'                     ',
                        ,                         ,
   +--.                ,                           ,
   |   +-------------- ,            TYPE           ,
   +--'                ,                           ,
                        ,                         ,
                         ,                       ,
                          ',                   ,'
                             ' - , _   _ , - '
                                     '

                         +-------------------------+
                         |                         |
   +--.                 /                          |
   |   +---------------            CANVAS          |
   +--'                 \                          |
                         |                         |
                         +-------------------------+

new Sprite( [config] [, subType])

Creates a new sprite-based sensor representation.

Parameters:
Name Type Argument Description
config object <optional>

An optional configuration object.
Properties of config:
Name Type Argument Description
name string <optional>

A human-readable name for this component.
uuid string <optional>

A universally unique identifier of this component.
productRef string <optional>

The product reference number or identifier.
description string <optional>

A brief product or type description.
supplier BIM.Supplier <optional>

An optional supplier details data object.
material THREE.Material <optional>

The material to assign to the sensor.
subType BIM.SENSOR <optional>

The type of sensor metric.
Author:
  • drajmarsh

Extends

Members

:string

className <readonly>

The name of the subclass for this object instance.

This name must match the name of this class within the PD.Registry. Thus, the base implementation simply references this.constructor.getClassName() to ensure that this is always the case even for subclasses. As a result, there is rarely any need to override this method.

This property is used when copying, storing and exporting data for subclass instances to ensure that they are recreated as instances of the right class.

Type
  • string
Inherited From:
Overrides:
:string

description

A brief product or type description, defaults to an empty string.

This description is typically used to provide additional information about the product to other team members, such as its reasons for selection. important features, specifications and/or intended use.

Type
  • string
Inherited From:
Overrides:
:number

directionality

The directionality.

Type
  • number
Inherited From:
Overrides:
:string

displayName <readonly>

The name to display for this class within the user interface.

Type
  • string
Inherited From:
Overrides:
:number

falloff

The radius within which the sensor is fully sensitive in mm, defaults to 3600mm or 12'.

Type
  • number
Inherited From:
Overrides:
:string

iconName <readonly>

The name of the SVG icon to associate with this object instance.

This name should match the name of the icon associated with this class within the PD.Registry. Thus, the default implementation simply references this.constructor.getClassName() to ensure that this is always the case, even for subclasses. However, you can override this property if you want a different icon dependant on other properties of the class instance, as shown in the example below.

Type
  • string
Inherited From:
Overrides:
Example
// Overriding the icon name.

MyElements.Table = class extends PD.Base {
    /// ...
    get iconName() {
        if (this.hasRoundTop) return 'MyElements.Table.Round';
        return this.constructor.getClassName();
    };
    /// ...
 };
:boolean

isComponent <readonly>

A flag identifying this object as a shared BIM component.

Type
  • boolean
Inherited From:
Overrides:
:boolean

isLocked

Whether or not this component's parameters are fixed.

This property is used by the UI and framework to indicate that the component's parameters are fixed and therefore not editable. It is typically set by a 3rd-party manufacturer or supplier on products that they can only provide in one configuration.

For example, there is no point specifying a particular manufacturer's fridge and then adjusting its width to fit a hole in your cabinetry if that manufacturer cannot actually supply a fridge of that width.

Thus, when this property is true, you will not be able to edit the parameters, but you can always duplicate the component (or its configuration), but without the supplier details if you really do want to modify it.

Type
  • boolean
Inherited From:
Overrides:
:boolean

isSensorType <readonly>

A flag identifying this object as a sensor type.

Type
  • boolean
Inherited From:
Overrides:
:boolean

isSensorTypeSprite <readonly>

A flag identifying this object as a sprite-based sensor type.

Type
  • boolean
:string

name

A human-readable name for this item instance.

Type
  • string
Inherited From:
Overrides:
:string

productRef

The product reference number or identifier, defaults to an empty string.

The product reference is typically used to store a serial number, model number, SKU or other identifier provided by the manufacturer or supplier to uniquely identify this product.

Type
  • string
Inherited From:
Overrides:
:number

radius

The radius within which the sensor is fully sensitive in mm, defaults to 1200mm or 4'.

Type
  • number
Inherited From:
Overrides:
:number

sides

The number of sides creeting the shape of the sensor.

Values less than three will result in a default circular shape. Three sides will obviously be a triangle, four a square, five a pentagon, etc.

Type
  • number
Inherited From:
Overrides:
:number

size

The diameter of the sensor plate, in mm.

Type
  • number
Inherited From:
Overrides:
:THREE.Material

spriteMaterial

Stores the sprite added to the scene to indicate the sprite.

Type
  • THREE.Material
:number

subType <readonly>

An element-specific subtype.

Type
  • number
Inherited From:
Overrides:
:string

supplier

The product supplier/manufacturer, defaults to null.

This property contains details of the supplier or manufacturer of this product or component. Multiple components can share the same supplier instance to avoid unnecessary duplication of data.

Type
  • string
Inherited From:
Overrides:
:boolean

swapSides

Whether or not to flip the inside/outside direction when not closed.

Type
  • boolean
Inherited From:
Overrides:
:number

thickness

The thickness of the sensor plate from the wall surface, in mm.

Type
  • number
Inherited From:
Overrides:
:string

uuid

A universally unique identifier for the item instance.

Type
  • string
Inherited From:
Overrides:
:number

verticalOffset

The vertical offset of the sensor indicator, in mm.

Type
  • number
Inherited From:
Overrides:
:object

icon <static>

The icon associated with this class in the PD.Registry.

See PD.Base.icon for more information on this object format.

Type
  • object

Methods

clone()

Creates a copy of this instance with different name and uuid.

Inherited From:
Overrides:
Returns:

Returns a new instance with copied values.

Type
PD.Base | null

computeSensitivity(sensor, point, raytrace)

Calculates the sensitivity of the sensor at the given spatial point.

Parameters:
Name Type Description
sensor BIM.Sensor

The sensor this component controls.
point THREE.Vector3

The position to compute the sensitivity for.
raytrace object

The results of a ray-trace between point and sensor.
Inherited From:
Overrides:
Returns:

Returns the relative sensitivity as a fraction (0 to 1).

Type
number

generateSensor(sensor, pos, offset)

Rebuilds the geometry of this sensor ready for visualisation.

Parameters:
Name Type Description
sensor BIM.Sensor

The sensor element to rebuild.
pos BIM.Junction

The 3D position of the sensor.
offset number

The offset distance in the local Z axis.
Overrides:
Returns:

Returns this sensor to support method chaining.

Type
BIM.Sensor

generateSurfacePlate(sensor, pos, size, offset)

Generates a surface plate for this sensor ready for visualisation.

Parameters:
Name Type Description
sensor BIM.Sensor

The sensor element.
pos THREE.Vector3

The position of the sensor.
size number

The size of the base plate, in mm.
offset number

The offset distance in the local Z axis.
Inherited From:
Overrides:
Returns:

Returns this sensor to support method chaining.

Type
BIM.Sensor

getNameAndSupplierParameters()

Provides a list of dynamic parameter groups for the component name, description and supplier.

See the PD.Base#getDynamicParameters method for more details.

Inherited From:
Overrides:
Returns:

Returns an array of PD.ParamGroup objects.

Type
Array

hasMethod(component, methodName)

Determines if this component has a callable method with the given name.

This method is useful for checking if the component has a particular method before attempting to call it, thereby avoiding potential runtime errors. It is used within the framework to check for the presence of life-cycle methods in an element's type component before delegating them.

Parameters:
Name Type Description
component BIM.Component

The component to check.
methodName string

The case-sensitive name of the function/method to check for.
Inherited From:
Overrides:
Returns:

Returns true if the component is valid and has the function name as a method, otherwise false.

Type
boolean

isCompatibleWith(obj)

Determines if this component can be added to the given entity.

Whilst a small number of components may be compatible with multiple entity types, most components are designed to be used only by a specific entity type, and will not allow you to assign them to an incompatible entity.

Parameters:
Name Type Description
obj BIM.ENTITY | BIM.Entity

The entity type or object instance to check for compatibility with.
Inherited From:
Overrides:
Returns:

Returns true if the component can be added to the object, otherwise false.

Type
boolean

updateDynamicParameters(param, group)

Sets the dynamic parameter value and returns true if it changed.

Most subclasses don't need to override this method as it automatically detects changes and rebuilds the element/component and model when required. However, if you do need to add your own custom logic or intercept the return value, please read the following examples carefully and use whichever best suits your needs.

NOTE: When overriding this method, you may not want to call super.updateDynamicParameters(param, group) as the parent class may have added its own logic that may interfere with what you want to do. Instead, either use the static PD.Base.updateDynamicParametersOnHost method to check if the value changed, or base it on the third example which replicates the code in that static method.

Parameters:
Name Type Description
param PD.Parameter

The dynamic parameter that changed.
group PD.ParamGroup

The group that the dynamic parameter belongs to.
Inherited From:
Overrides:
Returns:

Returns true if the value actually changed.

Type
boolean
Examples
updateDynamicParameters(param, group) {

     /// When you want parent class to use its logic.
     if (super.updateDynamicParameters(param, group)) {
         if (param.name == 'i_am_special') this.doSomethingSpecial();
         return true;
     }

     return false;

 };
updateDynamicParameters(param, group) {

     /// When you don't want parent to handle parameter updates.
     if (PD.Base.updateDynamicParametersOnHost(param, group, this)) {

         /// Invalidate geometry.
         if (this.typeComponent) {
             ++this.typeComponent.updateIndex;
         }

         /// Rebuild element.
         this.hasChanged = true;
         this.update();

         /// Only update site mesh.
         if (this.onlyUsesSiteMesh) {
             const level = this.level;
             if (level) { // Don't trigger whole level update.
                 level.rebuildSiteMesh();
                 PD.GlobalActions.redrawAndUpdateSelection();
                 return false;
             }
         }

         return true;

     }

     return false;

 };
updateDynamicParameters(param, group) {

     /// The following three lines of code replicate
     /// `PD.Base.updateDynamicParametersOnHost()`, which you can
     /// use if you need to access `target` without having to call
     /// `group.getTarget() || this` twice.

     const target = group.getTarget() || this;
     target.checkDynamicParameter(param, group, this);
     if (param.setValueOnHostIfDifferent(target, group, this)) {

         /// You can now use `target`.
         if (target.myOwnMeshThatIsUpdatedDuringRebuild) {

             /// Rebuild element.
             this.hasChanged = true;
             this.update();

             /// If no level meshes or other elements are affected,
             /// simply update the target locally and return false.
             this.myOwnMeshThatIsUpdatedDuringRebuild.update();

             /// Update selection meshes if the
             /// element's highlight geometry changed.
             PD.GlobalActions.updateSelectionMeshes();
             return false;

         }

         return true;

     }

     return false;

 };

getClassDescription() <static>

A brief description of this class to accompany its icon.

Returns:

Returns a brief description.

Type
string

getClassName() <static>

The name of this class within the PD.Registry.

See PD.Base.getClassName for more details as this is required for use with the PD.Registry.

Returns:

Returns the registered name of this class.

Type
string

getDisplayName() <static>

The name to display within the user interface.

Returns:

Returns the display name.

Type
string

getSpriteImage(subType) <static>

Retrieves a shared image for sprite texture mapping.

Parameters:
Name Type Description
subType BIM.SENSOR

The type of sensor.
Returns:

Returns a string containing the data URL for the shared image.

Type
DOMStruing

getSpriteMaterial(subType) <static>

Retrieves a shared material for sprite texture mapping.

Just in case the image is not already loaded via a page element, this method will attempt to load the texture as well.

Parameters:
Name Type Description
subType BIM.SENSOR

The type of sensor.
Returns:

Returns the shared material.

Type
THREE.SpriteMaterial

registerSpriteIcons() <static>

Registers sprite icons and image maps for each sensor type.

subType() <static>

Retrieves the sub-type of terminal this class represents.

See BIM.Component#subType for more details on this static method.

Returns:

Returns the sub-type enumerator of this class.

Type
BIM.SENSOR