Modules

 Flags for Font and Font-Key Attributes
 

Data Structures

struct  A3DFontData
 Font structure. More...
 
struct  A3DFontKeyData
 Font key structure. More...
 

Enumerations

enum  A3DECharSet {
  kA3DCharsetUnknown = -1,
  kA3DCharsetRoman = 0,
  kA3DCharsetJapanese,
  kA3DCharsetTraditionalChinese,
  kA3DCharsetKorean,
  kA3DCharsetArabic,
  kA3DCharsetHebrew,
  kA3DCharsetGreek,
  kA3DCharsetCyrillic,
  kA3DCharsetRightLeft,
  kA3DCharsetDevanagari,
  kA3DCharsetGurmukhi,
  kA3DCharsetGujarati,
  kA3DCharsetOriya,
  kA3DCharsetBengali,
  kA3DCharsetTamil,
  kA3DCharsetTelugu,
  kA3DCharsetKannada,
  kA3DCharsetMalayalam,
  kA3DCharsetSinhalese,
  kA3DCharsetBurmese,
  kA3DCharsetKhmer,
  kA3DCharsetThai,
  kA3DCharsetLaotian,
  kA3DCharsetGeorgian,
  kA3DCharsetArmenian,
  kA3DCharsetSimplifiedChinese,
  kA3DCharsetTibetan,
  kA3DCharsetMongolian,
  kA3DCharsetGeez,
  kA3DCharsetEastEuropeanRoman,
  kA3DCharsetVietnamese,
  kA3DCharsetExtendedArabic
}
 Font key CharSet. More...
 

Functions

A3DStatus A3DGlobalFontKeyCreate (const A3DFontData *pFontData, A3DFontKeyData *pFontKeyData)
 Creates the A3DFontKeyData structure from the A3DFontData structure. More...
 
A3DStatus A3DGlobalFontKeyGet (const A3DFontKeyData *pFontKeyData, A3DFontData *pFontData)
 Retrieves font information (A3DFontData) from the A3DFontKeyData structure. This function is useful when reading markup tessellation. More...
 
A3DStatus A3DGlobalFontTextBoxAndScaleGet (const A3DFontKeyData *psFontKeyData, A3DUTF8Char *pcText, A3DDouble *pdLength, A3DDouble *pdHeight, A3DDouble *pdScale)
 Gets text bounding box and scale according to the font. More...
 
A3DStatus A3DGlobalFontTextBoxGet (const A3DFontKeyData *psFontKeyData, A3DUTF8Char *pcText, A3DDouble *pdLength, A3DDouble *pdHeight)
 Gets text bounding box according to the font. More...
 
A3DStatus A3DGlobalFontTextTessellationGet (const A3DFontKeyData *psFontKeyData, const A3DUTF8Char *pcOneChar, A3DRiSet **ppset, A3DDouble *pdCharWidth)
 Gets text tessellation as wireframe. More...
 

Detailed Description

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).

See also
Tessellation for Markups

Enumeration Type Documentation

◆ A3DECharSet

Font key CharSet.

Version
2.0
Enumerator
kA3DCharsetUnknown 

Unknown charset ;

kA3DCharsetRoman 

Roman charset

kA3DCharsetJapanese 

Japanese charset

kA3DCharsetTraditionalChinese 

Traditional chinese charset

kA3DCharsetKorean 

Korean charset

kA3DCharsetArabic 

Arabic charset

kA3DCharsetHebrew 

Hebrew charset

kA3DCharsetGreek 

Greek charset

kA3DCharsetCyrillic 

Cyrillic charset

kA3DCharsetRightLeft 

Right left charset

kA3DCharsetDevanagari 

Devanagari charset

kA3DCharsetGurmukhi 

Gurmukhi charset

kA3DCharsetGujarati 

Gujarati charset

kA3DCharsetOriya 

Oriya charset

kA3DCharsetBengali 

Bengali charset

kA3DCharsetTamil 

Tamil charset

kA3DCharsetTelugu 

Telugu charset

kA3DCharsetKannada 

Kannada charset

kA3DCharsetMalayalam 

Malayalam charset

kA3DCharsetSinhalese 

Sinhalese charset

kA3DCharsetBurmese 

Burmese charset

kA3DCharsetKhmer 

Khmer charset

kA3DCharsetThai 

Thai charset

kA3DCharsetLaotian 

Laotian charset

kA3DCharsetGeorgian 

Georgian charset

kA3DCharsetArmenian 

Armenian charset

kA3DCharsetSimplifiedChinese 

Simplified chinese charset

kA3DCharsetTibetan 

Tibetan charset

kA3DCharsetMongolian 

Mongolian charset

kA3DCharsetGeez 

Geez charset

kA3DCharsetEastEuropeanRoman 

East european roman charset

kA3DCharsetVietnamese 

Vietnamese charset

kA3DCharsetExtendedArabic 

Extended arabic charset

Function Documentation

◆ A3DGlobalFontKeyGet()

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
Returns
A3D_SUCCESS in case of success or an error code
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

◆ A3DGlobalFontTextBoxGet()

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

Gets text bounding box according to the font.

Version
5.2
Returns
A3D_SUCCESS in case of success or an error code
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

◆ A3DGlobalFontTextBoxAndScaleGet()

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
Returns
A3D_SUCCESS in case of success or an error code
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

◆ A3DGlobalFontKeyCreate()

A3DStatus A3DGlobalFontKeyCreate ( const A3DFontData pFontData,
A3DFontKeyData pFontKeyData 
)

Creates the A3DFontKeyData structure from the A3DFontData structure.

Version
2.0
Returns
A3D_SUCCESS in case of success or an error code
Return values
A3D_INVALID_DATA_STRUCT_SIZE
A3D_INVALID_DATA_STRUCT_NULL
A3D_MARKUP_CANNOT_CREATE_FONTKEY
A3D_MARKUP_INVALID_FONTKEY
A3D_SUCCESS

◆ A3DGlobalFontTextTessellationGet()

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

Gets text tessellation as wireframe.

Version
6.1
Returns
A3D_SUCCESS in case of success or an error code
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