#ifndef _BASE_COLOR3_HPP_ #define _BASE_COLOR3_HPP_ // ------------------------------------------------------------------------------------------------ #include "SqBase.hpp" // ------------------------------------------------------------------------------------------------ namespace SqMod { /* ------------------------------------------------------------------------------------------------ * Class used to represent an opaque RGB color. */ struct Color3 { /* -------------------------------------------------------------------------------------------- * The type of value used by components of type. */ typedef unsigned char Value; /* -------------------------------------------------------------------------------------------- * Helper instances for common values mostly used as return types or comparison. */ static const Color3 NIL; static const Color3 MIN; static const Color3 MAX; /* -------------------------------------------------------------------------------------------- * The delimiter character to be used when extracting values from strings. */ static SQChar Delim; /* -------------------------------------------------------------------------------------------- * The red, green and blue components of this type. */ Value r, g, b; /* -------------------------------------------------------------------------------------------- * Default constructor. */ Color3(); /* -------------------------------------------------------------------------------------------- * Construct a color with all components with the same specified color. */ Color3(Value sv); /* -------------------------------------------------------------------------------------------- * Construct with individually specified red, green and blue colors. */ Color3(Value rv, Value gv, Value bv); /* -------------------------------------------------------------------------------------------- * Copy constructor. */ Color3(const Color3 & o) = default; /* -------------------------------------------------------------------------------------------- * Move constructor. */ Color3(Color3 && o) = default; /* -------------------------------------------------------------------------------------------- * Destructor. */ ~Color3() = default; /* -------------------------------------------------------------------------------------------- * Copy assignment operator. */ Color3 & operator = (const Color3 & o) = default; /* -------------------------------------------------------------------------------------------- * Copy assignment operator. */ Color3 & operator = (Color3 && o) = default; /* -------------------------------------------------------------------------------------------- * Scalar value assignment operator. */ Color3 & operator = (Value s); /* -------------------------------------------------------------------------------------------- * Named color assignment operator. */ Color3 & operator = (CSStr name); /* -------------------------------------------------------------------------------------------- * Transparent color assignment operator. */ Color3 & operator = (const Color4 & c); /* -------------------------------------------------------------------------------------------- * Addition assignment operator. */ Color3 & operator += (const Color3 & c); /* -------------------------------------------------------------------------------------------- * Subtraction assignment operator. */ Color3 & operator -= (const Color3 & c); /* -------------------------------------------------------------------------------------------- * Multiplication assignment operator. */ Color3 & operator *= (const Color3 & c); /* -------------------------------------------------------------------------------------------- * Division assignment operator. */ Color3 & operator /= (const Color3 & c); /* -------------------------------------------------------------------------------------------- * Modulo assignment operator. */ Color3 & operator %= (const Color3 & c); /* -------------------------------------------------------------------------------------------- * Bitwise AND assignment operator. */ Color3 & operator &= (const Color3 & c); /* -------------------------------------------------------------------------------------------- * Bitwise OR assignment operator. */ Color3 & operator |= (const Color3 & c); /* -------------------------------------------------------------------------------------------- * Bitwise XOR assignment operator. */ Color3 & operator ^= (const Color3 & c); /* -------------------------------------------------------------------------------------------- * Bitwise left shift assignment operator. */ Color3 & operator <<= (const Color3 & c); /* -------------------------------------------------------------------------------------------- * Bitwise right shift assignment operator. */ Color3 & operator >>= (const Color3 & c); /* -------------------------------------------------------------------------------------------- * Scalar value addition assignment operator. */ Color3 & operator += (Value s); /* -------------------------------------------------------------------------------------------- * Scalar value subtraction assignment operator. */ Color3 & operator -= (Value s); /* -------------------------------------------------------------------------------------------- * Scalar value multiplication assignment operator. */ Color3 & operator *= (Value s); /* -------------------------------------------------------------------------------------------- * Scalar value division assignment operator. */ Color3 & operator /= (Value s); /* -------------------------------------------------------------------------------------------- * Scalar value modulo assignment operator. */ Color3 & operator %= (Value s); /* -------------------------------------------------------------------------------------------- * Scalar value bitwise AND assignment operator. */ Color3 & operator &= (Value s); /* -------------------------------------------------------------------------------------------- * Scalar value bitwise OR assignment operator. */ Color3 & operator |= (Value s); /* -------------------------------------------------------------------------------------------- * Scalar value bitwise XOR assignment operator. */ Color3 & operator ^= (Value s); /* -------------------------------------------------------------------------------------------- * Scalar value bitwise left shift assignment operator. */ Color3 & operator <<= (Value s); /* -------------------------------------------------------------------------------------------- * Scalar value bitwise right shift assignment operator. */ Color3 & operator >>= (Value s); /* -------------------------------------------------------------------------------------------- * Pre-increment operator. */ Color3 & operator ++ (); /* -------------------------------------------------------------------------------------------- * Pre-decrement operator. */ Color3 & operator -- (); /* -------------------------------------------------------------------------------------------- * Post-increment operator. */ Color3 operator ++ (int); /* -------------------------------------------------------------------------------------------- * Post-decrement operator. */ Color3 operator -- (int); /* -------------------------------------------------------------------------------------------- * Addition operator. */ Color3 operator + (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Subtraction operator. */ Color3 operator - (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Multiplication operator. */ Color3 operator * (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Division operator. */ Color3 operator / (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Modulo operator. */ Color3 operator % (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Bitwise AND operator. */ Color3 operator & (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Bitwise OR operator. */ Color3 operator | (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Bitwise XOR operator. */ Color3 operator ^ (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Bitwise shift left operator. */ Color3 operator << (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Bitwise shift right operator. */ Color3 operator >> (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Scalar value addition operator. */ Color3 operator + (Value s) const; /* -------------------------------------------------------------------------------------------- * Scalar value subtraction operator. */ Color3 operator - (Value s) const; /* -------------------------------------------------------------------------------------------- * Scalar value multiplication operator. */ Color3 operator * (Value s) const; /* -------------------------------------------------------------------------------------------- * Scalar value division operator. */ Color3 operator / (Value s) const; /* -------------------------------------------------------------------------------------------- * Scalar value modulo operator. */ Color3 operator % (Value s) const; /* -------------------------------------------------------------------------------------------- * Scalar value bitwise AND operator. */ Color3 operator & (Value s) const; /* -------------------------------------------------------------------------------------------- * Scalar value bitwise OR operator. */ Color3 operator | (Value s) const; /* -------------------------------------------------------------------------------------------- * Scalar value bitwise XOR operator. */ Color3 operator ^ (Value s) const; /* -------------------------------------------------------------------------------------------- * Scalar value bitwise shift left operator. */ Color3 operator << (Value s) const; /* -------------------------------------------------------------------------------------------- * Scalar value bitwise shift right operator. */ Color3 operator >> (Value s) const; /* -------------------------------------------------------------------------------------------- * Unary plus operator. */ Color3 operator + () const; /* -------------------------------------------------------------------------------------------- * Unary minus operator. */ Color3 operator - () const; /* -------------------------------------------------------------------------------------------- * Bitwise NOT operator. */ Color3 operator ~ () const; /* -------------------------------------------------------------------------------------------- * Equality comparison operator. */ bool operator == (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Inequality comparison operator. */ bool operator != (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Less than comparison operator. */ bool operator < (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Greater than comparison operator. */ bool operator > (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Less than or equal comparison operator. */ bool operator <= (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Greater than or equal comparison operator. */ bool operator >= (const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * Implicit conversion to transparent color. */ operator Color4 () const; /* -------------------------------------------------------------------------------------------- * Used by the script engine to compare two instances of this type. */ Int32 Cmp(const Color3 & c) const; /* -------------------------------------------------------------------------------------------- * 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 all components to the specified scalar value. */ void Set(Value ns); /* -------------------------------------------------------------------------------------------- * Set all components to the specified values. */ void Set(Value nr, Value ng, Value nb); /* -------------------------------------------------------------------------------------------- * Copy the values from another instance of this type. */ void Set(const Color3 & c); /* -------------------------------------------------------------------------------------------- * Copy the values from an opaque color. */ void Set(const Color4 & c); /* -------------------------------------------------------------------------------------------- * Set the values extracted from the specified string using the specified delimiter. */ void Set(CSStr str, SQChar delim); /* -------------------------------------------------------------------------------------------- * Set the values from the identified color. */ void SetCol(CSStr name); /* -------------------------------------------------------------------------------------------- * Get the component values packed inside an integer value. */ Uint32 GetRGB() const; /* -------------------------------------------------------------------------------------------- * Set the component values wxtracted from an integer value. */ void SetRGB(Uint32 p); /* -------------------------------------------------------------------------------------------- * Get the component values packed inside an integer value. */ Uint32 GetRGBA() const; /* -------------------------------------------------------------------------------------------- * Set the component values wxtracted from an integer value. */ void SetRGBA(Uint32 p); /* -------------------------------------------------------------------------------------------- * Get the component values packed inside an integer value. */ Uint32 GetARGB() const; /* -------------------------------------------------------------------------------------------- * Set the component values wxtracted from an integer value. */ void SetARGB(Uint32 p); /* -------------------------------------------------------------------------------------------- * Generate random values for all components of this instance. */ void Generate(); /* -------------------------------------------------------------------------------------------- * Generate random values for all components of this instance within the specified bounds. */ void Generate(Value min, Value max); /* -------------------------------------------------------------------------------------------- * Generate random values for all components of this instance within the specified bounds. */ void Generate(Value rmin, Value rmax, Value gmin, Value gmax, Value bmin, Value bmax); /* -------------------------------------------------------------------------------------------- * Clear the component values to default. */ void Clear() { r = 0, g = 0, b = 0; } /* -------------------------------------------------------------------------------------------- * Set the component values to a randomly chosen color. */ void Random(); /* -------------------------------------------------------------------------------------------- * Inverse the color. */ void Inverse(); /* -------------------------------------------------------------------------------------------- * Extract the values for components of the Color3 type from a string. */ static const Color3 & Get(CSStr str); /* -------------------------------------------------------------------------------------------- * Extract the values for components of the Color3 type from a string. */ static const Color3 & Get(CSStr str, SQChar delim); }; } // Namespace:: SqMod #endif // _BASE_COLOR3_HPP_