TriDevs.TriEngine.Text.Font Class Reference

Holds a specific font type. More...

Inheritance diagram for TriDevs.TriEngine.Text.Font:

Collaboration diagram for TriDevs.TriEngine.Text.Font:

Public Member Functions
	Font (string name, string file, int size, bool dropShadow=false, FontType type=FontType.TTF)
	Initalizes a new Font instance. More...
	Font (string name, string file, int size, FontType type, FontConstructionConfig fontConstructionConfig)
	Initializes a new Font instance using the specified builder configuration. More...
override string	ToString ()
void	Dispose ()
	Disposes of this font instance, releasing all unmanaged resources. More...

Static Public Member Functions
static string	GetDefaultName (string file, int size)
	Returns an auto-generated font name based on the file name and font size. More...

Properties
string	Name [get]
	Gets the name of this font instance. More...
string	File [get]
	Gets the file used to create this font instance. More...
int	Size [get]
	Gets the size of this font in points. More...
FontType	Type [get]
	Gets the font type. More...
QFont	QFont [get]
	Gets the QFont instance associated with this font. More...
Color	Color [get, set]
	Gets or sets the color of this font. More...
Properties inherited from TriDevs.TriEngine.Resources.IResource
string	Name [get]
	Gets the name associated with this resource. More...

Detailed Description

Holds a specific font type.

Constructor & Destructor Documentation

TriDevs.TriEngine.Text.Font.Font	(	string	name,
		string	file,
		int	size,
		bool	dropShadow = false,
		FontType	type = FontType.TTF
	)

Initalizes a new Font instance.

Parameters

name	Name to use for identifying this font, must be unique. Can be set to null to allow the constructor to auto-generate a name for the font.
file	Path to the font file (TTF or qfont).
size	Size (in points) to use for this font.
dropShadow	Whether or not this font should have shadows.
type	The type of font. This will be detected by the file extension, but can be manually specified to control the fallback type used if one was not detected from the file name

            : this(
                name, file, size, type,
                new FontConstructionConfig(new QFontBuilderConfiguration(dropShadow),
                                           new QFontLoaderConfiguration(dropShadow)))
        {
            
        }

TriDevs.TriEngine.Text.Font.Font	(	string	name,
		string	file,
		int	size,
		FontType	type,
		FontConstructionConfig	fontConstructionConfig
	)

Initializes a new Font instance using the specified builder configuration.

Parameters

name	Name to use for identifying this font, must be unique. Can be set to null to allow the constructor to auto-generate a name for the font.
file	Path to the font file (TTF or qfont).
size	Size (in points) to use for this font.
type	The type of font. This will be detected by the file extension, but can be manually specified to control the fallback type used if one was not detected from the file name
fontConstructionConfig	The FontConstructionConfig containing relevant font build/load configurations.

        {
            _file = file;
            _size = size;

            var ext = Path.GetExtension(_file);

            if (string.IsNullOrEmpty(ext))
                throw new EngineException("Failed to get file extension of font file!",
                                          new IOException("System.IO.Path.GetExtension returned null or empty for specified file."));

            // Disable resharper warning, we are checking for null, resharper doesn't like IsNullOrEmpty
            // ReSharper disable PossibleNullReferenceException
            ext = ext.TrimStart('.').ToLower();
            // ReSharper restore PossibleNullReferenceException

            switch (ext)
            {
                case "ttf":
                    type = FontType.TTF;
                    break;
                case "qfont":
                    type = FontType.QFont;
                    break;
            }

            _type = type;

            QFont font;

            switch (_type)
            {
                case FontType.TTF:
                    if (fontConstructionConfig.BuildConfig == null)
                        throw new EngineException("Builder configuration was null but requested font type requires a builder config!",
                                                  new ArgumentException("BuildConfig was null.", "fontConstructionConfig"));
                    font = new QFont(_file, _size, fontConstructionConfig.BuildConfig);
                    break;
                case FontType.QFont:
                    if (fontConstructionConfig.LoadConfig == null)
                        throw new EngineException("Loader configuration was null but requested font type requires a loader config!",
                                                  new ArgumentException("LoadConfig was null.", "fontConstructionConfig"));
                    font = QFont.FromQFontFile(_file, fontConstructionConfig.LoadConfig);
                    break;
                default:
                    throw new EngineException("Unsupported font type: " + _type,
                                              new ArgumentException("Font type unsupported.", "type"));
            }

            if (font == null)
                throw new EngineException("Font failed to initialize!",
                                          new ArgumentException("Font failed to initialize.", "file"));

            _qfont = font;

            _name = name ?? GetDefaultName(file, size);
        }

Member Function Documentation

void TriDevs.TriEngine.Text.Font.Dispose

(

)

Disposes of this font instance, releasing all unmanaged resources.

        {
            QFont.Dispose();
        }

static string TriDevs.TriEngine.Text.Font.GetDefaultName ( string  file, int  size  )

static

Returns an auto-generated font name based on the file name and font size.

Parameters

file	The file name.
size	The size (in points) of the font.

Returns

The auto-generated font name.

        {
            return string.Format(NameFormat, Path.GetFileNameWithoutExtension(file), size);
        }

override string TriDevs.TriEngine.Text.Font.ToString

(

)

        {
            return Name;
        }

Property Documentation

Color TriDevs.TriEngine.Text.Font.Color

getset

Gets or sets the color of this font.

string TriDevs.TriEngine.Text.Font.File

get

Gets the file used to create this font instance.

string TriDevs.TriEngine.Text.Font.Name

get

Gets the name of this font instance.

QFont TriDevs.TriEngine.Text.Font.QFont

get

Gets the QFont instance associated with this font.

int TriDevs.TriEngine.Text.Font.Size

get

Gets the size of this font in points.

FontType TriDevs.TriEngine.Text.Font.Type

get

Gets the font type.

---

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

• TriDevs.TriEngine/Text/Font.cs