Bitbybit Docs
    Preparing search index...

    Class PyramidSimpleAffectorsDto<T> (Advanced.Patterns.FacePatterns.PyramidSimple)

    The faces, grid size and attractor points for advanced.patterns.facePatterns.pyramidSimple.createPyramidSimpleAffectors. Every pyramid starts at defaultHeight, and each affector adds height to the cells within its radius.

    Type Parameters

    • T
    Index

    Constructors

    • Type Parameters

      • T

      Parameters

      • Optionalfaces: T[]
      • OptionalaffectorPoints: Bit.Inputs.Base.Point3[]
      • OptionaluNumber: number
      • OptionalvNumber: number
      • OptionalminHeight: number
      • OptionalmaxHeight: number
      • Optionalprecision: number

      Returns PyramidSimpleAffectorsDto<T>

    Properties

    faces: T[]

    The faces to cover. Each gets its own grid, and the getters count faces from 0 in this order.

    undefined
    
    affectorPoints: Bit.Inputs.Base.Point3[]

    The points that change the heights of nearby pyramids, measured from each cell's center. The radius and factor lists pair with these points by index.

    undefined
    
    affectorRadiusList?: number[]

    How far each affector reaches, in model units; cells whose center lies farther away keep their height. Leave it out to give every affector a radius of 10.

    undefined
    

    true

    affectorFactors?: number[]

    How strongly each affector acts, from -1 to 1: a positive factor raises the pyramids near it, a negative one lowers them. Leave it out to give every affector a factor of 1.

    undefined
    

    true

    uNumber: number

    How many cells, and so pyramids, each face gets along U.

    10
    

    1

    Infinity

    1

    vNumber: number

    How many cells, and so pyramids, each face gets along V.

    5
    

    1

    Infinity

    1

    defaultHeight: number

    The height of every pyramid before the affectors act, in model units, measured along the averaged surface normal.

    0.2
    

    -Infinity

    Infinity

    0.1

    affectMinHeight: number

    The height an affector adds to the farthest cell it reaches, in model units, before its factor scales it.

    0
    

    0

    Infinity

    0.1

    affectMaxHeight: number

    The height an affector adds to the closest cell it reaches, in model units, before its factor scales it.

    1
    

    0

    Infinity

    0.1

    precision: number

    The meshing precision used when the model is drawn; a smaller value gives a finer mesh. The shapes in the model do not depend on it.

    0.01
    

    0.000001

    5

    0.001