assets/samples/Samples/ObjectViewer/CS/Vector.cs

//
// (C) Copyright 2003-2019 by Autodesk, Inc.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// AUTODESK PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// AUTODESK SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE. AUTODESK, INC.
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
//
// Use, duplication, or disclosure by the U.S. Government is subject to
// restrictions set forth in FAR 52.227-19 (Commercial Computer
// Software - Restricted Rights) and DFAR 252.227-7013(c)(1)(ii)
// (Rights in Technical Data and Computer Software), as applicable.
//

using System;
using System.Collections.Generic;
using System.Text;

namespace Revit.SDK.Samples.ObjectViewer.CS
{
    /// <summary>
    /// Point class use to store point coordinate value
    /// and get the value via (x, y ,z)property
    /// </summary>
    public struct Vector
    {
        //private member
        private double m_x; //x coordinate of vector
        private double m_y; //y coordinate of vector
        private double m_z; //z coordinate of vector

        /// <summary>
        /// Property to get X coordinate
        /// </summary>
        public double X
        {
            get
            {
                return m_x;
            }
            set
            {
                m_x = value;
            }
        }

        /// <summary>
        /// Property to get Y coordinate
        /// </summary>
        public double Y
        {
            get
            {
                return m_y;
            }
            set
            {
                m_y = value;
            }
        }

        /// <summary>
        /// Property to get Z coordinate
        /// </summary>
        public double Z
        {
            get
            {
                return m_z;
            }
            set
            {
                m_z = value;
            }
        }

        /// <summary>
        /// Property to get x, y, z coordinate bu index 1, 2, 3
        /// </summary>
        public double this[int index]
        {
            get
            {
                switch (index)
                {
                    case 0:
                        return m_x;
                    case 1:
                        return m_y;
                    case 2:
                        return m_z;
                    default:
                        throw new ArgumentOutOfRangeException();
                }
            }
            set
            {
                switch (index)
                {
                    case 0:
                        m_x = value;
                        break;
                    case 1:
                        m_y = value;
                        break;
                    case 2:
                        m_z = value;
                        break;
                    default:
                        throw new ArgumentOutOfRangeException();
                }
            }
        }

        /// <summary>
        /// copy constructor
        /// </summary>
        public Vector(Vector rhs)
        {
            m_x = rhs.X;
            m_y = rhs.Y;
            m_z = rhs.Z;
        }

        /// <summary>
        /// constructor
        /// </summary>
        /// <param name="x">x coordinate of point</param>
        /// <param name="y">y coordinate of point</param>
        /// <param name="z">z coordinate of point</param>
        public Vector(double x, double y, double z)
        {
            m_x = x;
            m_y = y;
            m_z = z;
        }

        /// <summary>
        /// get Normal by vector
        /// </summary>
        public Vector GetNormal()
        {
            Vector direct = new Vector();
            double len = GetLength();
            if (len < double.Epsilon)
            {
                return new Vector();
            }
            direct.X = m_x / len;
            direct.Y = m_y / len;
            direct.Z = m_z / len;
            return direct;
        }

        /// <summary>
        /// add two vector
        /// </summary>
        /// <param name="lhs">first vector</param>
        /// <param name="rhs">second vector</param>
        /// <returns>add two vector</returns>
        public static Vector operator +(Vector lhs, Vector rhs)
        {
            Vector result = new Vector(lhs);
            result.X += rhs.X;
            result.Y += rhs.Y;
            result.Z += rhs.Z;
            return result;
        }

        /// <summary>
        /// subtraction of two vector
        /// </summary>
        /// <param name="lhs">first vector</param>
        /// <param name="rhs">second vector</param>
        /// <returns>subtraction of two vector</returns>
        public static Vector operator -(Vector lhs, Vector rhs)
        {
            Vector result = new Vector(lhs);
            result.X -= rhs.X;
            result.Y -= rhs.Y;
            result.Z -= rhs.Z;
            return result;
        }

        /// <summary>
        /// negative of vector
        /// </summary>
        /// <param name="lhs">vector</param>
        /// <returns>negative of vector</returns>
        public static Vector operator -(Vector lhs)
        {
            Vector result = new Vector(lhs);
            result.X = -lhs.X;
            result.Y = -lhs.Y;
            result.Z = -lhs.Z;
            return result;
        }

        /// <summary>
        /// get normal vector of two vector
        /// </summary>
        /// <param name="lhs">first vector</param>
        /// <param name="rhs">second vector</param>
        /// <returns> normal vector of two vector</returns>
        public static Vector operator &(Vector lhs, Vector rhs)
        {
            double v1 = lhs.X;
            double v2 = lhs.Y;
            double v3 = lhs.Z;

            double u1 = rhs.X;
            double u2 = rhs.Y;
            double u3 = rhs.Z;

            double x = v2 * u3 - v3 * u2;
            double y = v3 * u1 - v1 * u3;
            double z = v1 * u2 - v2 * u1;

            return new Vector(x, y, z);
        }

        /// <summary>
        /// get cross vector of two vector
        /// </summary>
        /// <param name="lhs">first vector</param>
        /// <param name="rhs">second vector</param>
        /// <returns> cross vector of two vector</returns>
        public static double operator *(Vector lhs, Vector rhs)
        {
            return lhs.X * rhs.X + lhs.Y * rhs.Y + lhs.Z * rhs.Z;
        }

        /// <summary>
        /// get vector multiply by an double value
        /// </summary>
        /// <param name="lhs">vector</param>
        /// <param name="rhs">double value</param>
        /// <returns> vector multiply by an double value</returns>
        public static Vector operator *(Vector lhs, double rhs)
        {
            return new Vector(lhs.X * rhs, lhs.Y * rhs, lhs.Z * rhs);
        }

        /// <summary>
        /// estimate whether two are unequal
        /// </summary>
        /// <param name="lhs">first vector</param>
        /// <param name="rhs">second vector</param>
        /// <returns> whether two are unequal</returns>
        public static bool operator !=(Vector lhs, Vector rhs)
        {
            return !IsEqual(lhs, rhs);
        }

        /// <summary>
        /// estimate whether two are equal
        /// </summary>
        /// <param name="lhs">first vector</param>
        /// <param name="rhs">second vector</param>
        /// <returns> whether two are equal</returns>
        public static bool operator ==(Vector lhs, Vector rhs)
        {
            return IsEqual(lhs, rhs);
        }

        /// <summary>
        /// get the length of vector
        /// </summary>
        /// <param name="lhs">vector</param>
        /// <returns>length of vector</returns>
        public static double operator ~(Vector lhs)
        {
            return lhs.GetLength();
        }

        /// <summary>
        /// get vector divided by an double value
        /// </summary>
        /// <param name="lhs">vector</param>
        /// <param name="rhs">double value</param>
        /// <returns> vector divided by an double value</returns>
        public static Vector operator /(Vector lhs, double rhs)
        {
            return new Vector(lhs.m_x / rhs, lhs.m_y / rhs, lhs.m_z / rhs);
        }

        /// <summary>
        /// get angle of two vector
        /// </summary>
        /// <param name="lhs">first vector</param>
        /// <param name="rhs">second vector</param>
        /// <param name="acuteAngleDesired">
        /// indicate whether get the acute angle of two angles between two vectors
        /// </param>
        /// <returns> angle of two vector</returns>
        public static double GetAngleOf2Vectors(Vector lhs, Vector rhs, bool acuteAngleDesired)
        {
            double angle = Math.Acos(lhs.GetNormal() * rhs.GetNormal());
            if (acuteAngleDesired && angle > Math.PI / 2)
            {
                angle = Math.PI - angle;
            }
            return angle;
        }

        /// <summary>
        /// estimate whether two are equal
        /// </summary>
        /// <param name="obj">object which compare with</param>
        /// <returns> whether two are equal</returns>
        public override bool Equals(object obj)
        {
            try
            {
                Vector rhs = (Vector)obj;
                return IsEqual(this, rhs);
            }
            catch
            {
            }
            return false;
        }

        /// <summary>
        /// Get HashCode
        /// </summary>
        public override int GetHashCode()
        {
            return m_x.GetHashCode() ^ m_y.GetHashCode() ^ m_z.GetHashCode();
        }

        /// <summary>
        /// Get Length of vector
        /// </summary>
        public double GetLength()
        {
            return Math.Sqrt(m_x*m_x + m_y*m_y + m_z*m_z);
        }

        /// <summary>
        /// estimate whether two vector are equal
        /// </summary>
        /// <param name="lhs">first vector</param>
        /// <param name="rhs">second vector</param>
        /// <returns> whether two are equal</returns>
        private static bool IsEqual(Vector lhs, Vector rhs)
        {
            if (lhs.X == rhs.X && lhs.X == rhs.X && lhs.X == rhs.X)
            {
                return true;
            }
            else
            {
                return false;
            }
        }

        /// <summary>
        /// Cross multiply 2 3*3 Matrix
        /// </summary>
        /// <param name="m1"></param>
        /// <param name="m2"></param>
        /// <returns>result 3*3 Matrix</returns>
        public static Vector[] MultiCross3X3Matrix(Vector[] m1, Vector[] m2)
        {
            Vector[] result = new Vector[3];

            for (int i = 0; i < 3; i++)
            {
                for (int j = 0; j < 3; j++)
                {
                    for (int k = 0; k < 3; k++)
                    {
                        switch (j)
                        {
                            case 0:
                                (result[i]).X += (m1[i])[k] * (m2[k])[j];
                                break;
                            case 1:
                                (result[i]).Y += (m1[i])[k] * (m2[k])[j];
                                break;
                            case 2:
                                (result[i]).Z += (m1[i])[k] * (m2[k])[j];
                                break;
                            default:
                                break;
                        }
                    }
                }
            }

            return result;
        }
    }
}