source: branches/HeuristicLab.Problems.GaussianProcessTuning/ILNumerics.2.14.4735.573/Drawing/Misc/Definitions.cs @ 10903

///
///    This file is part of ILNumerics Community Edition.
///
///    ILNumerics Community Edition - high performance computing for applications.
///    Copyright (C) 2006 - 2012 Haymo Kutschbach, http://ilnumerics.net
///
///    ILNumerics Community Edition is free software: you can redistribute it and/or modify
///    it under the terms of the GNU General Public License version 3 as published by
///    the Free Software Foundation.
///
///    ILNumerics Community Edition is distributed in the hope that it will be useful,
///    but WITHOUT ANY WARRANTY; without even the implied warranty of
///    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
///    GNU General Public License for more details.
///
///    You should have received a copy of the GNU General Public License
///    along with ILNumerics Community Edition. See the file License.txt in the root
///    of your distribution package. If not, see <http://www.gnu.org/licenses/>.
///
///    In addition this software uses the following components and/or licenses: 
///
///    =================================================================================
///    The Open Toolkit Library License
///    
///    Copyright (c) 2006 - 2009 the Open Toolkit library.
///    
///    Permission is hereby granted, free of charge, to any person obtaining a copy
///    of this software and associated documentation files (the "Software"), to deal
///    in the Software without restriction, including without limitation the rights to 
///    use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
///    the Software, and to permit persons to whom the Software is furnished to do
///    so, subject to the following conditions:
///
///    The above copyright notice and this permission notice shall be included in all
///    copies or substantial portions of the Software.
///
///    =================================================================================
///    

#pragma warning disable 1591

using System;
using System.Collections.Generic;
using System.Text;
using System.Drawing;
using System.Runtime.InteropServices;
using ILNumerics.Drawing.Graphs; 


namespace ILNumerics.Drawing {


    /// <summary>
    /// Options for adapting ILPanel view limits 
    /// </summary>
    public enum AutoZoomOptions {
        /// <summary>
        /// never adapt automatically, the view limits are handled by the user
        /// </summary>
        Never,
        /// <summary>
        /// Only adapt view limits once at startup, later changes of the data limits will not affect the view limits
        /// </summary>
        OnStartup,
        /// <summary>
        /// View limits will automatically adapt changes of data limits. (Default)
        /// </summary>
        OnDataChanges
    }
    /// <summary>
    /// modes for projecting the rendering output to the available client area
    /// </summary>
    public enum AspectRatioMode {
        /// <summary>
        /// plots fill available rendering area of the PlotCubeScreenRectF rectangle
        /// </summary>
        StretchToFill, 
        /// <summary>
        /// plots will be shrinked to fit inside PlotCubeScreeRectF but maintain data aspect ratio
        /// </summary>
        MaintainRatios
    }
    /// <summary>
    /// defines the movement from current to new zoom setting
    /// </summary>
    public enum ZoomModes {
        /// <summary>
        /// No ramp, jump to new zoom setting
        /// </summary>
        Jump,
        /// <summary>
        /// morph softly to new zoom setting
        /// </summary>
        RollSoft,
        /// <summary>
        /// morph faster to new setting
        /// </summary>
        RollHard,
        /// <summary>
        /// morph to new setting by 'going over the limit'
        /// </summary>
        RollOverride
    }
    /// <summary>
    /// predefined colormaps
    /// </summary>
    public enum Colormaps {
        Autumn,
        Bone,
        //Colorcube,
        Cool,
        Copper,
        Flag,
        Gray,
        Hot,
        Hsv,
        ILNumerics,
        Jet,
        Lines, 
        Pink,
        Prism,
        Spring,
        Summer,
        White,
        Winter
    }
    /// <summary>
    /// Orientation for labels and other purposes
    /// </summary>
    public enum TextOrientation {
        Horizontal,
        Vertical
    }
    /// <summary>
    /// Alignment for 
    /// </summary>
    public enum VerticalAlignment {
        Lower,
        Middle,
        Upper
    }
 
    /// <summary>
    /// Suggest, how label positions for axis ticks are to be choosen
    /// </summary>
    public enum TickLabelRenderingHint {
        /// <summary>
        /// tick labels will optimally fill the whole axis length
        /// </summary>
        Filled, 
        /// <summary>
        /// multiples of 10^n will be prefered for label steps
        /// </summary>
        Multiple1,
        /// <summary>
        /// multiples of 2*10^n will be prefered for label steps
        /// </summary>
        Multiple2,
        /// <summary>
        /// multiples of 5*10^n will be prefered for label steps
        /// </summary>
        Multiple5,
        /// <summary>
        /// Try to find the optimal division for tick label steps [default]
        /// </summary>
        /// <remarks>This method is the most computational intensive one.</remarks>
        Auto
    }
    
    /// <summary>
    /// Names for all 3 axes 
    /// </summary>
    public enum AxisNames {
        XAxis = 0,
        YAxis = 1,
        ZAxis = 2
    }

    /// <summary>
    /// simple single unlabled tick
    /// </summary>
    public struct UnlabeledTick {
        /// <summary>
        /// Position of tick
        /// </summary>
        public float Position; 
    }
    /// <summary>
    /// Axis ticks spacing type: linear, logarithmic
    /// </summary>
    public enum AxisType {
        /// <summary>
        /// linear axis tick spacing
        /// </summary>
        Linear,
        /// <summary>
        /// logarithmic axis tick spacing
        /// </summary>
        Logarithmic
    }
    /// <summary>
    /// On which sides ticks will be displayed
    /// </summary>
    public enum TickDisplay {
        /// <summary>
        /// ticks for axis will be displayed on label side only
        /// </summary>
        LabelSide, 
        /// <summary>
        /// ticks for axis will be displayed on label - and the opposite site 
        /// </summary>
        BothSides
    }
    /// <summary>
    /// how ticks are displayed (inside/outside)
    /// </summary>
    public enum TickDirection {
        /// <summary>
        /// Ticks will lay inside the rendering cube
        /// </summary>
        Inside, 
        /// <summary>
        /// Ticks will lay outside the rendering cube
        /// </summary>
        Outside
    }

    /// <summary>
    /// orientation for axis labels (not implemented)
    /// </summary>
    public enum ILAxisLabelOrientation {
        Normal, 
        Rotate90,
        Rotate180,
        Rotate270,
        Arbitrary
    }
    /// <summary>
    /// TickModes - automatic or manual axis tick positioning
    /// </summary>
    public enum TickMode {
        /// <summary>
        /// find tick positions automatically 
        /// </summary>
        Auto,
        /// <summary>
        /// manually create ticks 
        /// </summary>
        Manual
    }
    /// <summary>
    /// options for the sizing of the projection of the plot cube onto the 2D screen client area of the control
    /// </summary>
    public enum PlotBoxScreenSizeMode {
        /// <summary>
        /// the projection of the plot cube drawing area fills the whole controls space (labels may be hidden) 
        /// </summary>
        Maximum, 
        /// <summary>
        /// the size of plot cube projection rectangle is automatically determined, taking labels size into account
        /// </summary>
        Optimal,
        /// <summary>
        /// more pixel exact positioning, strictly only the place really needed for labels is used (slower)
        /// </summary>
        StrictOptimal,
        /// <summary>
        /// No automatic resizing for the cube projection size, values from PlotCubeScreenRect are taken
        /// </summary>
        Manual
    }
    /// <summary>
    /// possible states/reasons/sources for rendering the scene
    /// </summary>
    internal enum RenderReason {
        /// <summary>
        /// normal source, the scene is to be rendered the common way
        /// </summary>
        PaintEvent, 
        /// <summary>
        /// the rendering was re-initialized because the matrices need to be recalculated for laying out labels correctly 
        /// </summary>
        RecalcLabels
    }
    /// <summary>
    /// Alignments for labels 
    /// </summary>
    public enum LabelAlign {
        /// <summary>
        /// align the label near the lower range limit
        /// </summary>
        Lower, 
        /// <summary>
        /// align the label in the center 
        /// </summary>
        Center,
        /// <summary>
        /// align the label near the upper range limit
        /// </summary>
        Upper
    }
    /// <summary>
    /// Possible alignments for tick labels
    /// </summary>
    /// <remarks>member of this enum can get bitwise combined. Default is: Top,Left</remarks>
    [FlagsAttribute]
    public enum TickLabelAlign {
        /// <summary>
        /// align the label to the left side
        /// </summary>
        left = 0,
        /// <summary>
        /// align the labels to the center
        /// </summary>
        center = 1,
        /// <summary>
        /// align the label to the right side
        /// </summary>
        right = 2, 
        /// <summary>
        /// align the label to top
        /// </summary>
        top = 0,
        /// <summary>
        /// align the label to center vertically 
        /// </summary>
        vertCenter = 4,
        /// <summary>
        /// align the label to bottom
        /// </summary>
        bottom = 16
    }

    /// <summary>
    /// projection types
    /// </summary>
    public enum Projection {
        /// <summary>
        /// 3D graphs will be distorted for opotimized 3D impression
        /// </summary>
        Perspective,
        /// <summary>
        /// graphs will not be distorted. objects in the front will get the same size as objects in the back
        /// </summary>
        Orthographic
    }

    /// <summary>
    /// valid marker styles (partially supported)
    /// </summary>
    public enum MarkerStyle {
        /// <summary>
        /// draw markers as dots
        /// </summary>
        Dot,
        /// <summary>
        /// draw markers as circle
        /// </summary>
        Circle, 
        /// <summary>
        /// draw markers as diamonds
        /// </summary>
        Diamond,
        /// <summary>
        /// draw markers as square
        /// </summary>
        Square,
        /// <summary>
        /// draw markers as up pointing triangles
        /// </summary>
        TriangleUp,
        /// <summary>
        /// draw markers as up pointing triangles
        /// </summary>
        TriangleDown,
        /// <summary>
        /// draw markers as up pointing triangles
        /// </summary>
        TriangleLeft,
        /// <summary>
        /// draw markers as up pointing triangles
        /// </summary>
        TriangleRight,
        /// <summary>
        /// draw markers as plus
        /// </summary>
        Plus,
        /// <summary>
        /// draw markers as cross
        /// </summary>
        Cross,
        /// <summary>
        /// do not draw markers
        /// </summary>
        None,
    }
    /// <summary>
    /// Possible positions of the camera
    /// </summary>
    public enum CameraQuadrant {
        TopLeftFront,
        TopLeftBack,
        TopRightBack,
        TopRightFront,
        BottomLeftFront,
        BottomLeftBack,
        BottomRightBack,
        BottomRightFront
    }
    /// <summary>
    /// Shading styles for surface graphs
    /// </summary>
    public enum ShadingStyles {
        /// <summary>
        /// color will be interpolated between all corners 
        /// </summary>
        Interpolate, 
        /// <summary>
        /// same color for whole tile area
        /// </summary>
        /// <remarks>The resulting color will 
        /// reflect the average over all corner values for a rectangle</remarks>
        Flat   
    }

    /// <summary>
    /// line style
    /// </summary>
    public enum LineStyle {
        /// <summary>
        /// solid line
        /// </summary>
        Solid = Int32.MaxValue, 
        /// <summary>
        /// dashed line
        /// </summary>
        Dashed = Int16.MaxValue,
        /// <summary>
        /// point dashed line
        /// </summary>
        PointDash = unchecked((int)4294837760),
        /// <summary>
        /// dotted line
        /// </summary>
        Dotted = unchecked((int)3435973836),
        /// <summary>
        /// use user stipple pattern 
        /// </summary>
        UserPattern = -1,
        /// <summary>
        /// no line at all
        /// </summary>
        None = 0
    }
    /// <summary>
    /// modes of mouse interaction with ILPanel
    /// </summary>
    public enum InteractiveModes {
        ZoomRectangle, 
        Rotating,
        Selecting,
        Translating,
        None
    }
    /// <summary>
    /// single precision 3D point structure
    /// </summary>
    [StructLayout(LayoutKind.Sequential)]
    public struct ILPoint3Df {
        /// <summary>
        /// X coordinate
        /// </summary>
        public float X;
        /// <summary>
        /// Y coordinate
        /// </summary>
        public float Y;
        /// <summary>
        /// Z coordinate
        /// </summary>
        public float Z;
        /// <summary>
        /// create point in single precision
        /// </summary>
        /// <param name="x">X coord</param>
        /// <param name="y">Y coord</param>
        /// <param name="z">Z coord</param>
        public ILPoint3Df (float x, float y, float z) {
            X = x; 
            Y = y; 
            Z = z; 
        }
        /// <summary>
        /// create new ILPoint3Df by double values (for convenience, internally casted to float)
        /// </summary>
        /// <param name="x">X coord</param>
        /// <param name="y">Y coord</param>
        /// <param name="z">Z coors</param>
        public ILPoint3Df (double x, double y, double z) {
            X = (float)x; 
            Y = (float)y; 
            Z = (float)z; 
        }
        /// <summary>
        /// convert this point to string representation
        /// </summary>
        /// <returns></returns>
        public override string ToString() {
            return "X:" + X.ToString() + " Y:" + Y.ToString() + " Z:" + Z.ToString(); 
        }
        /// <summary>
        /// Access to coords by index
        /// </summary>
        /// <param name="index">index number: 0=x, 1=y, 2=z</param>
        /// <returns>float value of coord specified</returns>
        public float this[int index] {
            get {
                switch (index) {
                    case 0:
                        return X;
                    case 1: 
                        return Y;
                    default: 
                        return Z;
                }
            }
        }
        public static bool operator == (ILPoint3Df p1, ILPoint3Df p2) {
            return (p1.X == p2.X && 
                    p1.Y == p2.Y && 
                    p1.Z == p2.Z); 
        }
        public static bool operator != (ILPoint3Df p1, ILPoint3Df p2) {
            return (p1.X != p2.X || 
                    p1.Y != p2.Y ||
                    p1.Z != p2.Z);  
        }
        public static ILPoint3Df operator + (ILPoint3Df p1, ILPoint3Df p2) {
            ILPoint3Df ret = new ILPoint3Df(); 
            ret.X = p1.X + p2.X; 
            ret.Y = p1.Y + p2.Y; 
            ret.Z = p1.Z + p2.Z; 
            return ret; 
        }
        public static ILPoint3Df operator - (ILPoint3Df p1, ILPoint3Df p2) {
            ILPoint3Df ret = new ILPoint3Df(); 
            ret.X = p1.X - p2.X; 
            ret.Y = p1.Y - p2.Y; 
            ret.Z = p1.Z - p2.Z; 
            return ret; 
        }
        public static ILPoint3Df operator * (ILPoint3Df p1, float factor) {
            ILPoint3Df ret = new ILPoint3Df(); 
            ret.X = p1.X * factor; 
            ret.Y = p1.Y * factor; 
            ret.Z = p1.Z * factor; 
            return ret; 
        }
        public static ILPoint3Df operator *(OpenTK.Math.Matrix4 mat, ILPoint3Df vec) {
            return new ILPoint3Df(
                mat.Row0.X * vec.X + mat.Row0.Y * vec.Y + mat.Row0.Z * vec.Z + mat.Row0.W,
                mat.Row1.X * vec.X + mat.Row1.Y * vec.Y + mat.Row1.Z * vec.Z + mat.Row1.W,
                mat.Row2.X * vec.X + mat.Row2.Y * vec.Y + mat.Row2.Z * vec.Z + mat.Row2.W); 
        }
        public static ILPoint3Df operator / (ILPoint3Df p1, float factor) {
            ILPoint3Df ret = new ILPoint3Df(); 
            ret.X = p1.X / factor; 
            ret.Y = p1.Y / factor; 
            ret.Z = p1.Z / factor; 
            return ret; 
        }
        public static readonly ILPoint3Df Empty = new ILPoint3Df(float.NaN,float.NaN,float.NaN); 
        public bool IsEmtpy () {
            return float.IsNaN(X) || float.IsNaN(Y) || float.IsNaN(Z); 
        }

        /// <summary>
        /// cross product
        /// </summary>
        /// <param name="a">vector 1</param>
        /// <param name="b">vector 2</param>
        /// <returns>normalized cross product between a x b</returns>
        public static ILPoint3Df cross(ILPoint3Df a, ILPoint3Df b) {
            return new ILPoint3Df(
                a.Y * b.Z - a.Z * b.Y,
                a.Z * b.X - a.X * b.Z,
                a.X * b.Y - a.Y * b.X);     
        }
        /// <summary>
        /// normalized cross product
        /// </summary>
        /// <param name="a">vector 1</param>
        /// <param name="b">vector 2</param>
        /// <returns>normalized cross product: a x b</returns>
        public static ILPoint3Df crossN(ILPoint3Df a, ILPoint3Df b) {
            ILPoint3Df ret = new ILPoint3Df(
                a.Y * b.Z - a.Z * b.Y,
                a.Z * b.X - a.X * b.Z,
                a.X * b.Y - a.Y * b.X); 
            float len = (float)Math.Sqrt(ret.X * ret.X + ret.Z * ret.Z + ret.Y * ret.Y); 
            if (len != 0)
                return (ret / len); 
            return ret; 
        }
        public float GetLength() {
            return (float)Math.Sqrt(X * X + Y * Y + Z * Z); 
        }
        public static ILPoint3Df MaxValue {
            get { return new ILPoint3Df(float.MaxValue,float.MaxValue,float.MaxValue); }
        }
        public static ILPoint3Df MinValue {
            get { return new ILPoint3Df(float.MinValue,float.MinValue,float.MinValue); }
        }
        public static ILPoint3Df Min(ILPoint3Df val1, ILPoint3Df val2) {
            ILPoint3Df ret = val1; 
            if (val2.X < val1.X) ret.X = val2.X; 
            if (val2.Y < val1.Y) ret.Y = val2.Y; 
            if (val2.Z < val1.Z) ret.Z = val2.Z; 
            return ret; 
        }
        public static ILPoint3Df Min(ILPoint3Df val1, ILPoint3Df val2, ref bool changed) {
            ILPoint3Df ret = val1; 
            if (val2.X < val1.X) { 
                ret.X = val2.X; 
                changed = true; 
            }
            if (val2.Y < val1.Y) { 
                ret.Y = val2.Y; 
                changed = true; 
            } 
            if (val2.Z < val1.Z) { 
                ret.Z = val2.Z; 
                changed = true; 
            }
            return ret; 
        }
        public static ILPoint3Df Max(ILPoint3Df val1, ILPoint3Df val2) {
            ILPoint3Df ret = val1; 
            if (val2.X > val1.X) ret.X = val2.X; 
            if (val2.Y > val1.Y) ret.Y = val2.Y; 
            if (val2.Z > val1.Z) ret.Z = val2.Z; 
            return ret; 
        }
        public static ILPoint3Df Max(ILPoint3Df val1, ILPoint3Df val2, ref bool changed) {
            ILPoint3Df ret = val1;  
            if (val2.X > val1.X) { 
                ret.X = val2.X; 
                changed = true; 
            }
            if (val2.Y > val1.Y) {
                ret.Y = val2.Y; 
                changed = true; 
            }
            if (val2.Z > val1.Z) {
                ret.Z = val2.Z; 
                changed = true; 
            }
            return ret; 
        }


        public static ILPoint3Df normalize(ILPoint3Df p) {
            float length = (float)Math.Sqrt(p.X * p.X + p.Y * p.Y + p.Z * p.Z);
            return p / length;                 
        }

        public static ILPoint3Df normalize(float x, float y, float z) {
            float length = (float)Math.Sqrt(x * x + y * y + z * z);
            return new ILPoint3Df(x,y,z) / length;                 
        }

        public void ToPolar(out float len, out float phi, out float rho) {
            len = (float)Math.Sqrt(X * X + Y * Y + Z * Z);
            phi = (float)Math.Atan2(Y, X);
            rho = (float)Math.Atan2(Math.Sqrt(X * X + Y * Y), Z);
        }

        /// <summary>
        /// rotate the vector, keep length
        /// </summary>
        /// <param name="normal">axis as rotation normal</param>
        /// <param name="angleDeg">angle to move (radian)</param>
        /// <returns>rotated version of this vector, does not change original vector</returns>
        public ILPoint3Df Spin(ILPoint3Df normal, float angleDeg) {
            float a = angleDeg * (float)Math.PI / 180f;
            float cosa = (float)Math.Cos(a);
            float sina = (float)Math.Sin(a);
            normal = ILPoint3Df.normalize(normal);
            float omincosa = 1 - cosa;
            ILPoint3Df ret = new ILPoint3Df(
                (cosa + X * X * omincosa) * normal.X
                + (X * Y * omincosa - Z * sina) * normal.Y
                + (X * Z * omincosa + Y * sina) * normal.Z,

                (Y * X * omincosa + Z * sina) * normal.X
                + (cosa + Y * Y * omincosa) * normal.Y
                + (Y * Z * omincosa - X * sina) * normal.Z,

                (Z * X * omincosa - Y * sina) * normal.X
                + (Z * Y * omincosa + X * sina) * normal.Y
                + (cosa + Z * Z * omincosa) * normal.Z);
            return ret; 
        }
        /// <summary>
        /// Compares obj's coordinate values to those of this class instance
        /// </summary>
        /// <param name="obj">ILPoint3Df to compare</param>
        /// <returns>true, if X,Y and Z coordinates are equal</returns>
        public override bool Equals(object obj) {
            return ((ILPoint3Df)obj) == this;
        }
        /// <summary>
        /// get a hash code for this ILPoint3Df object
        /// </summary>
        /// <returns>hash code</returns>
        public override int GetHashCode() {
            return base.GetHashCode();
        }
    }
    /// <summary>
    /// double precision 3D point definition
    /// </summary>
    [StructLayout(LayoutKind.Sequential)]
    public struct ILPoint3Dd {
        /// <summary>
        /// X coord
        /// </summary>
        public double X;
        /// <summary>
        /// Y coord
        /// </summary>
        public double Y;
        /// <summary>
        /// Z coord
        /// </summary>
        public double Z;
    }
    /// <summary>
    /// supported graphics devices
    /// </summary>
    public enum GraphicDeviceType {
        /// <summary>
        /// DirectX based 
        /// </summary>
        Direct3D,
        /// <summary>
        /// OpenGL based (not supported yet)
        /// </summary>
        OpenGL,
        /// <summary>
        /// Windows native graphics device (not implemented)
        /// </summary>
        GDI,
        /// <summary>
        /// unknown graphics device (not used, errror)
        /// </summary>
        Unknown
    }
    /// <summary>
    /// valid types for plotting graphs
    /// </summary>
    public enum GraphType {
        Axis,
        Plot2D,
        Plot3D,
        Surf,
        Mesh,
        Waterfall,
        Ribbon,
        Image,
        Imagesc,
        PColor,
        Contour,
        CountourFilled,
        ContourSlice,
        Scatter,
        Scatter3,
        SceneGraph,
        Errorbar,
        Stem,
        Stairs,
        Stem3,
        Bar,
        BarHorizontal,
        Auto
    }
    /// <summary>
    /// Coordinate systems for TextRenderer
    /// </summary>
    public enum CoordSystem {
        /// <summary>
        /// the location is expected to be specified into screen coords
        /// </summary>
        Screen, 
        /// <summary>
        /// the location is expected to be specified into world (3D) coords
        /// </summary>
        World3D
    }
    /// <summary>
    /// possible types of renderable items 
    /// </summary>
    public enum RenderItemType {
        /// <summary>
        /// the item defines a character 
        /// </summary>
        Character,
        /// <summary>
        /// the item defines a bitmap
        /// </summary>
        Bitmap
    }
    /// <summary>
    /// possible reason for an ILGraphCollectionChangedEvent to occur
    /// </summary>
    public enum GraphCollectionChangeReason {
        Added,
        Deleted,
        Changed
    }
    public class ILLayoutData {
        public ILLayoutData(ILCamera camera) {
            CameraPosition = camera; 
        }
        public ILCamera CameraPosition; 
        public ILLayoutData() {
        }
    }
}

namespace ILNumerics.Drawing.Labeling {
    /// <summary>
    /// simple single labeled tick
    /// </summary>
    public struct LabeledTick {
        /// <summary>
        /// tick label
        /// </summary>
        public readonly ILRenderQueue Queue; 
        /// <summary>
        /// tick position
        /// </summary>
        public readonly float Position; 
        /// <summary>
        /// create single labeled tick
        /// </summary>
        /// <param name="position">position</param>
        /// <param name="queue">render queue used to render the item</param>
        public LabeledTick(float position, ILRenderQueue queue) { 
            Position = position; 
            Queue    = queue; 
        }
    }
    

}