API Docs

Class: Awning

BIM.Shades. Awning

A class for parametrically generating the geometry for an external awning.

An awning is a fabric or light-weight screen extending out over a doorway, window, opening, deck or similar to provide protection from the sun.

        W
 -------:-----------------------------------------
        :
        +---------------------------------+
        |                                 |
        |                                 |
       |                                 ||
       |                                 ||
      |                                 | |
      |                                 | *
     |                                 | /
     |                                 |/ :
     +---------------------------------+
        :   ||                     |      :
            ||                     |
        :   ||                     |      :
            |+---------------------|
        :   +----------------------+      :

 -------+---------------------------------+------- - - U
       /
      V

new Awning( [config] [, typeName])

Creates a new external awning shading device 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.
size number <optional>

The projection of the shading device in mm, defaults to 600mm or 2'.
depth number <optional>

The thickness of the awning support rod in mm, defaults to 20mm or 3/4".
railSize number <optional>

The size of any support rails required by the shade in mm, defaults to 20mm or 3/4".
angle number <optional>

The angle of the awning in degrees, defaults to 60deg.
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

:number

angle

The angle of the awning in degrees, defaults to 60deg.

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

depth

The thickness of the awning support rod in mm, defaults to 20mm or 3/4".

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

dropSize

The size of the vertical drop at the end opf the awning in mm, defaults to zero.

Type
  • number
:boolean

encloseSides

Whether to enclose the sides of the supports rails, defaults to false.

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

includeRail

Whether to include default structural supports for shade, defaults to true.

When set to false, you can use columns, beams and plates to construct your own custom support infrastructure.

Type
  • boolean
:boolean

includeRetractor

Whether to include the top roller for the screen, defaults to true.

When set to false, you can create your own custom roller and hooding using other structural elements.

Type
  • boolean
:boolean

isAwningType <readonly>

A flag identifying this object as an awning shading device type.

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

isShadeType <readonly>

A flag identifying this object as a shading device type.

Type
  • boolean
Inherited From:
Overrides:
: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

railDepth

The vertical depth of any support rails for the shade in mm, defaults to 40mm or 1.5".

Type
  • number
:number

railSize

The horizontal width of any support rails for the shade in mm, defaults to 20mm or 3/4".

Type
  • number
Overrides:
:number

size

The projection length of the shade in mm, defaults to 600mm or 24".

The exact nature of this parameter may vary slightly with different shade types and their variants.

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

type

The type of awning (0:Simple, 1:GuideRail, 2:FoldingArm, 3:FixedArm, 4:RadialArm).

Type
  • number
:string

uuid

A universally unique identifier for the item instance.

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

addSideRails(element, shell, coords, rail_width, rail_depth, shade_y_offset, shade_x_size, rail_length, rail_angle [, enclosed])

Generates a a left and right rail to support the louvres.

Parameters:
Name Type Argument Description
element BIM.Shade

The element being rebuilt.
shell PD.Shell

The shell to add the geometry to.
coords PD.LocalCoordinates

The local coordinates to use.
rail_width number

The width of each rail in the local X axis.
rail_depth number

The depth of each rail in the local Z axis.
shade_y_offset number

How far the closest louvre sits proud of the wall.
shade_x_size number

The size of the shaded area in the local X axis.
rail_length number

The length of the angled part of the rail.
rail_angle number

The angle of the rail down from horizontal, in degrees.
enclosed boolean <optional>

When true, the .
Inherited From:
Overrides:

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

generateAlongPath(element)

Generates the geometry of a simple flat awning that follows the path.

Parameters:
Name Type Description
element BIM.Shade

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

Returns true if geometry was created, otherwise false.

Type
boolean

generateAngledShadeOnPath(element)

Generates the geometry of a simple angled shade that follows the path.

Parameters:
Name Type Description
element BIM.Shade

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

Returns true if geometry was created, otherwise false.

Type
boolean

generateFabricShade(element, shell, coords, shade_x, shade_y, shade_z, rodSize [, rodExt] [, flip])

Generates a fabric shade component for the different awning types.

Parameters:
Name Type Argument Default Description
element BIM.Shade

The element being built.
shell PD.Shell

The shell to add geometry to.
coords PD.LocalCoordinates

The local coordinates to use.
shade_x number

The distance the shade spans in the local X-axis.
shade_y number

The distance the shade spans in the local Y-axis.
shade_z number

The distance the shade spans in the local Z-axis.
rodSize number

The size of the end hanging rod.
rodExt number <optional>

Any extension each side of rod, defaults to zero.
flip boolean <optional>
 false

Whether to reverse normals, defaults to false.

generateFixedArm(element, junction)

Rebuilds the geometry for a awning that follows guide rails.

     |
     |
     +---+-+
     +-+ | |
     +-| |-+
     |'| |
     | | |_
     | | | '_
     | | |   '_
     | | |     '_
     | | |       '_
     |+---+        '_
     ||   +------------+-+
     ||   +------------+-+
     |+---+            |
     | | |
     +-+ |
     +---+
     |
     |
Parameters:
Name Type Description
element BIM.Shade

The shading device element to rebuild.
junction BIM.Junction

The junction of the path segment to generate.
Returns:

Returns true if geometry was created, otherwise false.

Type
boolean

generateFoldingArm(element, junction)

Rebuilds the geometry for a awning that extends on folding arms.

      |
      |
      +-+-+          +------------------------------------+
      | + |          |                                    |
      + -\+          +---+-+------------------------+-+---+
      |\\ \          |    \ \                      / /    |
      | \\ \         |     \ \                    / /     |
      |  \\ \        |      +-+                  +-+      |
      |   \\ \       |     / /                    \ \     |
      |    \\ \      |    / /                      \ \    |
      |     \\ +     +---+-+------------------------+-+---+
      |      +++     +------------------------------------+
      |       |
      |
Parameters:
Name Type Description
element BIM.Shade

The shading device element to rebuild.
junction BIM.Junction

The junction of the path segment to generate.
Returns:

Returns true if geometry was created, otherwise false.

Type
boolean

generateForAperture(element)

Rebuilds the geometry for a simple awning above an aperture.

Parameters:
Name Type Description
element BIM.Shade

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

Returns true if geometry was created, otherwise false.

Type
boolean

generateGuideRail(element, junction)

Rebuilds the geometry for a awning that follows guide rails.

      |
      |
      +-+-+          ++----------------------------------++
      | + |          ||                                  ||
      + -\+          ++----------------------------------++
      |\\ \          ||                                  ||
      | \\ \         ||                                  ||
      |  \\ \        ||                                  ||
      |   \\ \       ||                                  ||
      |    \\ \      ||                                  ||
      |     \\ +     ++----------------------------------++
      |      +++     ++----------------------------------++
      |       |
      |
Parameters:
Name Type Description
element BIM.Shade

The shading device element to rebuild.
junction BIM.Junction

The junction of the path segment to generate.
Returns:

Returns true if geometry was created, otherwise false.

Type
boolean

generateRadialArm(element, junction)

Rebuilds the geometry for a awning that follows guide rails.

     |
     |
     +----+
     |    |
     +----+
     |'-_
     |   '-_
     |      '-_
     |         '-_
     |            '-+-+
     |          _.-'+-+
     +-.    _.-'_.-'|
     |  '.-'_.-'    |
     |   ':'
     |  .'
     +-'
     |
     |
Parameters:
Name Type Description
element BIM.Shade

The shading device element to rebuild.
junction BIM.Junction

The junction of the path segment to generate.
Returns:

Returns true if geometry was created, otherwise false.

Type
boolean

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

getProjection()

Computes the projection length of the shade based on the size property, which may be given as a either fraction of host height or directly in mm.

Inherited From:
Overrides:

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

render(meshes, view, level, element)

Render a view of the element using the given meshes.

Parameters:
Name Type Description
meshes BIM.Meshes

The collection of meshes to render to.
view PD.ViewData

The view definition to render the model within.
level BIM.Level

The level currently being rebuilt and rendered.
element BIM.Shade

The shading device element being rendered.
Inherited From:
Overrides:
Returns:

Returns true if anything was added to any mesh.

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

subType() <static>

Retrieves the sub-type of shading device 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.SHADE