#pragma once // ------------------------------------------------------------------------------------------------ #include "Base/Shared.hpp" // ------------------------------------------------------------------------------------------------ namespace SqMod { /* ------------------------------------------------------------------------------------------------ * Class used to represent a four-dimensional vector. */ struct Vector4 { /* -------------------------------------------------------------------------------------------- * The type of value used by components of type. */ typedef float Value; /* -------------------------------------------------------------------------------------------- * Helper instances for common values mostly used as return types or comparison. */ static const Vector4 NIL; static const Vector4 MIN; static const Vector4 MAX; /* -------------------------------------------------------------------------------------------- * The delimiter character to be used when extracting values from strings. */ static SQChar Delim; /* -------------------------------------------------------------------------------------------- * The x, y, z and w components of this type. */ Value x{0}, y{0}, z{0}, w{0}; /* -------------------------------------------------------------------------------------------- * Default constructor. */ Vector4() noexcept = default; /* -------------------------------------------------------------------------------------------- * Construct a vector with the same scalar value for all components. */ explicit Vector4(Value sv) noexcept; /* -------------------------------------------------------------------------------------------- * Construct a vector with the specified component values. */ Vector4(Value xv, Value yv, Value zv) noexcept; /* -------------------------------------------------------------------------------------------- * Construct a vector with the specified component values. */ Vector4(Value xv, Value yv, Value zv, Value wv) noexcept; /* -------------------------------------------------------------------------------------------- * Copy constructor. */ Vector4(const Vector4 & o) noexcept = default; /* -------------------------------------------------------------------------------------------- * Move constructor. */ Vector4(Vector4 && o) noexcept = default; /* -------------------------------------------------------------------------------------------- * Destructor. */ ~Vector4() = default; /* -------------------------------------------------------------------------------------------- * Copy assignment operator. */ Vector4 & operator = (const Vector4 & o) = default; /* -------------------------------------------------------------------------------------------- * Move assignment operator. */ Vector4 & operator = (Vector4 && o) = default; /* -------------------------------------------------------------------------------------------- * Scalar value assignment operator. */ Vector4 & operator = (Value s); /* -------------------------------------------------------------------------------------------- * Three-dimensional vector assignment operator. */ Vector4 & operator = (const Vector3 & v); /* -------------------------------------------------------------------------------------------- * Quaternion rotation assignment operator. */ Vector4 & operator = (const Quaternion & q); /* -------------------------------------------------------------------------------------------- * Addition assignment operator. */ Vector4 & operator += (const Vector4 & v); /* -------------------------------------------------------------------------------------------- * Subtraction assignment operator. */ Vector4 & operator -= (const Vector4 & v); /* -------------------------------------------------------------------------------------------- * Multiplication assignment operator. */ Vector4 & operator *= (const Vector4 & v); /* -------------------------------------------------------------------------------------------- * Division assignment operator. */ Vector4 & operator /= (const Vector4 & v); /* -------------------------------------------------------------------------------------------- * Modulo assignment operator. */ Vector4 & operator %= (const Vector4 & v); /* -------------------------------------------------------------------------------------------- * Scalar value addition assignment operator. */ Vector4 & operator += (Value s); /* -------------------------------------------------------------------------------------------- * Scalar value subtraction assignment operator. */ Vector4 & operator -= (Value s); /* -------------------------------------------------------------------------------------------- * Scalar value multiplication assignment operator. */ Vector4 & operator *= (Value s); /* -------------------------------------------------------------------------------------------- * Scalar value division assignment operator. */ Vector4 & operator /= (Value s); /* -------------------------------------------------------------------------------------------- * Scalar value modulo assignment operator. */ Vector4 & operator %= (Value s); /* -------------------------------------------------------------------------------------------- * Pre-increment operator. */ Vector4 & operator ++ (); /* -------------------------------------------------------------------------------------------- * Pre-decrement operator. */ Vector4 & operator -- (); /* -------------------------------------------------------------------------------------------- * Post-increment operator. */ Vector4 operator ++ (int); // NOLINT(cert-dcl21-cpp) /* -------------------------------------------------------------------------------------------- * Post-decrement operator. */ Vector4 operator -- (int); // NOLINT(cert-dcl21-cpp) /* -------------------------------------------------------------------------------------------- * Addition operator. */ Vector4 operator + (const Vector4 & v) const; /* -------------------------------------------------------------------------------------------- * Subtraction operator. */ Vector4 operator - (const Vector4 & v) const; /* -------------------------------------------------------------------------------------------- * Multiplication operator. */ Vector4 operator * (const Vector4 & v) const; /* -------------------------------------------------------------------------------------------- * Division operator. */ Vector4 operator / (const Vector4 & v) const; /* -------------------------------------------------------------------------------------------- * Modulo operator. */ Vector4 operator % (const Vector4 & v) const; /* -------------------------------------------------------------------------------------------- * Scalar value addition operator. */ Vector4 operator + (Value s) const; /* -------------------------------------------------------------------------------------------- * Scalar value subtraction operator. */ Vector4 operator - (Value s) const; /* -------------------------------------------------------------------------------------------- * Scalar value multiplication operator. */ Vector4 operator * (Value s) const; /* -------------------------------------------------------------------------------------------- * Scalar value division operator. */ Vector4 operator / (Value s) const; /* -------------------------------------------------------------------------------------------- * Scalar value modulo operator. */ Vector4 operator % (Value s) const; /* -------------------------------------------------------------------------------------------- * Unary plus operator. */ Vector4 operator + () const; /* -------------------------------------------------------------------------------------------- * Unary minus operator. */ Vector4 operator - () const; /* -------------------------------------------------------------------------------------------- * Equality comparison operator. */ bool operator == (const Vector4 & v) const; /* -------------------------------------------------------------------------------------------- * Inequality comparison operator. */ bool operator != (const Vector4 & v) const; /* -------------------------------------------------------------------------------------------- * Less than comparison operator. */ bool operator < (const Vector4 & v) const; /* -------------------------------------------------------------------------------------------- * Greater than comparison operator. */ bool operator > (const Vector4 & v) const; /* -------------------------------------------------------------------------------------------- * Less than or equal comparison operator. */ bool operator <= (const Vector4 & v) const; /* -------------------------------------------------------------------------------------------- * Greater than or equal comparison operator. */ bool operator >= (const Vector4 & v) const; /* -------------------------------------------------------------------------------------------- * Used by the script engine to compare two instances of this type. */ SQMOD_NODISCARD int32_t Cmp(const Vector4 & v) const; /* -------------------------------------------------------------------------------------------- * Used by the script engine to compare an instance of this type with a scalar value. */ SQMOD_NODISCARD int32_t Cmp(SQFloat s) const { return Cmp(Vector4(static_cast< Value >(s))); } /* -------------------------------------------------------------------------------------------- * Used by the script engine to compare an instance of this type with a scalar value. */ SQMOD_NODISCARD int32_t Cmp(SQInteger s) const { return Cmp(Vector4(static_cast< Value >(s))); } /* -------------------------------------------------------------------------------------------- * Used by the script engine to compare an instance of this type with a scalar value. */ SQMOD_NODISCARD int32_t Cmp(bool s) const { return Cmp(Vector4(static_cast< Value >(s))); } /* -------------------------------------------------------------------------------------------- * Used by the script engine to compare an instance of this type with a scalar value. */ SQMOD_NODISCARD int32_t Cmp(std::nullptr_t) const { return Cmp(Vector4(static_cast< Value >(0))); } /* -------------------------------------------------------------------------------------------- * Used by the script engine to convert an instance of this type to a string. */ SQMOD_NODISCARD String ToString() const; /* -------------------------------------------------------------------------------------------- * Set all components to the specified scalar value. */ void SetScalar(Value ns); /* -------------------------------------------------------------------------------------------- * Copy the values from another instance of this type. */ void SetVector4(const Vector4 & v); /* -------------------------------------------------------------------------------------------- * Set all components to the specified values. */ void SetVector4Ex(Value nx, Value ny, Value nz, Value nw); /* -------------------------------------------------------------------------------------------- * Copy the values from a three-dimensional vector. */ void SetVector3(const Vector3 & v); /* -------------------------------------------------------------------------------------------- * Set all components to the specified values. */ void SetVector3Ex(Value nx, Value ny, Value nz); /* -------------------------------------------------------------------------------------------- * Copy the values from a quaternion rotation. */ void SetQuaternion(const Quaternion & q); /* -------------------------------------------------------------------------------------------- * Copy the values from a quaternion rotation. */ void SetQuaternionEx(Value nx, Value ny, Value nz, Value nw); /* -------------------------------------------------------------------------------------------- * Set the values extracted from the specified string using the specified delimiter. */ void SetStr(SQChar delim, StackStrF & values); /* -------------------------------------------------------------------------------------------- * Generate random values for all components of this instance. */ Vector4 & Generate(); /* -------------------------------------------------------------------------------------------- * Generate random values for all components of this instance within the specified bounds. */ Vector4 & GenerateB(Value min, Value max); /* -------------------------------------------------------------------------------------------- * Generate random values for all components of this instance within the specified bounds. */ Vector4 & GenerateR(Value xmin, Value xmax, Value ymin, Value ymax, Value zmin, Value zmax, Value wmin, Value wmax); /* -------------------------------------------------------------------------------------------- * Clear the component values to default. */ void Clear() { x = 0.0, y = 0.0, z = 0.0, w = 0.0; } /* -------------------------------------------------------------------------------------------- * Retrieve a new instance of this type with absolute component values. */ SQMOD_NODISCARD Vector4 Abs() const; /* -------------------------------------------------------------------------------------------- * Generate a formatted string with the values from this instance. */ SQMOD_NODISCARD String Format(StackStrF & str) const; /* -------------------------------------------------------------------------------------------- * Extract the values for components of the Vector4 type from a string. */ static const Vector4 & Get(StackStrF & str); /* -------------------------------------------------------------------------------------------- * Extract the values for components of the Vector4 type from a string. */ static const Vector4 & GetEx(SQChar delim, StackStrF & str); }; } // Namespace:: SqMod