Options
All
  • Public
  • Public/Protected
  • All
Menu
Logo of bit by bit developers

Class Text3D

Hierarchy

  • Text3D

Index

Constructors

Methods

Constructors

constructor

  • new Text3D(occWorkerManager: OCCTWorkerManager, context: Context, draw: Draw): Text3D

  • Parameters

    • occWorkerManager: OCCTWorkerManager
    • context: Context
    • draw: Draw

    Returns Text3D

Methods

create

  • Creates a 3d text

    group

    create

    shortname

    create 3d text

    drawable

    true

    Parameters

    Returns Promise<Text3DData<TopoDSShapePointer>>

    3d text

createTextOnFace

createTextOnFaceUrl

  • Creates a 3d text on the face using a font URL. This is useful when you want to use a custom font that is not included in the library. The font will be loaded from the provided URL and used to generate the 3d text. Make sure that fonts do not contain self intersection and other bad characters - that is common issue with custom fonts. Font formats supported are: ttf, otf, woff. Please note that Woff2 is not supported by opentype.js as it is a compressed format.

    group

    create

    shortname

    create 3d text on face url

    drawable

    true

    Parameters

    Returns Promise<Text3DData<TopoDSShapePointer>>

    3d text

createTextsOnFace

createTextsOnFaceUrl

  • Creates 3d texts on the face from multiple url definitions This is useful when you want to use a custom font that is not included in the library. The font will be loaded from the provided URL and used to generate the 3d text. Make sure that fonts do not contain self intersection and other bad characters - that is common issue with custom fonts. Font formats supported are: ttf, otf, woff. Please note that Woff2 is not supported by opentype.js as it is a compressed format.

    group

    create

    shortname

    create 3d texts on face url

    drawable

    true

    Parameters

    Returns Promise<Text3DData<TopoDSShapePointer>>

    3d text

createWithUrl

  • Creates a 3d text with a font URL This is useful when you want to use a custom font that is not included in the library. The font will be loaded from the provided URL and used to generate the 3d text. Make sure that fonts do not contain self intersection and other bad characters - that is common issue with custom fonts. Font formats supported are: ttf, otf, woff. Please note that Woff2 is not supported by opentype.js as it is a compressed format.

    group

    create

    shortname

    create 3d text with url

    drawable

    true

    Parameters

    Returns Promise<Text3DData<TopoDSShapePointer>>

    3d text

definition3dTextOnFace

  • Creates 3d text that will be used on the face defintion

    group

    definitions

    shortname

    3d text face def

    drawable

    false

    Parameters

    Returns Text3DFaceDefinitionDto

    definition

definition3dTextOnFaceUrl

  • Creates 3d text that will be used on the face url defintion This is useful when you want to use a custom font that is not included in the library. The font will be loaded from the provided URL and used to generate the 3d text. Make sure that fonts do not contain self intersection and other bad characters - that is common issue with custom fonts. Font formats supported are: ttf, otf, woff. Please note that Woff2 is not supported by opentype.js as it is a compressed format.

    group

    definitions

    shortname

    3d text face url def

    drawable

    false

    Parameters

    Returns Text3DFaceDefinitionUrlDto

    definition

getAdvanceWidth

  • Get advance width

    group

    dimensions

    shortname

    get advance width

    drawable

    false

    Parameters

    Returns number

    width dimension

getAllFacesOfCutout

  • Gets all of the face cutouts from text 3d that was created on the original face

    group

    get from face

    shortname

    get all coutout faces

    drawable

    true

    Parameters

    Returns TopoDSShapePointer[]

    character coordinates as points

getCharacterCenterCoordinates

  • Gets the center of mass coordinates of all characters

    group

    get

    shortname

    character coordinates

    drawable

    true

    Parameters

    Returns Point3[]

    character coordinates as points

getCharacterShape

getCharacterShapes

  • Gets character shapes of the 3d text result

    group

    get

    shortname

    character shapes

    drawable

    true

    Parameters

    Returns TopoDSShapePointer[]

    character OCCT shapes of the 3d text result

getCompoundShape

getCutoutsInsideCharacters

  • Gets character face cutouts from text 3d that was created on the original face

    group

    get from face

    shortname

    get faces in characters

    drawable

    true

    Parameters

    Returns TopoDSShapePointer[]

    character coordinates as points

getFaceCutout

  • Gets the face cutout from text 3d that was created on the face

    group

    get from face

    shortname

    face cutout

    drawable

    true

    Parameters

    Returns TopoDSShapePointer

    character coordinates as points

Generated using TypeDoc