Function Index Class Index

Show_Text_XXX


Functions

HC_EXTERNAL HIC_API HIC_Point
const * 
HIC_Show_3D_Text_Position (HIC_Text const *t)
HC_EXTERNAL HIC_API HIC_Integer32 HIC_Show_Internal_Text_Color (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API float HIC_Show_KInfo_Height (HIC_Text_Karacter_Info const *iki)
HC_EXTERNAL HIC_API
HIC_Rendition const * 
HIC_Show_KInfo_Net_Rendition (HIC_Text_Karacter_Info const *iki)
HC_EXTERNAL HIC_API HIC_Point
const * 
HIC_Show_KInfo_Point (HIC_Text_Karacter_Info const *ki)
HC_EXTERNAL HIC_API HIC_Point
const * 
HIC_Show_KInfo_Position (HIC_Text_Karacter_Info const *ki)
HC_EXTERNAL HIC_API float HIC_Show_KInfo_Width (HIC_Text_Karacter_Info const *iki)
HC_EXTERNAL HIC_API int HIC_Show_Text_Alignment (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API HIC_Vector
const * 
HIC_Show_Text_Baseline (HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API int HIC_Show_Text_Char_Encoding (HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API HIC_Vector
const * 
HIC_Show_Text_Char_Horizontal (HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API HIC_Point
const * 
HIC_Show_Text_Char_Position (HIC_Rendition const *nr, HIC_Text_Info const *ti, int index)
HC_EXTERNAL HIC_API HIC_Vector
const * 
HIC_Show_Text_Char_Vertical (HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API float HIC_Show_Text_Char_Width (HIC_Rendition const *nr, HIC_Text_Info const *ti, int index)
HC_EXTERNAL HIC_API float HIC_Show_Text_Color_Blue (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API float HIC_Show_Text_Color_Green (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API float HIC_Show_Text_Color_Red (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API int const * HIC_Show_Text_Counts (HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API float HIC_Show_Text_Final_Font_Size (HIC_Rendition const *inr)
HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Extra_Space (HIC_Rendition const *inr)
HC_EXTERNAL HIC_API HIC_Size_Units HIC_Show_Text_Font_Extra_Space_Units (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API void * HIC_Show_Text_Font_ID (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API int HIC_Show_Text_Font_Index (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API const char * HIC_Show_Text_Font_Name (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Rotation (HIC_Rendition const *inr)
HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Size (HIC_Rendition const *inr)
HC_EXTERNAL HIC_API HIC_Size_Units HIC_Show_Text_Font_Size_Tol_Units (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Size_Tolerance (HIC_Rendition const *inr)
HC_EXTERNAL HIC_API HIC_Size_Units HIC_Show_Text_Font_Size_Units (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Slant (HIC_Rendition const *inr)
HC_EXTERNAL HIC_API int HIC_Show_Text_Font_Transform (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API bool HIC_Show_Text_Is_Outlined (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API int const * HIC_Show_Text_KIndex (HIC_Rendition const *nr, HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API
HIC_Text_Karacter_Info const * 
HIC_Show_Text_KInfo (HIC_Rendition const *nr, HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API
HIC_Text_Karacter_Info const * 
HIC_Show_Text_KInfo_At_Index (HIC_Rendition const *nr, HIC_Text_Info const *ti, int index)
HC_EXTERNAL HIC_API int HIC_Show_Text_Length (HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API int HIC_Show_Text_Line_Count (HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API int HIC_Show_Text_Line_Index (HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API HIC_Vector
const * 
HIC_Show_Text_Longest_Baseline (HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API HIC_Vector
const * 
HIC_Show_Text_Next_Line (HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API HIC_Vector
const * 
HIC_Show_Text_Path (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API HIC_Point
const * 
HIC_Show_Text_Position (HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API HIC_Point
const * 
HIC_Show_Text_Reference (HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API float HIC_Show_Text_Spacing (HIC_Rendition const *inr)
HC_EXTERNAL HIC_API const char * HIC_Show_Text_Specified_Text (HIC_Rendition const *nr)
HC_EXTERNAL HIC_API
HIC_Karacter const * 
HIC_Show_Text_String (HIC_Text_Info const *ti)
HC_EXTERNAL HIC_API double HIC_Show_Text_Width_Scale (HIC_Rendition const *nr)

Function Documentation

HC_EXTERNAL HIC_API HIC_Point const* HIC_Show_3D_Text_Position ( HIC_Text const *  t  ) 

Parameters:
t A pointer to a const HIC_Text.
Returns:
A pointer to a const HIC_Point.
This function returns the text position that is stored in the graphics database.

HC_EXTERNAL HIC_API HIC_Integer32 HIC_Show_Internal_Text_Color ( HIC_Rendition const *  nr  ) 

Parameters:
nr A pointer to a const HIC_Rendition.
Returns:
A HIC_Integer32.
This function returns the internal representation of the text color.

HC_EXTERNAL HIC_API float HIC_Show_KInfo_Height ( HIC_Text_Karacter_Info const *  iki  ) 

Parameters:
iki A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const HIC_Point.
This function returns the Text_Karacter_Info height.

HC_EXTERNAL HIC_API HIC_Rendition const* HIC_Show_KInfo_Net_Rendition ( HIC_Text_Karacter_Info const *  iki  ) 

Parameters:
iki A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const HIC_Rendition.
This function returns the Text_Karacter_Info net rendition.

HC_EXTERNAL HIC_API HIC_Point const* HIC_Show_KInfo_Point ( HIC_Text_Karacter_Info const *  ki  ) 

Parameters:
ki A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const HIC_Point.
This function returns the Text_Karacter_Info point.

HC_EXTERNAL HIC_API HIC_Point const* HIC_Show_KInfo_Position ( HIC_Text_Karacter_Info const *  ki  ) 

Parameters:
ki A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const HIC_Point.
This function returns the Text_Karacter_Info position.

HC_EXTERNAL HIC_API float HIC_Show_KInfo_Width ( HIC_Text_Karacter_Info const *  iki  ) 

Parameters:
iki A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const HIC_Point.
This function returns the Text_Karacter_Info width.

HC_EXTERNAL HIC_API int HIC_Show_Text_Alignment ( HIC_Rendition const *  nr  ) 

Parameters:
nr A pointer to a const HIC_Rendition.
Returns:
An int.
This function returns the text alignment as in int.

See also:
HIC_Set_Text_Alignment

HC_EXTERNAL HIC_API HIC_Vector const* HIC_Show_Text_Baseline ( HIC_Text_Info const *  ti  ) 

Parameters:
ti A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const HIC_Vector.
This function returns the text baseline.

HC_EXTERNAL HIC_API int HIC_Show_Text_Char_Encoding ( HIC_Text_Info const *  ti  ) 

Parameters:
ti A pointer to a const HIC_Text_Info.
Returns:
An int.
This function returns the text char encoding as an int.

HC_EXTERNAL HIC_API HIC_Vector const* HIC_Show_Text_Char_Horizontal ( HIC_Text_Info const *  ti  ) 

Parameters:
ti A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const HIC_Vector.
This function returns the text char horizontal.

HC_EXTERNAL HIC_API HIC_Point const* HIC_Show_Text_Char_Position ( HIC_Rendition const *  nr,
HIC_Text_Info const *  ti,
int  index 
)

Parameters:
nr A pointer to a const HIC_Rendition.
ti A pointer to a const HIC_Text_Info.
index An int.
Returns:
A pointer to a const HIC_Point.
This function returns the text char position.

HC_EXTERNAL HIC_API HIC_Vector const* HIC_Show_Text_Char_Vertical ( HIC_Text_Info const *  ti  ) 

Parameters:
ti A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const HIC_Vector.
This function returns the text char vertical.

HC_EXTERNAL HIC_API float HIC_Show_Text_Char_Width ( HIC_Rendition const *  nr,
HIC_Text_Info const *  ti,
int  index 
)

Parameters:
nr A pointer to a const HIC_Rendition.
ti A pointer to a const HIC_Text_Info.
index An int.
Returns:
A float.
This function returns the text char width as a float value.

HC_EXTERNAL HIC_API float HIC_Show_Text_Color_Blue ( HIC_Rendition const *  nr  ) 

Parameters:
nr A pointer to a const HIC_Rendition.
Returns:
A float.
This function returns the blue component of the text color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API float HIC_Show_Text_Color_Green ( HIC_Rendition const *  nr  ) 

Parameters:
nr A pointer to a const HIC_Rendition.
Returns:
A float.
This function returns the green component of the text color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API float HIC_Show_Text_Color_Red ( HIC_Rendition const *  nr  ) 

Parameters:
nr A pointer to a const HIC_Rendition.
Returns:
A float.
This function returns the red component of the text color as a float value with a range 0 to 1.

HC_EXTERNAL HIC_API int const* HIC_Show_Text_Counts ( HIC_Text_Info const *  ti  ) 

Parameters:
ti A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const int.
This function returns the text counts array.

HC_EXTERNAL HIC_API float HIC_Show_Text_Final_Font_Size ( HIC_Rendition const *  inr  ) 

Parameters:
inr A pointer to a const HIC_Rendition.
Returns:
A float.
This function returns the final text font size as a float.

HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Extra_Space ( HIC_Rendition const *  inr  ) 

Parameters:
inr A pointer to a const HIC_Rendition.
Returns:
A float.
This function returns the text font extra space as a float.

HC_EXTERNAL HIC_API HIC_Size_Units HIC_Show_Text_Font_Extra_Space_Units ( HIC_Rendition const *  nr  ) 

Parameters:
nr A pointer to a const HIC_Rendition.
Returns:
A HIC_Size_Units.
This function returns the text font extra space units.

HC_EXTERNAL HIC_API void* HIC_Show_Text_Font_ID ( HIC_Rendition const *  nr  ) 

Parameters:
nr A pointer to a const HIC_Rendition.
Returns:
void pointer
This function returns the text font ID.

HC_EXTERNAL HIC_API int HIC_Show_Text_Font_Index ( HIC_Rendition const *  nr  ) 

Parameters:
nr A pointer to a const HIC_Rendition.
Returns:
An int.
This function returns the text font index as an int.

HC_EXTERNAL HIC_API const char* HIC_Show_Text_Font_Name ( HIC_Rendition const *  nr  ) 

Parameters:
nr A pointer to a const HIC_Rendition.
Returns:
A pointer to a const char.
This function returns the text font name as a string.

HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Rotation ( HIC_Rendition const *  inr  ) 

Parameters:
inr A pointer to a const HIC_Rendition.
Returns:
A float.
This function returns the text font rotation as a float.

HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Size ( HIC_Rendition const *  inr  ) 

Parameters:
inr A pointer to a const HIC_Rendition.
Returns:
A float.
This function returns the text font size as a float.

HC_EXTERNAL HIC_API HIC_Size_Units HIC_Show_Text_Font_Size_Tol_Units ( HIC_Rendition const *  nr  ) 

Parameters:
nr A pointer to a const HIC_Rendition.
Returns:
A HIC_Size_Units.
This function returns the text font size tolerance units.

HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Size_Tolerance ( HIC_Rendition const *  inr  ) 

Parameters:
inr A pointer to a const HIC_Rendition.
Returns:
A float.
This function returns the text font size tolerance as a float.

HC_EXTERNAL HIC_API HIC_Size_Units HIC_Show_Text_Font_Size_Units ( HIC_Rendition const *  nr  ) 

Parameters:
nr A pointer to a const HIC_Rendition.
Returns:
A HIC_Size_Units.
This function returns the text font size units.

HC_EXTERNAL HIC_API float HIC_Show_Text_Font_Slant ( HIC_Rendition const *  inr  ) 

Parameters:
inr A pointer to a const HIC_Rendition.
Returns:
A float.
This function returns the text font slant as a float.

HC_EXTERNAL HIC_API int HIC_Show_Text_Font_Transform ( HIC_Rendition const *  nr  ) 

Parameters:
nr A pointer to a const HIC_Rendition.
Returns:
An int.
This function returns the text font transform as an int.

HC_EXTERNAL HIC_API bool HIC_Show_Text_Is_Outlined ( HIC_Rendition const *  nr  ) 

Parameters:
inr A pointer to a const HIC_Rendition.
Returns:
A bool.
This function returns true if the text is outlined.

HC_EXTERNAL HIC_API int const* HIC_Show_Text_KIndex ( HIC_Rendition const *  nr,
HIC_Text_Info const *  ti 
)

Parameters:
nr A pointer to a const HIC_Rendition.
ti A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const int.
This function returns the int pointer owned by the HIC_Text_Info.

HC_EXTERNAL HIC_API HIC_Text_Karacter_Info const* HIC_Show_Text_KInfo ( HIC_Rendition const *  nr,
HIC_Text_Info const *  ti 
)

Parameters:
nr A pointer to a const HIC_Rendition.
ti A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const Text_Karacter_Info.
This function returns the Text_Karacter_Info pointer owned by the HIC_Text_Info.

HC_EXTERNAL HIC_API HIC_Text_Karacter_Info const* HIC_Show_Text_KInfo_At_Index ( HIC_Rendition const *  nr,
HIC_Text_Info const *  ti,
int  index 
)

Parameters:
nr A pointer to a const HIC_Rendition.
ti A pointer to a const HIC_Text_Info.
index Index into Karacter_Info array
Returns:
A pointer to a const Text_Karacter_Info.
This function returns the Text_Karacter_Info pointer owned by the HIC_Text_Info.

HC_EXTERNAL HIC_API int HIC_Show_Text_Length ( HIC_Text_Info const *  ti  ) 

Parameters:
ti A pointer to a const HIC_Text_Info.
Returns:
An int.
This function returns the text length as an int representing the number of characters in the text string.

HC_EXTERNAL HIC_API int HIC_Show_Text_Line_Count ( HIC_Text_Info const *  ti  ) 

Parameters:
ti A pointer to a const HIC_Text_Info.
Returns:
An int.
This function returns the text line count as an int.

HC_EXTERNAL HIC_API int HIC_Show_Text_Line_Index ( HIC_Text_Info const *  ti  ) 

Parameters:
ti A pointer to a const HIC_Text_Info.
Returns:
An int.
This function returns the text line index as an int.

HC_EXTERNAL HIC_API HIC_Vector const* HIC_Show_Text_Longest_Baseline ( HIC_Text_Info const *  ti  ) 

Parameters:
ti A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const HIC_Vector.
This function returns the text longest baseline.

HC_EXTERNAL HIC_API HIC_Vector const* HIC_Show_Text_Next_Line ( HIC_Text_Info const *  ti  ) 

Parameters:
ti A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const HIC_Vector.
This function returns the text next line vector.

HC_EXTERNAL HIC_API HIC_Vector const* HIC_Show_Text_Path ( HIC_Rendition const *  nr  ) 

Parameters:
nr A pointer to a const HIC_Rendition.
Returns:
A pointer to a const HIC_Vector.
This function returns the text path.

HC_EXTERNAL HIC_API HIC_Point const* HIC_Show_Text_Position ( HIC_Text_Info const *  ti  ) 

Parameters:
ti A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const HIC_Point.
This function returns the text position.

HC_EXTERNAL HIC_API HIC_Point const* HIC_Show_Text_Reference ( HIC_Text_Info const *  ti  ) 

Parameters:
ti A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const HIC_Point.
This function returns the text reference.

HC_EXTERNAL HIC_API float HIC_Show_Text_Spacing ( HIC_Rendition const *  inr  ) 

Parameters:
inr A pointer to a const HIC_Rendition.
Returns:
A float.
This function returns the text spacing as a float.

HC_EXTERNAL HIC_API const char* HIC_Show_Text_Specified_Text ( HIC_Rendition const *  nr  ) 

Parameters:
inr A pointer to a const HIC_Rendition.
Returns:
A const char *.
This function returns the text specified text.

HC_EXTERNAL HIC_API HIC_Karacter const* HIC_Show_Text_String ( HIC_Text_Info const *  ti  ) 

Parameters:
ti A pointer to a const HIC_Text_Info.
Returns:
A pointer to a const HIC_Karacter.
This function returns the text string.

HC_EXTERNAL HIC_API double HIC_Show_Text_Width_Scale ( HIC_Rendition const *  nr  ) 

Parameters:
inr A pointer to a const HIC_Rendition.
Returns:
A double.
This function returns the text width scale.