1
0
mirror of https://github.com/VCMP-SqMod/SqMod.git synced 2026-07-09 01:57:09 +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
+295 -28
View File
@@ -13,108 +13,375 @@ namespace SqMod {
*/
struct Circle
{
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
typedef SQFloat Value;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
static const Circle NIL;
static const Circle MIN;
static const Circle MAX;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
static SQChar Delim;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Vector2f pos;
Value rad;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle();
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle(Value r);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle(const Vector2f & p);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle(const Vector2f & p, Value r);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle(Value x, Value y, Value r);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle(const Circle & c);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle(Circle && c);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
~Circle();
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator = (const Circle & c);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator = (Circle && c);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator = (Value r);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator = (const Vector2f & p);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator += (const Circle & c);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator -= (const Circle & c);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator *= (const Circle & c);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator /= (const Circle & c);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator %= (const Circle & c);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator += (Value r);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator -= (Value r);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator *= (Value r);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator /= (Value r);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator %= (Value r);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator += (const Vector2f & p);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator -= (const Vector2f & p);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator *= (const Vector2f & p);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator /= (const Vector2f & p);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator %= (const Vector2f & p);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator ++ ();
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle & operator -- ();
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator ++ (int);
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator -- (int);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator + (const Circle & c) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator - (const Circle & c) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator * (const Circle & c) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator / (const Circle & c) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator % (const Circle & c) const;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator + (Value r) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator - (Value r) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator * (Value r) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator / (Value r) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator % (Value r) const;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator + (const Vector2f & p) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator - (const Vector2f & p) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator * (const Vector2f & p) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator / (const Vector2f & p) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator % (const Vector2f & p) const;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator + () const;
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle operator - () const;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator == (const Circle & c) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator != (const Circle & c) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator < (const Circle & c) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator > (const Circle & c) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator <= (const Circle & c) const;
/* --------------------------------------------------------------------------------------------
* ...
*/
bool operator >= (const Circle & c) const;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
SQInteger Cmp(const Circle & c) const;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
const SQChar * ToString() const;
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(Value nr);
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(const Circle & nc);
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(const Vector2f & np);
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(const Vector2f & np, Value nr);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(Value nx, Value ny);
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(Value nx, Value ny, Value nr);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Set(const SQChar * values, SQChar delim);
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Generate();
/* --------------------------------------------------------------------------------------------
* ...
*/
void Generate(Value min, Value max, bool r);
/* --------------------------------------------------------------------------------------------
* ...
*/
void Generate(Value xmin, Value xmax, Value ymin, Value ymax);
/* --------------------------------------------------------------------------------------------
* ...
*/
void Generate(Value xmin, Value xmax, Value ymin, Value ymax, Value rmin, Value rmax);
// --------------------------------------------------------------------------------------------
void Clear() { pos.Clear(); rad = 0.0; }
// --------------------------------------------------------------------------------------------
/* --------------------------------------------------------------------------------------------
* ...
*/
void Clear()
{
pos.Clear(); rad = 0.0;
}
/* --------------------------------------------------------------------------------------------
* ...
*/
Circle Abs() const;
};