Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

Engine.Font

Extends
Object
Modifiers
hidecategories ( object ) dependsOn ( FontImportOptions ) native

Copyright 1998-2008 Epic Games, Inc. A font object, containing information about a set of glyphs. The glyph bitmaps are stored in the contained textures, while the font database only contains the coordinates of the individual glyph.

Core.Object
|   
+-- Engine.Font

Direct Known Subclasses:

MultiFont

Constants Summary
NULLCHARACTER=127
Inherited Contants from Core.Object
DegToRad, INDEX_NONE, MaxInt, Pi, RadToDeg

Variables Summary
MapCharRemap
intIsRemapped
intNumCharacters
array<Texture2D>Textures
Font
array<FontCharacter>Characters
FontImportOptionsDataImportOptions
intKerning
Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary
Inherited Enumerations from Core.Object
EAxis, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
FontCharacter
StartU, StartV, USize, VSize, TextureIndex, VerticalOffset
Inherited Structures from Core.Object
Box, BoxSphereBounds, Color, Cylinder, double, DynamicMap_Mirror, Guid, IndirectArray_Mirror, InterpCurveFloat, InterpCurvePointFloat, InterpCurvePointQuat, InterpCurvePointTwoVectors, InterpCurvePointVector, InterpCurvePointVector2D, InterpCurveQuat, InterpCurveTwoVectors, InterpCurveVector, InterpCurveVector2D, IntPoint, LinearColor, Map_Mirror, Matrix, MultiMap_Mirror, Plane, pointer, Quat, qword, RawDistribution, RenderCommandFence, Rotator, TextureMipBulkData_Mirror, ThreadSafeCounter, TPOV, TwoVectors, UntypedBulkData_Mirror, Vector, Vector2D, Vector4

Functions Summary
functionfloat GetAuthoredViewportHeight (float ViewportHeight ) con)
functionfloat GetMaxCharHeight () con)
functionint GetResolutionPageIndex (float HeightTest) con)
functionfloat GetScalingFactor (float HeightTest) con)
Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, Asc, Asin, Atan, BeginState, ByteToFloat, Caps, Chr, Clamp, ClampLength, ClampRotAxis, ClassIsChildOf, ClearConfig, ClockwiseFrom, ColorToLinearColor, ContinuedState, Cos, Cross, Disable, Dot, DumpStateStack, DynamicLoadObject, Enable, EndState, Exp, FClamp, FCubicInterp, FindDeltaAngle, FindObject, FInterpEaseIn, FInterpEaseInOut, FInterpEaseOut, FInterpTo, FloatToByte, FMax, FMin, FPctByRange, FRand, GetAngularDegreesFromRadians, GetAngularDistance, GetAngularFromDotDist, GetAxes, GetDotDistance, GetEnum, GetFuncName, GetHeadingAngle, GetNetFuncName, GetPackageName, GetPerObjectConfigSections, GetRangePctByValue, GetRangeValueByPct, GetSpecialValue, GetStateName, GetUnAxes, GotoState, InStr, IsA, IsChildState, IsInState, IsNetScript, IsPendingKill, IsUTracing, IsZero, JoinArray, Left, Len, Lerp, Localize, Locs, Loge, LogInternal, MakeColor, MakeLinearColor, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NormalizeRotAxis, OrthoRotation, ParseStringIntoArray, PathName, PausedState, PointDistToLine, PointDistToPlane, PointInBox, PoppedState, PopState, ProjectOnTo, PushedState, PushState, QuatDot, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RandRange, RDiff, Repl, Right, RInterpTo, RLerp, RotRand, Round, RSize, RSmerp, SaveConfig, SClampRotAxis, ScriptTrace, SetSpecialValue, SetUTracing, Sin, Split, Sqrt, Square, StaticClearConfig, StaticSaveConfig, Tan, TimeStamp, ToHex, TransformVectorByRotation, UnwindHeading, vect2d, VInterpTo, VLerp, VRand, VSize, VSize2D, VSizeSq, VSizeSq2D, VSmerp, WarnInternal, ^, ^^, |, ||, ~, ~=


Constants Detail

NULLCHARACTER Source code

const NULLCHARACTER = 127;


Variables Detail

CharRemap Source code

var private const native Map CharRemap;
When IsRemapped is true, this array maps unicode values to entries in the Characters array

IsRemapped Source code

var int IsRemapped;
True if font is 'remapped'. That is, the character array is not a direct mapping to unicode values. Instead,

NumCharacters Source code

var transient int NumCharacters;
Number of characters in the font, not including multiple instances of the same character (for multi-fonts).

Textures Source code

var array<Texture2D> Textures;
Textures that store this font's glyph image data

Font

Characters Source code

var(Font) editinline array<FontCharacter> Characters;
List of characters in the font. For a MultiFont, this will include all characters in all sub-fonts! Thus,

ImportOptions Source code

var(Font) FontImportOptionsData ImportOptions;
Options used when importing this font

Kerning Source code

var(Font) int Kerning;
Default horizontal spacing between characters when rendering text with this font


Structures Detail

FontCharacter Source code

struct immutable FontCharacter
{
var(Font) int StartU;
var(Font) int StartV;
var(Font) editconst BYTE TextureIndex;
var(Font) int USize;
var(Font) int VerticalOffset;
var(Font) int VSize;
};
this struct is serialized using binary serialization so any changes to it require a package version bump


Functions Detail

GetAuthoredViewportHeight Source code

native final virtual const function float GetAuthoredViewportHeight ( float ViewportHeight ) con )
Determine the height of the mutli-font resolution page which will be used for the specified resolution.
@param ViewportHeight the height (in pixels) of the viewport being rendered to.

GetMaxCharHeight Source code

native const function float GetMaxCharHeight ( ) con )

@return the height (in pixels) of the tallest character in this font.
@param HeightTest the height (in pixels) of the viewport being rendered to; if not specified

GetResolutionPageIndex Source code

native const function int GetResolutionPageIndex ( float HeightTest) con )
Calulate the index for the texture page containing the multi-font character set to use, based on the specified screen resolution.
@param HeightTest the height (in pixels) of the viewport being rendered to.
@return the index of the multi-font "subfont" that most closely matches the specified resolution. this value is used as the value for "ResolutionPageIndex" when calling other font-related methods.

GetScalingFactor Source code

native const function float GetScalingFactor ( float HeightTest) con )
Calculate the amount of scaling necessary to match the multi-font subfont which most closely matches the specified resolution.
@param HeightTest the height (in pixels) of the viewport being rendered to.
@return the percentage scale required to match the size of the multi-font's closest matching subfont.


Defaultproperties

defaultproperties
{
   ImportOptions=(FontName="Arial",Height=16.000000,bEnableAntialiasing=True,ForegroundColor=(R=1.000000,G=1.000000,B=1.000000,A=1.000000),TexturePageWidth=256,TexturePageMaxHeight=256,XPadding=1,YPadding=1)
   Name="Default__Font"
   ObjectArchetype=Object'Core.Default__Object'
}

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: sk 18-3-2018 10:00:36.891 - Created with UnCodeX