Bitbybit Docs
    Preparing search index...

    Class VectorTextDto (Inputs.Text)

    A text and its layout for text.vectorText, which draws it line by line as stroke paths on the XZ plane.

    Index

    Constructors

    • Parameters

      • Optionaltext: string
      • OptionalxOffset: number
      • OptionalyOffset: number
      • Optionalheight: number
      • OptionallineSpacing: number
      • OptionalletterSpacing: number
      • Optionalalign: horizontalAlignEnum
      • OptionalextrudeOffset: number
      • OptionalcenterOnOrigin: boolean

      Returns VectorTextDto

    Properties

    text?: string

    The text to draw; a line break starts a new line.

    Hello World
    
    xOffset?: number

    How far to shift the whole block along X, in model units.

    0
    

    -Infinity

    Infinity

    0.1

    yOffset?: number

    How far to shift the whole block along the second axis of the text plane, in model units.

    0
    

    -Infinity

    Infinity

    0.1

    height?: number

    The height of a capital letter, in model units.

    1
    

    -Infinity

    Infinity

    0.1

    lineSpacing?: number

    The distance between lines as a multiple of the height; 1.4 leaves a little air between them.

    1.4
    

    -Infinity

    Infinity

    0.1

    letterSpacing?: number

    Extra space between characters as a multiple of the height; 0 uses the font's own spacing.

    0
    

    -Infinity

    Infinity

    0.1

    How lines of different length line up: at their left edge, their center or their right edge.

    left
    
    extrudeOffset?: number

    A margin, in model units, taken off the height and split above and below each character, so extruded text keeps its full size.

    0
    

    -Infinity

    Infinity

    0.1

    centerOnOrigin?: boolean

    When true, the middle of the whole text block is moved to the origin.

    false