TextExtrusion

    TextExtrusion

    The TextExtrusion class describes a 3D text scene object.

    Properties

    PropertyDescription
    backMaterial
    (get) (Not Available)
    (set) backMaterial: MaterialBase


    Specifies the material of the back cap of 3-d text.
    depth
    (get) depth: ScalarSignal
    (set) depth: ScalarSignal


    Text extrusion is only made through straight paths. This specifies the depth of the straight path of extrusion, starting from the position of textExtrusion scene object.

    Note: Default value is 10 mm.
    faceMaterial
    (get) (Not Available)
    (set) faceMaterial: MaterialBase


    Specifies the material of the caps or face of 3-d text.
    font
    (get) (Not Available)
    (set) font: FontId


    Sets the given font from the fonts registry.
    frontMaterial
    (get) (Not Available)
    (set) frontMaterial: MaterialBase


    Specifies the material of the front cap of 3-d text.
    letterSpacing
    (get) letterSpacing: ScalarSignal
    (set) letterSpacing: ScalarSignal


    Specifies the letter spacing value.
    lineSpacing
    (get) lineSpacing: ScalarSignal
    (set) lineSpacing: ScalarSignal


    Specifies the line spacing value.
    sideMaterial
    (get) (Not Available)
    (set) sideMaterial: MaterialBase


    Specifies the material of the extrusion part of 3-d text.
    text
    (get) text: StringSignal
    (set) text: StringSignal


    Specifies the text displayed.

    Methods

    MethodDescription
    getBackMaterial 
    getBackMaterial(): Promise<MaterialBase>


    Returns a promise that is resolved with the material associated with the back cap of 3-d text of given scene object or null if no material was assigned.
    getFont 
    getFont(): Promise<FontId>


    Returns a promise that is resolved with the font identifier associated with the instance of TextExtrusion or null if none is.
    getFrontMaterial 
    getFrontMaterial(): Promise<MaterialBase>


    Returns a promise that is resolved with the material associated with the front cap of 3-d text of given scene object or null if no material was assigned.
    getSideMaterial 
    getSideMaterial(): Promise<MaterialBase>


    Returns a promise that is resolved with the material associated with the extrusion part of 3-d text of given scene object or null if no material was assigned.