bitbybit.dev v1.0.0-rc.1
    Preparing search index...

    Type Parameters

    • T
    Index

    Constructors

    • Type Parameters

      • T

      Parameters

      • Optionalfaces: T[]
      • OptionalaffectorPoints: Point3[]
      • OptionaluNumber: number
      • OptionalvNumber: number
      • OptionalminHeight: number
      • OptionalmaxHeight: number
      • Optionalprecision: number

      Returns PyramidSimpleAffectorsDto<T>

    Properties

    faces: T[]

    The faces on which to apply the pattern

    undefined
    
    affectorPoints: Point3[]

    The affector points affect the height of the pyramid elements. The distance is measured between a center point of the corner points and the attractor point. Then it is remapped to certain values.

    undefined
    
    affectorRadiusList?: number[]

    The affector radius indicates the limit of affection. Cells heights that are further away from the affector than this radius will not be adjusted. If value is not provided, all affector points will use the radius of 10.

    undefined
    

    true

    affectorFactors?: number[]

    The affector factors determine if a given affector attracts (value 0 to 1) or repulses (values -1 to 0) the default height of the pyramid elements. If value is not provided, all affector points will use the factor of 1 and will thus attract the heights.

    undefined
    

    true

    uNumber: number

    The nr of pyramids along u direction of the face

    10
    

    1

    Infinity

    1

    vNumber: number

    The nr of pyramids along v direction of the face

    5
    

    1

    Infinity

    1

    defaultHeight: number

    The default height for the pyramid if it is not affected by any of the affectors.

    0.2
    

    -Infinity

    Infinity

    0.1

    affectMinHeight: number

    Min value to add to the height if affector factor is 1 or subtract from the height if affector factor is -1. This adds to the height if the affector factor > 0 and subtracts from the height if the affector factor is < 0.

    0
    

    0

    Infinity

    0.1

    affectMaxHeight: number

    Max value to add to the height if affector factor is 1 or subtract from the height if affector factor is -1. This adds to the height if the affector factor > 0 and subtracts from the height if the affector factor is < 0.

    1
    

    0

    Infinity

    0.1

    precision: number

    Meshing precision of the drawn model. The lower the number the more precise the drawn model is. Keep in mind that output of this algorithm also contains pure occt shape that can be meshed separately in draw any async commands

    0.01
    

    0.000001

    5

    0.001