Bitbybit Docs
    Preparing search index...

    Class ChristmasTreeDto (Inputs.OCCT)

    The proportions of a stylized Christmas tree for shapes.wire.createChristmasTreeWire and shapes.face.createChristmasTreeFace, which stand it in the XY plane by default.

    Hierarchy (View Summary)

    Index

    Constructors

    • Parameters

      • Optionalheight: number
      • OptionalinnerDist: number
      • OptionalouterDist: number
      • OptionalnrSkirts: number
      • OptionaltrunkHeight: number
      • OptionaltrunkWidth: number
      • Optionalhalf: boolean
      • Optionalrotation: number
      • Optionalorigin: Point3
      • Optionaldirection: Vector3

      Returns ChristmasTreeDto

    Properties

    height: number

    The height of the tree without the trunk, in model units.

    6
    

    0

    Infinity

    0.1

    innerDist: number

    How far the branches reach from the trunk line at the notches of the lowest skirt, in model units.

    1.5
    

    0

    Infinity

    0.1

    outerDist: number

    How far the branches reach from the trunk line at the tips of the lowest skirt, in model units.

    3
    

    0

    Infinity

    0.1

    nrSkirts: number

    How many layers of branches, the triangle-like skirts, the tree has.

    5
    

    1

    Infinity

    1

    trunkHeight: number

    The height of the trunk below the branches, in model units; 0 leaves the trunk out.

    1
    

    0

    Infinity

    0.1

    trunkWidth: number

    The width of the trunk, in model units; used only when the trunk height is above 0.

    1
    

    0

    Infinity

    0.1

    half: boolean

    When true, only one side of the tree is built, as an open wire.

    false
    
    rotation: number

    How far the tree is spun about its trunk-to-tip axis, in degrees.

    0
    

    0

    Infinity

    15

    origin: Point3

    The point at the base of the trunk.

    [0, 0, 0]
    
    direction: Vector3

    The direction from the trunk to the tip; the default stands the tree up along Y.

    [0, 1, 0]