Fonts

Detailed Description

group a3d_fonts

When creating a markup tessellation that uses specific fonts, store fonts with font keys (A3DFontKeyData) by invoking the A3DGlobalFontKeyCreate function.

When parsing a markup tessellation that uses specific fonts, use the A3DGlobalFontKeyGet function to obtain fonts information from font keys (A3DFontKeyData).

Type Documentation

enum A3DECharSet

Font key CharSet.

Version

2.0

Values:

enumerator kA3DCharsetUnknown

Unknown charset ;.

enumerator kA3DCharsetRoman

Roman charset.

enumerator kA3DCharsetJapanese

Japanese charset.

enumerator kA3DCharsetTraditionalChinese

Traditional chinese charset.

enumerator kA3DCharsetKorean

Korean charset.

enumerator kA3DCharsetArabic

Arabic charset.

enumerator kA3DCharsetHebrew

Hebrew charset.

enumerator kA3DCharsetGreek

Greek charset.

enumerator kA3DCharsetCyrillic

Cyrillic charset.

enumerator kA3DCharsetRightLeft

Right left charset.

enumerator kA3DCharsetDevanagari

Devanagari charset.

enumerator kA3DCharsetGurmukhi

Gurmukhi charset.

enumerator kA3DCharsetGujarati

Gujarati charset.

enumerator kA3DCharsetOriya

Oriya charset.

enumerator kA3DCharsetBengali

Bengali charset.

enumerator kA3DCharsetTamil

Tamil charset.

enumerator kA3DCharsetTelugu

Telugu charset.

enumerator kA3DCharsetKannada

Kannada charset.

enumerator kA3DCharsetMalayalam

Malayalam charset.

enumerator kA3DCharsetSinhalese

Sinhalese charset.

enumerator kA3DCharsetBurmese

Burmese charset.

enumerator kA3DCharsetKhmer

Khmer charset.

enumerator kA3DCharsetThai

Thai charset.

enumerator kA3DCharsetLaotian

Laotian charset.

enumerator kA3DCharsetGeorgian

Georgian charset.

enumerator kA3DCharsetArmenian

Armenian charset.

enumerator kA3DCharsetSimplifiedChinese

Simplified chinese charset.

enumerator kA3DCharsetTibetan

Tibetan charset.

enumerator kA3DCharsetMongolian

Mongolian charset.

enumerator kA3DCharsetGeez

Geez charset.

enumerator kA3DCharsetEastEuropeanRoman

East european roman charset.

enumerator kA3DCharsetVietnamese

Vietnamese charset.

enumerator kA3DCharsetExtendedArabic

Extended arabic charset.

Function Documentation

A3DStatus A3DGlobalFontKeyGet(const A3DFontKeyData *pFontKeyData, A3DFontData *pFontData)

Retrieves font information (A3DFontData) from the A3DFontKeyData structure.

This function is useful when reading markup tessellation.

Version

2.0

Return values
  • A3D_INITIALIZE_NOT_CALLED

  • A3D_INVALID_DATA_STRUCT_SIZE

  • A3D_INVALID_DATA_STRUCT_NULL

  • A3D_INVALID_ENTITY_NULL

  • A3D_INVALID_ENTITY_TYPE

  • A3D_MARKUP_CANNOT_ACCESS_FONT

  • A3D_MARKUP_INVALID_FONTKEY

  • A3D_SUCCESS

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DGlobalFontTextBoxGet(const A3DFontKeyData *psFontKeyData, A3DUTF8Char *pcText, A3DDouble *pdLength, A3DDouble *pdHeight)

Gets text bounding box according to the font.

Version

5.2

Return values
  • A3D_INITIALIZE_NOT_CALLED

  • A3D_INVALID_ENTITY_NULL

  • A3D_INVALID_ENTITY_TYPE

  • A3D_MARKUP_CANNOT_ACCESS_FONT

  • A3D_MARKUP_INVALID_FONTKEY

  • A3D_SUCCESS

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DGlobalFontTextBoxAndScaleGet(const A3DFontKeyData *psFontKeyData, A3DUTF8Char *pcText, A3DDouble *pdLength, A3DDouble *pdHeight, A3DDouble *pdScale)

Gets text bounding box and scale according to the font.

Version

7.2

Return values
  • A3D_INITIALIZE_NOT_CALLED

  • A3D_INVALID_ENTITY_NULL

  • A3D_INVALID_ENTITY_TYPE

  • A3D_MARKUP_CANNOT_ACCESS_FONT

  • A3D_MARKUP_INVALID_FONTKEY

  • A3D_SUCCESS

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DGlobalFontKeyCreate(const A3DFontData *pFontData, A3DFontKeyData *pFontKeyData)

Creates the A3DFontKeyData structure from the A3DFontData structure.

Version

2.0

Return values
  • A3D_INVALID_DATA_STRUCT_SIZE

  • A3D_INVALID_DATA_STRUCT_NULL

  • A3D_MARKUP_CANNOT_CREATE_FONTKEY

  • A3D_MARKUP_INVALID_FONTKEY

  • A3D_SUCCESS

Returns

A3D_SUCCESS in case of success or an error code

A3DStatus A3DGlobalFontTextTessellationGet(const A3DFontKeyData *psFontKeyData, const A3DUTF8Char *pcOneChar, A3DRiSet **ppset, A3DDouble *pdCharWidth)

Gets text tessellation as wireframe.

Version

6.1

Return values
  • A3D_INITIALIZE_NOT_CALLED

  • A3D_INVALID_ENTITY_NULL

  • A3D_INVALID_ENTITY_TYPE

  • A3D_MARKUP_CANNOT_ACCESS_FONT

  • A3D_MARKUP_INVALID_FONTKEY

  • A3D_SUCCESS

Returns

A3D_SUCCESS in case of success or an error code