1
0
mirror of https://github.com/VCMP-SqMod/SqMod.git synced 2025-07-22 16:57:12 +02:00

Prepared the base types for documentation.

This commit is contained in:
Sandu Liviu Catalin
2015-11-01 10:55:47 +02:00
parent acb0512d43
commit ea1688bc35
12 changed files with 3336 additions and 335 deletions

View File

@@ -13,102 +13,340 @@ namespace SqMod {
*/
struct AABB
{
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
typedef SQFloat Value;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
static const AABB NIL;
static const AABB MIN;
static const AABB MAX;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
static SQChar Delim;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Vector3 min, max;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB();
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB(Value s);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB(Value x, Value y, Value z);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB(Value xmin, Value ymin, Value zmin, Value xmax, Value ymax, Value zmax);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB(const Vector3 & b);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB(const Vector3 & vmin, const Vector3 & vmax);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB(const Vector4 & b);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB(const Vector4 & vmin, const Vector4 & vmax);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB(const SQChar * values, SQChar delim);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB(const AABB & b);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB(AABB && b);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
~AABB();
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator = (const AABB & b);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator = (AABB && b);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator = (Value s);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator = (const Vector3 & v);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator = (const Vector4 & v);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator += (const AABB & b);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator -= (const AABB & b);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator *= (const AABB & b);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator /= (const AABB & b);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator %= (const AABB & b);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator += (Value s);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator -= (Value s);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator *= (Value s);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator /= (Value s);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator %= (Value s);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator ++ ();
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB & operator -- ();
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator ++ (int);
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator -- (int);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator + (const AABB & b) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator - (const AABB & b) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator * (const AABB & b) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator / (const AABB & b) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator % (const AABB & b) const;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator + (Value s) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator - (Value s) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator * (Value s) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator / (Value s) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator % (Value s) const;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator + () const;
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB operator - () const;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator == (const AABB & b) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator != (const AABB & b) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator < (const AABB & b) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator > (const AABB & b) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator <= (const AABB & b) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator >= (const AABB & b) const;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInteger Cmp(const AABB & b) const;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
const SQChar * ToString() const;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(Value ns);
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(Value nx, Value ny, Value nz);
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(Value xmin, Value ymin, Value zmin, Value xmax, Value ymax, Value zmax);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(const AABB & b);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(const Vector3 & v);
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(const Vector3 & nmin, const Vector3 & nmax);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(const Vector4 & v);
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(const Vector4 & nmin, const Vector4 & nmax);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(const SQChar * values, SQChar delim);
// --------------------------------------------------------------------------------------------
void Clear() { min.Clear(); max.Clear(); }
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Clear()
{
min.Clear();
max.Clear();
}
/* --------------------------------------------------------------------------------------------
* ...
*/
AABB Abs() const;
};