#ifndef _BASE_SPHERE_HPP_ #define _BASE_SPHERE_HPP_ // ------------------------------------------------------------------------------------------------ #include "SqBase.hpp" #include "Base/Vector3.hpp" // ------------------------------------------------------------------------------------------------ namespace SqMod { /* ------------------------------------------------------------------------------------------------ * Class used to represent a three-dimensional sphere. */ struct Sphere { /* -------------------------------------------------------------------------------------------- * 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 Sphere NIL; static const Sphere MIN; static const Sphere MAX; /* -------------------------------------------------------------------------------------------- * The delimiter character to be used when extracting values from strings. */ static SQChar Delim; /* -------------------------------------------------------------------------------------------- * The position and radius components of this type. */ Vector3 pos; Value rad; /* -------------------------------------------------------------------------------------------- * Default constructor. */ Sphere(); /* -------------------------------------------------------------------------------------------- * Construct a sphere at position 0,0,0 using the specified radius. */ explicit Sphere(Value rv); /* -------------------------------------------------------------------------------------------- * Construct a sphere at the specified position using the specified radius. */ Sphere(const Vector3 & pv, Value rv); /* -------------------------------------------------------------------------------------------- * Construct a sphere at the specified position using the specified radius. */ Sphere(Value xv, Value yv, Value zv, Value rv); /* -------------------------------------------------------------------------------------------- * Copy constructor. */ Sphere(const Sphere & o) = default; /* -------------------------------------------------------------------------------------------- * Move constructor. */ Sphere(Sphere && o) = default; /* -------------------------------------------------------------------------------------------- * Destructor. */ ~Sphere() = default; /* -------------------------------------------------------------------------------------------- * Copy assignment operator. */ Sphere & operator = (const Sphere & o) = default; /* -------------------------------------------------------------------------------------------- * Move assignment operator. */ Sphere & operator = (Sphere && o) = default; /* -------------------------------------------------------------------------------------------- * Radius assignment operator. */ Sphere & operator = (Value r); /* -------------------------------------------------------------------------------------------- * Position assignment operator. */ Sphere & operator = (const Vector3 & p); /* -------------------------------------------------------------------------------------------- * Addition assignment operator. */ Sphere & operator += (const Sphere & s); /* -------------------------------------------------------------------------------------------- * Subtraction assignment operator. */ Sphere & operator -= (const Sphere & s); /* -------------------------------------------------------------------------------------------- * Multiplication assignment operator. */ Sphere & operator *= (const Sphere & s); /* -------------------------------------------------------------------------------------------- * Division assignment operator. */ Sphere & operator /= (const Sphere & s); /* -------------------------------------------------------------------------------------------- * Modulo assignment operator. */ Sphere & operator %= (const Sphere & s); /* -------------------------------------------------------------------------------------------- * Radius addition assignment operator. */ Sphere & operator += (Value r); /* -------------------------------------------------------------------------------------------- * Radius subtraction assignment operator. */ Sphere & operator -= (Value r); /* -------------------------------------------------------------------------------------------- * Radius multiplication assignment operator. */ Sphere & operator *= (Value r); /* -------------------------------------------------------------------------------------------- * Radius division assignment operator. */ Sphere & operator /= (Value r); /* -------------------------------------------------------------------------------------------- * Radius modulo assignment operator. */ Sphere & operator %= (Value r); /* -------------------------------------------------------------------------------------------- * Position addition assignment operator. */ Sphere & operator += (const Vector3 & p); /* -------------------------------------------------------------------------------------------- * Position subtraction assignment operator. */ Sphere & operator -= (const Vector3 & p); /* -------------------------------------------------------------------------------------------- * Position multiplication assignment operator. */ Sphere & operator *= (const Vector3 & p); /* -------------------------------------------------------------------------------------------- * Position division assignment operator. */ Sphere & operator /= (const Vector3 & p); /* -------------------------------------------------------------------------------------------- * Position modulo assignment operator. */ Sphere & operator %= (const Vector3 & p); /* -------------------------------------------------------------------------------------------- * Pre-increment operator. */ Sphere & operator ++ (); /* -------------------------------------------------------------------------------------------- * Pre-decrement operator. */ Sphere & operator -- (); /* -------------------------------------------------------------------------------------------- * Post-increment operator. */ Sphere operator ++ (int); /* -------------------------------------------------------------------------------------------- * Post-decrement operator. */ Sphere operator -- (int); /* -------------------------------------------------------------------------------------------- * Addition operator. */ Sphere operator + (const Sphere & s) const; /* -------------------------------------------------------------------------------------------- * Subtraction operator. */ Sphere operator - (const Sphere & s) const; /* -------------------------------------------------------------------------------------------- * Multiplication operator. */ Sphere operator * (const Sphere & s) const; /* -------------------------------------------------------------------------------------------- * Division operator. */ Sphere operator / (const Sphere & s) const; /* -------------------------------------------------------------------------------------------- * Modulo operator. */ Sphere operator % (const Sphere & s) const; /* -------------------------------------------------------------------------------------------- * Radius addition operator. */ Sphere operator + (Value r) const; /* -------------------------------------------------------------------------------------------- * Radius subtraction operator. */ Sphere operator - (Value r) const; /* -------------------------------------------------------------------------------------------- * Radius multiplication operator. */ Sphere operator * (Value r) const; /* -------------------------------------------------------------------------------------------- * Radius division operator. */ Sphere operator / (Value r) const; /* -------------------------------------------------------------------------------------------- * Radius modulo operator. */ Sphere operator % (Value r) const; /* -------------------------------------------------------------------------------------------- * Position addition operator. */ Sphere operator + (const Vector3 & p) const; /* -------------------------------------------------------------------------------------------- * Position subtraction operator. */ Sphere operator - (const Vector3 & p) const; /* -------------------------------------------------------------------------------------------- * Position multiplication operator. */ Sphere operator * (const Vector3 & p) const; /* -------------------------------------------------------------------------------------------- * Position division operator. */ Sphere operator / (const Vector3 & p) const; /* -------------------------------------------------------------------------------------------- * Position modulo operator. */ Sphere operator % (const Vector3 & p) const; /* -------------------------------------------------------------------------------------------- * Unary plus operator. */ Sphere operator + () const; /* -------------------------------------------------------------------------------------------- * Unary minus operator. */ Sphere operator - () const; /* -------------------------------------------------------------------------------------------- * Equality comparison operator. */ bool operator == (const Sphere & s) const; /* -------------------------------------------------------------------------------------------- * Inequality comparison operator. */ bool operator != (const Sphere & s) const; /* -------------------------------------------------------------------------------------------- * Less than comparison operator. */ bool operator < (const Sphere & s) const; /* -------------------------------------------------------------------------------------------- * Greater than comparison operator. */ bool operator > (const Sphere & s) const; /* -------------------------------------------------------------------------------------------- * Less than or equal comparison operator. */ bool operator <= (const Sphere & s) const; /* -------------------------------------------------------------------------------------------- * Greater than or equal comparison operator. */ bool operator >= (const Sphere & s) const; /* -------------------------------------------------------------------------------------------- * Used by the script engine to compare two instances of this type. */ Int32 Cmp(const Sphere & s) const; /* -------------------------------------------------------------------------------------------- * Used by the script engine to compare an instance of this type with a scalar value. */ Int32 Cmp(SQFloat s) const { return Cmp(Sphere(static_cast< Value >(s))); } /* -------------------------------------------------------------------------------------------- * Used by the script engine to compare an instance of this type with a scalar value. */ Int32 Cmp(SQInteger s) const { return Cmp(Sphere(static_cast< Value >(s))); } /* -------------------------------------------------------------------------------------------- * Used by the script engine to compare an instance of this type with a scalar value. */ Int32 Cmp(bool s) const { return Cmp(Sphere(static_cast< Value >(s))); } /* -------------------------------------------------------------------------------------------- * Used by the script engine to compare an instance of this type with a scalar value. */ Int32 Cmp(std::nullptr_t) const { return Cmp(Sphere(static_cast< Value >(0))); } /* -------------------------------------------------------------------------------------------- * Used by the script engine to convert an instance of this type to a string. */ CSStr ToString() const; /* -------------------------------------------------------------------------------------------- * Used by the script engine to retrieve the name from instances of this type. */ static SQInteger Typename(HSQUIRRELVM vm); /* -------------------------------------------------------------------------------------------- * Set the specified radius. */ void SetRadius(Value nr); /* -------------------------------------------------------------------------------------------- * Copy the sphere from another instance of this type. */ void SetSphere(const Sphere & ns); /* -------------------------------------------------------------------------------------------- * Set the specified position and radius. */ void SetSphereEx(Value nx, Value ny, Value nz, Value nr); /* -------------------------------------------------------------------------------------------- * Set the specified position and radius. */ void SetValues(const Vector3 & np, Value nr); /* -------------------------------------------------------------------------------------------- * Set the position from the specified position. */ void SetPosition(const Vector3 & np); /* -------------------------------------------------------------------------------------------- * Set the specified position. */ void SetPositionEx(Value nx, Value ny, Value nz); /* -------------------------------------------------------------------------------------------- * Set the values extracted from the specified string using the specified delimiter. */ void SetStr(CSStr values, SQChar delim); /* -------------------------------------------------------------------------------------------- * Generate a randomly sized and positioned sphere. */ void Generate(); /* -------------------------------------------------------------------------------------------- * Generate a randomly sized or positioned sphere within the specified bounds. */ void Generate(Value min, Value max, bool r); /* -------------------------------------------------------------------------------------------- * Generate a randomly positioned sphere within the specified bounds. */ void Generate(Value xmin, Value xmax, Value ymin, Value ymax, Value zmin, Value zmax); /* -------------------------------------------------------------------------------------------- * Generate a randomly sized and positioned sphere within the specified bounds. */ void Generate(Value xmin, Value xmax, Value ymin, Value ymax, Value zmin, Value zmax, Value rmin, Value rmax); /* -------------------------------------------------------------------------------------------- * Clear the component values to default. */ void Clear() { pos.Clear(); rad = 0.0; } /* -------------------------------------------------------------------------------------------- * Retrieve a new instance of this type with absolute component values. */ Sphere Abs() const; /* -------------------------------------------------------------------------------------------- * Extract the values for components of the Sphere type from a string. */ static const Sphere & Get(CSStr str); /* -------------------------------------------------------------------------------------------- * Extract the values for components of the Sphere type from a string. */ static const Sphere & Get(CSStr str, SQChar delim); }; } // Namespace:: SqMod #endif // _BASE_SPHERE_HPP_