API Docs

Class: Spherical

BIM.Rocks. Spherical

A class for generating spherical rock forms.

new Spherical( [config] [, typeName])

Creates a new spherical rock 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.
seed number <optional>

A seed for initialising the random number generator.
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

baseColor

The base colour of the canopy foliage as a hexadecimal number, defaults to 0x008000.

Type
  • number
Inherited From:
Overrides:
:number

bumpFactor

Noise-driven variation in surface shape (0 to 1), defaults to 0.25.

Type
  • number
:number

bumpOffset

Translates the surface through the noise volume (0 to 1), defaults to 0.

Type
  • number
:number

bumpScale

The relative size of noise-driven variation (0 to 1), defaults to 0.15.

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

complexity

How many facets the surface has (0 to 20), defaults to 5.

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

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

isRockType <readonly>

A flag identifying this object as a rock type.

Type
  • boolean
Inherited From:
Overrides:
:boolean

isSpherical <readonly>

A flag identifying this object as a spherical rock type.

Type
  • boolean
:string

name

A human-readable name for this item instance.

Type
  • string
Inherited From:
Overrides:
:number

outlines

Whether or not to draw an outline of each individual facet, defaults to false.

Type
  • number
Inherited From:
Overrides:
:number

pointDistribution

How points are generated over the sphere (0:Random, 1:PseudoRandom, 2:Fibonacci, 3:Geodesic), defaults to 1.

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

seed

Caches a seed number to ensure that randomisation is consistent.

Type
  • number
Inherited From:
Overrides:
:number

smoothness

How smooth or rounded to make the edges (0 to 1).

Type
  • number
Inherited From:
Overrides:
:number

sphericity

How closely the rock surface is to a sphere (0 to 1).

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

surfaceType

How the surface is generated from distributed point (0:Delaunay, 1:Voronoi, 2:ConvexHull), defaults to 2.

Type
  • number
:number

updateIndex

Stores an update index to use for shape validity testing.

Type
  • number
Inherited From:
Overrides:
:string

uuid

A universally unique identifier for the item instance.

Type
  • string
Inherited From:
Overrides:
:number

variColor

The variegation colour of the foliage in summer as a hexadecimal number, defaults to 0x887766.

Type
  • number
Inherited From:
Overrides:
:number

variegation

The fraction of variegation in foliage color (0 to 1), defaults to 0.25.

This is stored as a property to support the BIM.Rock#variegatedColor method.

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

generateDelaunay(brep, data)

Generates the geometry of the rock.

Parameters:
Name Type Description
brep PD.BRep

The BRep to add geometry to.
data object

The basic rock parameters.

generateGeometry(rock, junction, brep, config)

Generates the geometry of a spherical rock.

Parameters:
Name Type Description
rock BIM.Rock

The rock element to rebuild.
junction BIM.Junction

The junction to generate geometry for.
brep PD.BRep

The BRep to add rock geometry to.
config object

A configuration object with rock parameters.
Inherited From:
Overrides:
Returns:

Returns this rock type to support method chaining.

Type
BIM.Rocks

generateHull(brep, data)

Generates the geometry of the rock.

Parameters:
Name Type Description
brep PD.BRep

The BRep to add geometry to.
data object

The basic rock parameters.

generatePoints(data, points2d, points3d)

Generates spherically distributed points on the canopy by the current method.

If a valid points2d array is given, this method fills it with the 2D stereographic position of each point. If a valid points2d array is given, it is filled with the corresponding 3D spatial position of each point.

Parameters:
Name Type Description
data object

An internal configuration data object.
points2d Array | null

An optional array to store 2D stereographic points.
points3d Array | null

An optional array to store 3D spherical points.
Returns:

Returns the configuration data object.

Type
object

generateVoronoi(brep, data)

Generates the geometry of the rock.

Parameters:
Name Type Description
brep PD.BRep

The BRep to add geometry to.
data object

The basic rock parameters.

getColorCallback()

Retrieves a curried function for variegating rock surface colors.

Internally this method calls the BIM.Rock#variegatedColor method. The aim of wrapping this method as a callback function is to ensure that it is always invoked with this plant element as this, regardless of how and from where the wrapper function is called.

Like the BIM.Rock#variegatedColor method, the returned function takes no arguments and returns a hexadecimal color value.

Inherited From:
Overrides:
Returns:

Returns a function that provides hexadecimal color values.

Type
function

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

highlight(mesh, view, rock)

Renders a highlighted view of the element to show it as selected.

Parameters:
Name Type Description
mesh PD.PolyMesh

The selection mesh to render highlighting to.
view PD.ViewData

The view definition to render the model within.
rock PD.Plant

The rock element being highlighted.
Inherited From:
Overrides:
Returns:

Returns true if anything was added to the mesh.

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, rock)

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.
rock BIM.Rock

The rock being rendered.
Inherited From:
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;

 };

usesJunctionOrientation(junction)

Whether this rock type uses junction orientation.

Parameters:
Name Type Description
junction BIM.Junction

The junction to apply the logic to.
Inherited From:
Overrides:
Returns:

Return true to show a rotation cursor manipulator.

Type
boolean

variegatedColor()

Generates a random color based on foliage variegation values.

NOTE: This method uses an internal random number cache to ensure that color allocations are reasonably stable even with different numbers of facets or adding variation or orientation which may disrupt the standard random number generator.

Inherited From:
Overrides:
Returns:

Returns a randomly interpolated hexadecimal color number.

Type
number

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 rock 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.ROCK