Class: Bus

Extends

• BIM.Beds

Members

---

:number

baseHeight

The height of the base of the bed in mm, defaults to 300mm or 12".

Type

• number

Inherited From:

• BIM.Beds#baseHeight

Overrides:

• BIM.Beds#baseHeight

---

:number

baseInset

The distance the base is inset from the mattress in mm, defaults to 15mm or 0.6".

Type

• number

Inherited From:

• BIM.Beds#baseInset

Overrides:

• BIM.Beds#baseInset

---

: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:

• PD.Base#className

Overrides:

• BIM.Beds#className

---

:number

depth

The depth of the mattress when not defined by a closed path in mm, default to 1910mm or 75".

Type

• number

Inherited From:

• BIM.Beds#depth

Overrides:

• BIM.Beds#depth

---

: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:

• BIM.Component#description

Overrides:

• BIM.Beds#description

---

:string

displayName <readonly>

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

Type

• string

Inherited From:

• PD.Base#displayName

Overrides:

• BIM.Beds#displayName

---

:number

height

The height from floor level to the top of the mattress in mm, defaults to 450mm or 18".

Type

• number

Inherited From:

• BIM.Beds#height

Overrides:

• BIM.Beds#height

---

: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:

• PD.Base#iconName

Overrides:

• BIM.Beds#iconName

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

isBedType <readonly>

A flag identifying this object as a bed type.

Type

• boolean

Inherited From:

• BIM.Beds#isBedType

Overrides:

• BIM.Beds#isBedType

---

:boolean

isBusBed <readonly>

A flag identifying this object as a custom RV bed type.

Type

• boolean

---

:boolean

isComponent <readonly>

A flag identifying this object as a shared BIM component.

Type

• boolean

Inherited From:

• BIM.Component#isComponent

Overrides:

• BIM.Beds#isComponent

---

: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:

• BIM.Component#isLocked

Overrides:

• BIM.Beds#isLocked

---

:string

name

A human-readable name for this item instance.

Type

• string

Inherited From:

• PD.Base#name

Overrides:

• BIM.Beds#name

---

:number

overbedDepth

The depth of the headboard against the wall in mm, defaults to 50mm or 2".

Type

• number

Inherited From:

• BIM.Beds#overbedDepth

Overrides:

• BIM.Beds#overbedDepth

---

:number

overbedHeight

The height of the headboard above the mattress in mm, defaults to 500mm or 20".

Type

• number

Inherited From:

• BIM.Beds#overbedHeight

Overrides:

• BIM.Beds#overbedHeight

---

: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:

• BIM.Component#productRef

Overrides:

• BIM.Beds#productRef

---

:number

stdSize

An index into the standard bed size array.

Type

• number

Inherited From:

• BIM.Beds#stdSize

Overrides:

• BIM.Beds#stdSize

---

:number

subType <readonly>

An element-specific subtype.

Type

• number

Inherited From:

• BIM.Component#subType

Overrides:

• BIM.Beds#subType

---

: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:

• BIM.Component#supplier

Overrides:

• BIM.Beds#supplier

---

:string

uuid

A universally unique identifier for the item instance.

Type

• string

Inherited From:

• PD.Base#uuid

Overrides:

• BIM.Beds#uuid

---

:number

width

The width of the mattress when not defined by a closed path in mm, defaults to 920mm or 36".

Type

• number

Inherited From:

• BIM.Beds#width

Overrides:

• BIM.Beds#width

Methods

---

clone()

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

Inherited From:

• PD.Base#clone

Overrides:

• BIM.Beds#clone

Returns:

Returns a new instance with copied values.

Type

PD.Base | null

---

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:

• BIM.Component#getNameAndSupplierParameters

Overrides:

• BIM.Beds#getNameAndSupplierParameters

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:

• BIM.Component#hasMethod

Overrides:

• BIM.Beds#hasMethod

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:

• BIM.Component#isCompatibleWith

Overrides:

• BIM.Beds#isCompatibleWith

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:

• PD.Base#updateDynamicParameters

Overrides:

• BIM.Beds#updateDynamicParameters

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 table 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.TABLE