Bitbybit Docs
    Preparing search index...

    Class Text3DFaceDto<T> (Advanced.Text3D)

    The face, text, shipped font and placement for advanced.text3d.createTextOnFace. The text is drawn in the face's UV space around originParamU and originParamV, and faceTextVar sets how it meets the face.

    Type Parameters

    • T
    Index

    Constructors

    • Type Parameters

      • T

      Parameters

      • Optionalface: T
      • OptionalfacePlanar: boolean
      • OptionalfaceTextVar: faceTextVarEnum
      • Optionaltext: string
      • OptionalfontType: fontsEnum
      • OptionalfontVariant: fontVariantsEnum
      • OptionalfontSize: number
      • Optionalheight: number
      • Optionalrotation: number
      • OptionaloriginParamU: number
      • OptionaloriginParamV: number
      • OptionaloriginAlignment: recAlignmentEnum

      Returns Text3DFaceDto<T>

    Properties

    face: T

    The face to place the text on.

    undefined
    
    facePlanar: boolean

    Set it to true when the face is flat, so each letter face is built as a plane; leave it false for a curved face.

    false
    
    faceTextVar: faceTextVarEnum

    How the text meets the face: separatedExtrusion returns only the letters, integratedExtrusion sews raised letters into the face with the letters cut out, and cutout returns that cut face.

    text: string

    The string to build. Spaces leave a gap but produce no character shape.

    bitbybit.dev
    
    fontType: fontsEnum

    The font family, one of the families shipped with the library.

    Roboto
    
    fontVariant: fontVariantsEnum

    The weight and style within fontType. Not every family ships every variant, and asking for one it lacks throws.

    Regular
    
    fontSize: number

    The size of the font, measured in the face's real U and V values rather than in model units, so the same size can look different on different faces.

    1.5
    

    0

    Infinity

    0.1

    height: number

    How far each letter is thickened along the face normal, in model units. 0 keeps the letters as faces on the surface; cutout ignores it.

    0.2
    

    0

    Infinity

    0.1

    rotation: number

    Spins the text around its anchor within the face's UV space, in degrees.

    0
    

    0

    Infinity

    15

    originParamU: number

    Where the anchor sits along U, as a fraction of the face's U range from 0 at its start to 1 at its end.

    0.5
    

    0

    1

    0.1

    originParamV: number

    Where the anchor sits along V, as a fraction of the face's V range from 0 at its start to 1 at its end.

    0.5
    

    0

    1

    0.1

    originAlignment: recAlignmentEnum

    Which point of the text lands on its anchor: left, center or right combined with top, middle or bottom. The offsets come from the text's bounding box, and the bottom positions sit on the baseline.

    centerMiddle