PCK-Studio/MinecraftUSkinEditor/Classes/StoneVOX/QFont/QFontRenderOptions.cs

using OpenTK;
using OpenTK.Graphics;
using System.Drawing;

namespace QuickFont
{
    public enum QFontAlignment { Left=0, Right, Centre, Justify }
    public enum QFontMonospacing { Natural = 0, Yes, No }

    public class QFontRenderOptions
    {
        /// <summary>
        /// The font colour
        /// </summary>
        public Color4 Colour = Color.FromArgb(255,255,255,255);

        /// <summary>
        /// Spacing between characters in units of average glyph width
        /// </summary>
        public float CharacterSpacing = 0.05f;

        /// <summary>
        /// Spacing between words in units of average glyph width
        /// </summary>
        public float WordSpacing = 0.9f;

        /// <summary>
        /// Line spacing in units of max glyph width
        /// </summary>
        public float LineSpacing = 1.0f;


        /// <summary>
        /// Whether to draw a drop-shadow. Note: this requires
        /// the QFont to have been loaded with a drop shadow to
        /// take effect.
        /// </summary>
        public bool DropShadowActive = false;

        /// <summary>
        /// Offset of the shadow from the font glyphs in units of average glyph width
        /// </summary>
        public Vector2 DropShadowOffset = new Vector2(0.16f, 0.16f);

        /// <summary>
        /// Opacity of drop shadows
        /// </summary>
        public float DropShadowOpacity = 0.5f;


        /// <summary>
        /// Whether to render the font in monospaced mode. If set to "Natural", then 
        /// monospacing will be used if the font loaded font was detected to be monospaced.
        /// </summary>
        public QFontMonospacing Monospacing = QFontMonospacing.Natural;


        /// <summary>
        /// This is intended as a means of rendering text pixel-perfectly at a 
        /// fixed display size (size on screen) independent of the screen resolution.
        /// 
        /// Ordinarily it is possible to render pixel-perfect text by calling 
        /// QFont.Begin() / QFont.End(); however, this means working in a coordinate 
        /// system corresponding to the current screen resolution. If the screen 
        /// resolution changes, then the display size of the font will change 
        /// accordingly which may not be desirable. Many games/applications prefer 
        /// to use a fixed orthog coordinate system that is independent of screen 
        /// resolution (e.g. 1000x1000) so that when the screen resolution changes,
        /// everything is still the same size on screen, it simply has higher
        /// definition - which is what this setting supports.
        /// 
        /// One option is simply not to call QFont.Begin() / QFont.End(). This
        /// works; however, it becomes impossible to assure that glyphs are
        /// rendered pixel-perfectly. Instead they will be scaled in hardware.
        /// In most cases this looks fine; however, if you are a perfectionist, 
        /// you may prefer to use this option to assure pixel perfection.
        /// 
        /// Setting this option does two things:
        /// 
        /// Rendering to a specified position is transformed
        /// Measurements are transformed
        /// 
        /// So for example, suppose the screen resolution is 1024x768, but you 
        /// wish to run orthog mode at 1000x1000.  If you set:
        /// 
        /// myFont.Options.TransformToViewport = new Viewport(0,0,1000,1000);
        ///
        /// Then, if you render at position 500,500:
        /// 
        /// QFont.Begin();
        /// myFont.Options.LockToPixel = true;
        /// myFont.Print("Hello",new Vector2(500,500));
        /// QFont.End();
        ///
        /// This will be printed pixel-pefectly at pixel position 512, 384.
        /// 
        /// Additionally the font will be measured in terms of your 500x500 
        /// coordinate system.
        /// 
        /// The only issue is that if you change the resolution, the size of your
        /// font will change. You can get around this by loading a font size
        /// that is proportional to the screen resolution. This makes sense:
        /// if you want a font to be rendered pixel-perfectly at a higher
        /// resolution, it will need to be a larger font. At present this 
        /// needs to be doen manually. E.g:
        /// 
        ///    float fontScale = (float)Height / 800;
        ///    compyFontSmall = new QFont("Data/comfy.ttf", 14 * fontScale);
        /// 
        /// 
        /// </summary>
        public TransformViewport? TransformToViewport = null;

        /// <summary>
        /// Locks the position to a particular pixel, allowing the text to be rendered pixel-perfectly.
        /// You need to turn this off if you wish to move text around the screen smoothly by fractions 
        /// of a pixel.
        /// </summary>
        public bool LockToPixel;

        /// <summary>
        /// Only applies when LockToPixel is true:
        /// This is used to transition smoothly between being locked to pixels and not
        /// </summary>
        public float LockToPixelRatio = 1.0f;

        /// <summary>
        /// Whether to always set :
        /// GL.BlendFunc(BlendingFactorSrc.SrcAlpha, BlendingFactorDest.DstAlpha);
        /// before rendering text.
        /// 
        /// </summary>
        public bool UseDefaultBlendFunction = true;




        #region Justify Options

        /// <summary>
        /// When a line of text is justified, space may be inserted between
        /// characters, and between words. 
        /// 
        /// This parameter determines how this choice is weighted:
        /// 
        /// 0.0f => word spacing only
        /// 1.0f => "fairly" distributed between both
        /// > 1.0 => in favour of character spacing
        /// 
        /// This applies to expansions only.
        /// 
        /// </summary>
        public float JustifyCharacterWeightForExpand
        {
            get { return justifyCharWeightForExpand; }
            set { 

                justifyCharWeightForExpand = value;

                if (justifyCharWeightForExpand < 0f)
                    justifyCharWeightForExpand = 0f;
                else if (justifyCharWeightForExpand > 1.0f)
                    justifyCharWeightForExpand = 1.0f;
            }
        }

        private float justifyCharWeightForExpand = 0.5f;


        /// <summary>
        /// When a line of text is justified, space may be removed between
        /// characters, and between words. 
        /// 
        /// This parameter determines how this choice is weighted:
        /// 
        /// 0.0f => word spacing only
        /// 1.0f => "fairly" distributed between both
        /// > 1.0 => in favour of character spacing
        /// 
        /// This applies to contractions only.
        /// 
        /// </summary>
        public float JustifyCharacterWeightForContract
        {
            get { return justifyCharWeightForContract; }
            set
            {

                justifyCharWeightForContract = value;

                if (justifyCharWeightForContract < 0f)
                    justifyCharWeightForContract = 0f;
                else if (justifyCharWeightForContract > 1.0f)
                    justifyCharWeightForContract = 1.0f;
            }
        }

        private float justifyCharWeightForContract = 0.2f;



        /// <summary>
        /// Total justification cap as a fraction of the boundary width.
        /// </summary>
        public float JustifyCapExpand = 0.5f;


        /// <summary>
        /// Total justification cap as a fraction of the boundary width.
        /// </summary>
        public float JustifyCapContract = 0.1f;

        /// <summary>
        /// By what factor justification is penalized for being negative.
        /// 
        /// (e.g. if this is set to 3, then a contraction will only happen
        /// over an expansion if it is 3 of fewer times smaller than the
        /// expansion).
        /// 
        /// 
        /// </summary>
        public float JustifyContractionPenalty = 2;


        #endregion



        public QFontRenderOptions CreateClone()
        {
            var clone = new QFontRenderOptions();

            clone.Colour = Colour;
            clone.CharacterSpacing = CharacterSpacing;
            clone.WordSpacing = WordSpacing;
            clone.LineSpacing = LineSpacing;
            clone.DropShadowActive = DropShadowActive;
            clone.DropShadowOffset = DropShadowOffset;
            clone.DropShadowOpacity = DropShadowOpacity;
            clone.Monospacing = Monospacing;
            clone.TransformToViewport = TransformToViewport;
            clone.LockToPixel = LockToPixel;
            clone.LockToPixelRatio = LockToPixelRatio;
            clone.UseDefaultBlendFunction = UseDefaultBlendFunction;
            clone.JustifyCharacterWeightForExpand = JustifyCharacterWeightForExpand;
            clone.justifyCharWeightForExpand = justifyCharWeightForExpand; 
            clone.JustifyCharacterWeightForContract = JustifyCharacterWeightForContract;
            clone.justifyCharWeightForContract = justifyCharWeightForContract;
            clone.JustifyCapExpand = JustifyCapExpand;
            clone.JustifyCapContract = JustifyCapContract;
            clone.JustifyContractionPenalty = JustifyContractionPenalty;

            return clone;
        }

    }
}