Bitbybit Docs
    Preparing search index...

    Class AddTreeDto<T>Beta (Inputs.IFC)

    A tree to add for site.addTree: a trunk and a rounded crown standing on the site at position, height tall overall, written as a geographic element of the site.

    Type Parameters

    • T
    Index

    Constructors

    constructor

    Properties

    model id? name? species? position? elevation? height? crownRadius? trunkRadius? crownMaterial? trunkMaterial?

    Constructors

    • Beta

      Type Parameters

      • T

      Parameters

      • Optionalmodel: T
      • Optionalid: string
      • Optionalname: string
      • Optionalspecies: string
      • Optionalposition: Bit.Inputs.Base.Point2
      • Optionalelevation: number
      • Optionalheight: number
      • OptionalcrownRadius: number
      • OptionaltrunkRadius: number
      • OptionalcrownMaterial: string
      • OptionaltrunkMaterial: string

      Returns AddTreeDto<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 tree. Leave it out for a generated one.

    undefined

    true

    name?: string

    A name for the tree, which other tools show.

    Tree
    species?: string

    What kind of tree it is, such as Silver birch, written as the element's object type.

    Tree
    position?: Bit.Inputs.Base.Point2

    Where the trunk stands, as [x, y] in the site's plan.

    [0, 0]
    elevation?: number

    How high above the site's origin the trunk stands.

    0
    height?: number

    The tree's height from the ground to the top of its crown. Left out, 8 m, in the model's length unit.

    undefined

    true

    0

    Infinity

    true

    crownRadius?: number

    How far the crown spreads from the trunk. Left out, 2.5 m, in the model's length unit.

    undefined

    true

    0

    Infinity

    true

    trunkRadius?: number

    The trunk's radius at the ground; it narrows towards the crown. Left out, 150 mm, in the model's length unit.

    undefined

    true

    0

    Infinity

    true

    crownMaterial?: string

    The material of the crown, added before with materials.add.

    undefined

    true

    trunkMaterial?: string

    The material of the trunk, added before with materials.add.

    undefined

    true

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties