Bitbybit Docs
    Preparing search index...

    Class AddSpaceDto<T>Beta (Inputs.IFC)

    A space to add for spaces.add: a room or an area of a storey, an outline in the storey's plan extruded up to its height.

    Type Parameters

    • T
    Index

    Constructors

    constructor

    Properties

    model storey id? name? longName? outline height? baseOffset? predefinedType?

    Constructors

    • Beta

      Type Parameters

      • T

      Parameters

      • Optionalmodel: T
      • Optionalstorey: string
      • Optionalid: string
      • Optionalname: string
      • OptionallongName: string
      • Optionaloutline: Bit.Inputs.Base.Point2[]
      • Optionalheight: number
      • OptionalbaseOffset: number
      • OptionalpredefinedType: spacePredefinedTypeEnum

      Returns AddSpaceDto<T>

    Properties

    model: T

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

    undefined
    storey: string

    The storey the space belongs to, by GlobalId or by the id it was added with.

    undefined
    id?: string

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

    undefined

    true

    name?: string

    The space's short name or number, such as 1.04.

    undefined

    true

    longName?: string

    The space's full name, such as Kitchen.

    undefined

    true

    outline: Bit.Inputs.Base.Point2[]

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

    undefined
    height?: number

    How high the space reaches, up from its base. Left out, 3 m, in the model's length unit.

    undefined

    true

    0

    Infinity

    true

    baseOffset?: number

    How far above the storey's floor the space starts.

    0

    -Infinity

    Infinity

    predefinedType?: spacePredefinedTypeEnum

    What kind of space it is.

    space

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties