Bitbybit Docs
    Preparing search index...

    Class AddTerrainDto<T>Beta (Inputs.IFC)

    Terrain to add for site.addTerrain: the ground of the site as an outline in the site's plan, with holes where a building or paving meets it, its top at elevation and reaching depth down.

    Type Parameters

    • T
    Index

    Constructors

    • Beta

      Type Parameters

      • T

      Parameters

      • Optionalmodel: T
      • Optionalid: string
      • Optionalname: string
      • Optionaloutline: Bit.Inputs.Base.Point2[]
      • Optionalholes: Bit.Inputs.Base.Point2[][]
      • Optionaldepth: number
      • Optionalelevation: number
      • Optionalmaterial: string

      Returns AddTerrainDto<T>

    Properties

    model: T

    The model to change; it stays as it was, and the call returns the changed model.

    undefined
    
    id?: string

    An id of your own for the terrain. Leave it out for a generated one.

    undefined
    

    true

    name?: string

    A name for the terrain, which other tools show.

    Terrain
    
    outline: Bit.Inputs.Base.Point2[]

    The outline, as [x, y] points in the site's plan, without the first repeated at the end; either winding works.

    undefined
    
    holes?: Bit.Inputs.Base.Point2[][]

    Holes in the ground, each an outline like outline, inside it, such as a building's footprint or paving that lies flush with the ground.

    undefined
    

    true

    depth?: number

    How far the ground reaches down from its top. Left out, 1 m, in the model's length unit.

    undefined
    

    true

    0

    Infinity

    true

    elevation?: number

    How high the ground's top is above the site's origin.

    0
    
    material?: string

    The material of the ground, added before with materials.add, such as lawn or soil.

    undefined
    

    true