NVIDIA IndeX API nvidia_logo_transpbg.gif Up
nv::index::IFont Class Referenceabstract

A font attribute describes the appearance of a label in the scene description. More...

#include <ifont.h>

Inherits mi::base::Interface_declare< 0xde2a47e9, ... >.

Public Member Functions

virtual bool set_file_name (const char *font_file_name)=0
 Set the font file name. More...
 
virtual const char * get_file_name () const =0
 Returns the font file name. More...
 
virtual bool set_font_resolution (mi::Float32 resolution)=0
 Set the font resolution. More...
 
virtual mi::Float32 get_font_resolution () const =0
 Get the resolution of the font. More...
 

Detailed Description

A font attribute describes the appearance of a label in the scene description.

Member Function Documentation

 get_file_name()

virtual const char * nv::index::IFont::get_file_name ( ) const
pure virtual

Returns the font file name.

Returns
Unix style path to the font file.

 get_font_resolution()

virtual mi::Float32 nv::index::IFont::get_font_resolution ( ) const
pure virtual

Get the resolution of the font.

The resolution of the font defines the resolution of the bitmap generated for the labels, thus, influences the visual quality of the labels.

Returns
The font resolution in pixels.

 set_file_name()

virtual bool nv::index::IFont::set_file_name ( const char *  font_file_name)
pure virtual

Set the font file name.

Parameters
font_file_nameUnix style path to the font file.
Returns
false when the specified font path doesn't found on the system when this method is called. However the path will be set.

 set_font_resolution()

virtual bool nv::index::IFont::set_font_resolution ( mi::Float32  resolution)
pure virtual

Set the font resolution.

The resolution of the font defines the resolution of the bitmap generated for the labels, thus, influences the visual quality of the labels. The recommended useful range of this size is in [16, 1024].

Parameters
resolutionThe font resolution in pixels.
Returns
true when set is succeeded.

The documentation for this class was generated from the following file: