API Docs

Class: Handles

BIM. Handles

A core class for parametrically generating handle geometry.

This class provides basic parameters for defining a handle on an aperture panel. Other classes can build in this infrastructure to define additional parameters and generate more detailed and specific parametric handles.

This class also provides some static methods that can be used to generate handles of different types, which can be used by other classes to generate handles in situations where a BIM.Handles instance is not appropriate, or reused as required by derived classes.

new Handles( [config] [, typeName])

Creates a new basic handle 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.
type number <optional>

The style of the handle, defaults to a pull handle.
width number <optional>

The width of the handle in mm, defaults to 1" or 25mm.
length number <optional>

The length of the handle in mm, defaults to 6" or 150mm.
thickness number <optional>

The thickness of the handle material in mm, defaults to 0.5" or 12mm.
spacing number <optional>

The spacing of the handle from the surface in mm, defaults to 1" or 25mm.
offsetHor number <optional>

The horizontal offset of the handle from its center in mm, defaults to zero.
offsetVer number <optional>

The vertical offset of the handle from its center in mm, defaults to zero.
typeName string <optional>

An additional parameter typically used by subclasses to set the component type name without modifying the config object.
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:
:string

displayName <readonly>

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

Type
  • string
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

isHandleType <readonly>

A flag identifying this object as a window type.

Type
  • boolean
: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:
:number

length

The length of the handle in mm, defaults to 6" or 150mm.

Type
  • number
:string

name

A human-readable name for this item instance.

Type
  • string
Inherited From:
Overrides:
:number

offsetHor

The horizontal offset of the handle from its center in mm, defaults to zero.

Type
  • number
:number

offsetVer

The vertical offset of the handle from its center in mm, defaults to zero.

Type
  • number
: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

spacing

The spacing of the handle from the surface in mm, defaults to 1" or 25mm.

Type
  • number
: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:
:number

thickness

The thickness of the handle material in mm, defaults to 0.5" or 12mm.

Type
  • number
:number

type

The type or style of the handle, defaults to a pull handle.

Type
  • number
:string

uuid

A universally unique identifier for the item instance.

Type
  • string
Inherited From:
Overrides:
:number

width

The width of the handle in mm, defaults to 1" or 25mm.

Type
  • number
: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

addToShell(coords, shell [, side] [, flip])

Rebuilds the geometry of a handle ready for visualisation.

This method adds the handle surfaces to the given aperture's shell.

Parameters:
Name Type Argument Description
coords PD.LocalCoordinates

The local coordinate system to use.
shell PD.Shell

The shell to add the handle geometry to.
side PD.SIDE <optional>

Which side the handle projects out to, defaults to outside.
flip boolean <optional>

Whether to reverse facet orientations.
Returns:

Returns an array of facets for the handle added to the shell.

Type
Array

checkDynamicParameter(param, group, host)

Checks the allowable range of parameter values.

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

Parameters:
Name Type Description
param PD.Parameter

The parameter that is being interactively changed.
group PD.ParamGroup

The group that the dynamic parameter belongs to.
host BIM.Entity

The host entity (typically an aperture) this component is controlling.
Inherited From:
Overrides:
Example
checkDynamicParameter(param, group, host) {

     switch (param.name) {

         case 'height':
             if (param.value < 1.0) param.value = 1.0;
             break;

         case 'width':
         case 'length':
             if (param.value < 100.0) param.value = 100.0;
             if (this.standardBedSize > 0) { // If not custom.
                 group.setParameterValue('standardBedSize', 0);
                 this.standardBedSize = 0; // Make it custom.
             }
             break;

         case 'standardBedSize': {
                 const std_bed = this.getStandardBedSize(Math.round(param.value));
                 if (std_bed != null) {
                     const [ width, length ] = (PD.DIMENSION.useImperial) ? std_bed.sizeImperial : std_bed.sizeMetric;
                     this.width = PD.Utils.toNumber(width, this.width);
                     group.setParameterValue('width', this.width);
                     this.length = PD.Utils.toNumber(length, this.length);
                     group.setParameterValue('length', this.length);
                 }
             } break;

       }

 };

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

fromJSON(data)

Safely copy properties from a source object.

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

Parameters:
Name Type Description
data object

The source object containing data to copy.
Overrides:
Returns:

Returns this instance to support method chaining.

Type
BIM.Handles

getDynamicParameters(host [, title])

Provides a list of dynamic parameter groups for this handle type.

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

Parameters:
Name Type Argument Description
host BIM.Entity

The host entity (typically an aperture) that this component is part of.
title string <optional>

An optional title for the parameter group.
Inherited From:
Overrides:
Returns:

Returns an array of PD.ParamGroup objects.

Type
Array
Example
getDynamicParameters(host) {
     return [
         new PD.ParamGroup({
             name: 'mainParams',
             title: 'Table Parameters',
             target: this,
             params: [
                 new PD.Parameter({ name: 'height', title: 'Table Height', value: this.height, paramType: PD.ParamType.SmallDistance, description: 'The height from floor level to the top of the table.' }),
                 new PD.Parameter({ name: 'size', title: 'Table Top Size/Diameter', value: this.size, paramType: PD.ParamType.Distance, description: 'The size of the table top when not defined by a closed path.' }),
                 new PD.Parameter({ name: 'thickness', title: 'Table Top Thickness', value: this.thickness, paramType: PD.ParamType.SmallDistance, description: 'The thickness of the table top surface.' }),
                 new PD.Parameter({ name: 'offset', title: 'Offset From Path', value: this.offset, paramType: PD.ParamType.SmallDistance, description: 'The offset distance from the table path.' }),
                 new PD.Parameter({ name: 'swapSides', title: 'Swap Sides', value: this.swapSides, paramType: PD.ParamType.Boolean, description: 'Reverse the direction of the table relative to its path.' }),
                 new PD.Parameter({ name: 'isRound', title: 'Round Table', value: this.isRound, paramType: PD.ParamType.Boolean, description: 'Whether or not the table surface is round.'  }),
             ]
         }),
         new PD.ParamGroup({
             name: 'legParams',
             title: 'Leg Parameters',
             target: this,
             params: [
                 new PD.Parameter({ name: 'legCount', title: 'Number of Legs', value: this.legCount, paramType: PD.ParamType.Integer, description: 'The number of legs on the table.' }),
                 new PD.Parameter({ name: 'legSize', title: 'Leg Size', value: this.legSize, paramType: PD.ParamType.SmallDistance, description: 'The thickness of each leg of the table.' }),
                 new PD.Parameter({ name: 'legInset', title: 'Leg Edge Inset', value: this.legInset, paramType: PD.ParamType.SmallDistance, description: 'The inset distance of each leg from the table edge.' }),
                 new PD.Parameter({ name: 'legOffset', title: 'Leg Edge Offset', value: this.legOffset, paramType: PD.ParamType.Fraction, description: 'The relative distance of the leg along each edge span.' }),
                 new PD.Parameter({ name: 'legSpan', title: 'Max. Distance Between Legs', value: this.legSpan, paramType: PD.ParamType.Distance, description: 'The maximum distance between legs along each edge span.' })
             ]
         })
     ];
 };

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

rebuild(element)

Rebuilds the geometry of this component ready for visualisation.

This is a placeholder method that should be overridden by subclasses to provide the necessary geometry generation logic for the component. Geometry is typically added to the host element's brep and/or shell based on its path.

Parameters:
Name Type Description
element BIM.Element

The element to rebuild.
Inherited From:
Overrides:
Returns:

Returns this component instance to support method chaining.

Type
BIM.Component

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;

 };

addHandleToShell_Indicator(coords, shell, width, height [, edge]) <static>

Adds a flat handle indicator centered at the current coordinate position.

                               :  : edge
                             - +  + -
     :                         :  :   :
   - + - +------------------------+ - + -
   - + - |  +------------------+  |   :
edge :   |  |                  |  |   :
         |  +------------------+  |   :
         +------------------------+ - + -
         :                        :   : height
       - +  - - - - - - - - - - - + -
         :         width          :
Parameters:
Name Type Argument Description
coords PD.LocalCoordinates

The local coordinate system to use.
shell PD.Shell

The shell to add the mixer tap to.
width number

The width of the handle in the local X-axis.
height number

The height of the handle in the local Z-axis.
edge number <optional>

The edge gap around inner and outer boundary.

addHandleToShell_Knob(coords, shell, width, height, thickness, spacing, flip) <static>

Adds a generic grab handle centered at the current coordinate position.

    spacing        ^ Z                               ^ Z
     + - + -       :                                 :
     |   :         :                                 :
     |   +-----+ - + -               +-----------+ - + -
     |   |     |   :                 |           |   :
     +---+     |   :                 |   +---+   |   :
     |   |     |   :                 |   |   |   |   :
     |   |     |   :                 |   |   |   |   :
     +---+     |   :                 |   +---+   |   :
     |   |     |   : height          |           |   : height
     |   +-----+ - + -               +-----------+ - + -
     |   :     :   :                 :           :   :
     | - + - - + - - - > Y         - + - - - - - + - - - > X
     |  thickness                    :   width   :
Parameters:
Name Type Description
coords PD.LocalCoordinates

The local coordinate system to use.
shell PD.Shell

The shell to add the mixer tap to.
width number

The width of the handle in the local X-axis.
height number

The height of the handle in the local Z-axis.
thickness number

The thickness of the handle material itself.
spacing number

The spacing of the handle from the surface.
flip boolean

Whether or not to flip surface normals.
Returns:

Returns an array of reused shell facets.

Type
Array

addHandleToShell_Lever(coords, shell, width, height, thickness, spacing, flip) <static>

Adds a generic lever handle centered at the current coordinate position.

                                ^ Z
                                :     : height
                              +---+ - + -
                             /: +/| - : - - > X
      +---------------------+ +// + - + -
     +-------------------------+ /   '
     |+ - - - - - - - - - - +/ |/   ' depth
     +----------------------/--+ - + -
  - + - - - - - - - - - - -Y- + - '
    :          width          :
Parameters:
Name Type Description
coords PD.LocalCoordinates

The local coordinate system to use.
shell PD.Shell

The shell to add the mixer tap to.
width number

The width of the handle in the local X-axis.
height number

The height of the handle in the local Z-axis.
thickness number

The thickness of the handle material itself.
spacing number

The spacing of the handle from the surface.
flip boolean

Whether or not to flip surface normals.
Returns:

Returns an array of reused shell facets.

Type
Array

addHandleToShell_Pull(coords, shell, width, height, thickness, spacing, flip) <static>

Adds a generic pull handle centered at the current coordinate position.

               ^ Z
               :           .
               :+-----+ - + -
          :    /+ - +/|  / width
        - + - +-----+ | + -
          :   +--+ :| |'
          :    : | :| |
          :    + | :| |  X
          :      | :| | '
          :     +| +| |'
          :    /+|' + +
   height :   +--+  |/
        - + - +-----+ - - > Y
          :   :  :  :
            - +  +  + -
      spacing :  :  : thickness
Parameters:
Name Type Description
coords PD.LocalCoordinates

The local coordinate system to use.
shell PD.Shell

The shell to add the mixer tap to.
width number

The width of the handle in the local X-axis.
height number

The height of the handle in the local Z-axis.
thickness number

The thickness of the handle material itself.
spacing number

The spacing of the handle from the surface.
flip boolean

Whether or not to flip surface normals.
Returns:

Returns an array of reused shell facets.

Type
Array

checkDynamicParameter(param, group, instance, host) <static>

Checks the allowable range of component parameter values.

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

Parameters:
Name Type Description
param PD.Parameter

The parameter that is being interactively changed.
group PD.ParamGroup

The group that the dynamic parameter belongs to.
instance BIM.Component

The handle or handle-like component being edited.
host BIM.Entity

The host entity this component is part of.

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

getHandleParameterGroup(instance, host [, title]) <static>

Provides a dynamic parameter group for adjusting tap properties.

This is a static method that supports non-handle components that have the same parameters as a tap, to use the one central editing method.

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

Parameters:
Name Type Argument Description
instance BIM.Component

A handle or handle-like component.
host BIM.Entity

The host entity (typically an aperture) to which the component instance belongs.
title string <optional>

An optional title for the parameter group.
Returns:

Returns a PD.ParamGroup for the panel.

Type
PD.ParamGroup

getHostElementClass() <static>

Retrieves the class of the host element for this component.

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

Returns:

Returns the element class this component requires as a host.

Type
BIM.Aperture

isCompatibleWith(obj) <static>

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

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

The entity type or object to check for compatibility with.
Returns:

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

Type
boolean

subType() <static>

Retrieves the sub-type of sensor 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.HANDLE