hydra/include/matrix2x3.h

//
//  Matrix2x3.h
//  Kraken Engine / Hydra
//
//  Copyright 2022 Kearwood Gilbert. All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without modification, are
//  permitted provided that the following conditions are met:
//
//  1. Redistributions of source code must retain the above copyright notice, this list of
//  conditions and the following disclaimer.
//
//  2. Redistributions in binary form must reproduce the above copyright notice, this list
//  of conditions and the following disclaimer in the documentation and/or other materials
//  provided with the distribution.
//
//  THIS SOFTWARE IS PROVIDED BY KEARWOOD GILBERT ''AS IS'' AND ANY EXPRESS OR IMPLIED
//  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
//  FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL KEARWOOD GILBERT OR
//  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
//  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
//  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
//  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
//  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//  The views and conclusions contained in the software and documentation are those of the
//  authors and should not be interpreted as representing official policies, either expressed
//  or implied, of Kearwood Gilbert.
//

#include "vector2.h"
#include "vector3.h"

#ifndef KRAKEN_MATRIX2X3_H
#define KRAKEN_MATRIX2X3_H

namespace kraken {

class Matrix2x3
{
public:

  union
  {
    struct
    {
      Vector2 axis_x, axis_y, transform;
    };
    // Matrix components, in column-major order
    float c[6];
  };

  // Default initializer - Creates an identity matrix
  void init();

  void init(float* pMat);

  void init(const Vector2& new_axis_x, const Vector2& new_axis_y, const Vector2& new_transform);

  void init(const Matrix2x3& m);

  // Overload comparison operator
  bool operator==(const Matrix2x3& m) const;

  // Overload compound multiply operator
  Matrix2x3& operator*=(const Matrix2x3& m);

  float& operator[](unsigned i);
  float operator[](unsigned i) const;

  // Overload multiply operator
  Matrix2x3 operator*(const Matrix2x3& m) const;

  float* getPointer();

  void translate(float x, float y);
  void translate(const Vector2& v);
  void scale(float x, float y);
  void scale(const Vector2& v);
  void scale(float s);
  void rotate(float angle);
  bool invert();

  static Vector2 DotNoTranslate(const Matrix2x3& m, const Vector2& v); // Dot product without including translation; useful for transforming normals and tangents
  static Matrix2x3 Invert(const Matrix2x3& m);
  static Vector2 Dot(const Matrix2x3& m, const Vector2& v);

  static Matrix2x3 Translation(const Vector2& v);
  static Matrix2x3 Rotation(float angle);
  static Matrix2x3 Scaling(const Vector2& v);
  static Matrix2x3 Identity();
};
static_assert(std::is_pod<Matrix2x3>::value, "kraken::Matrix2x3 must be a POD type.");

} // namespace kraken

namespace std {
template<>
struct hash<kraken::Matrix2x3>
{
public:
  size_t operator()(const kraken::Matrix2x3& s) const
  {
    size_t h1 = hash<kraken::Vector2>()(s.axis_x);
    size_t h2 = hash<kraken::Vector2>()(s.axis_y);
    size_t h3 = hash<kraken::Vector2>()(s.transform);
    return h1 ^ (h2 << 1) ^ (h3 << 2);
  }
};
} // namespace std

#endif // KRAKEN_MATRIX2X3_H