#include <PColor.h>

Inheritance diagram for PColor:

Public Member Functions
	PColor ()
	Standard constructor of PColor.

	PColor (unsigned int color)
	Constructor.

	PColor (int red, int green, int blue, int alpha)
	Constructor.

	PColor (const std::string &colorname)
	Constructor.

	PColor (const PColor &pcolor)
	Constructor using RGBColorNames.

virtual	~PColor ()
	Copy constructor.

virtual bool	SetProperty (std::string, Variant v)
	Standard Destructor.

virtual ObjectValidationError	ValidateProperty (std::string name, Variant v) const

virtual ObjectValidationError	ValidateProperty (std::string name) const

int	GetRed () const

int	GetGreen () const

int	GetBlue () const

int	GetAlpha () const

void	SetRed (int color)

void	SetGreen (int color)

void	SetBlue (int color)

void	SetAlpha (int color)

void	SetColorByRGBA (unsigned int color)
	Sets color as a 32-bit unsigned int.

void	SetColorByRGBA (int red, int green, int blue, int alpha)
	Sets color as a 4 8-bit unsigned int.

void	SetColorByName (const std::string &colorname)
	Sets color as by its name.

unsigned int	GetColor () const
	Gets 32-bit unsigned int color.

bool	HasChanged () const
	Change detection for nested property modifications.

void	ClearChanged ()

Public Member Functions inherited from PEBLObjectBase
	PEBLObjectBase ()
	Standard Constructor.

	PEBLObjectBase (ComplexDataType cdt)
	Standard Constructor.

	PEBLObjectBase (const PEBLObjectBase &pob)

virtual	~PEBLObjectBase ()
	Standard Destructor.

virtual bool	InitializeProperty (std::string name, Variant v)

Variant	GetProperty (std::string) const

ComplexDataType	GetType ()

virtual std::ostream &	PrintProperties (std::ostream &out)

virtual Variant	GetPropertyList ()

Protected Member Functions
virtual std::string	ObjectName () const

virtual std::ostream &	SendToStream (std::ostream &out) const
	This sends the color descriptions to the specified stream.

Additional Inherited Members
Protected Attributes inherited from PEBLObjectBase
ComplexDataType	mCDT

std::map< std::string, Variant >	mProperties

Detailed Description

This class represents color. Currently, only RGBA color is accessible. Access through other color spaces could be added.

Definition at line 36 of file PColor.h.

Constructor & Destructor Documentation

◆ PColor() [1/5]

PColor::PColor ( )

Standard constructor of PColor.

Definition at line 44 of file PColor.cpp.

              :
    PEBLObjectBase(CDT_COLOR),
    mRed(0),
    mGreen(0),
    mBlue(0),
    mAlpha(255),
    mChanged(false)
 
{
 
    InitializeProperty("NAME", Variant("<COLOR>"));
     InitializeProperty("RED",Variant(GetRed()));
     InitializeProperty("GREEN",Variant(GetGreen()));
     InitializeProperty("BLUE",Variant(GetBlue()));
     InitializeProperty("ALPHA",Variant(GetAlpha()));
 
}

References GetAlpha(), GetBlue(), GetGreen(), GetRed(), and PEBLObjectBase::InitializeProperty().

◆ PColor() [2/5]

PColor::PColor ( unsigned int color )

Constructor.

Definition at line 62 of file PColor.cpp.

                                :
    mRed(0),mGreen(0),mBlue(0),mAlpha(0),mChanged(false)
    {
            SetColorByRGBA(color);
    };   

References SetColorByRGBA().

◆ PColor() [3/5]

PColor::PColor	(	int	red,
		int	green,
		int	blue,
		int	alpha
	)

Constructor.

Convenience constructor of PColor:

Definition at line 70 of file PColor.cpp.

                                                     :
    PEBLObjectBase(CDT_COLOR),
    mRed(To8BitColor(red)),
    mGreen(To8BitColor(green)),
    mBlue(To8BitColor(blue)),
    mAlpha(To8BitColor(alpha)),
    mChanged(false)
 
{
    InitializeProperty("NAME", Variant("<COLOR>"));
     InitializeProperty("RED",Variant(GetRed()));
     InitializeProperty("GREEN",Variant(GetGreen()));
     InitializeProperty("BLUE",Variant(GetBlue()));
     InitializeProperty("ALPHA",Variant(GetAlpha()));
 
}

References GetAlpha(), GetBlue(), GetGreen(), GetRed(), and PEBLObjectBase::InitializeProperty().

◆ PColor() [4/5]

PColor::PColor ( const std::string & colorname )

Constructor.

◆ PColor() [5/5]

PColor::PColor ( const PColor & pcolor )

Constructor using RGBColorNames.

Copy constructor of PColor:

Definition at line 120 of file PColor.cpp.

                                   :
    PEBLObjectBase(CDT_COLOR)
{
 
    mRed   = pcolor.GetRed();
    mGreen = pcolor.GetGreen();
    mBlue  = pcolor.GetBlue();
    mAlpha = pcolor.GetAlpha();
    mChanged = false;
 
     InitializeProperty("NAME", Variant("<COLOR>"));
     InitializeProperty("RED",Variant((int)mRed));
     InitializeProperty("GREEN",Variant((int)mGreen));
     InitializeProperty("BLUE",Variant((int)mBlue));
     InitializeProperty("ALPHA",Variant((int)mAlpha));
 
}

References GetAlpha(), GetBlue(), GetGreen(), GetRed(), and PEBLObjectBase::InitializeProperty().

◆ ~PColor()

PColor::~PColor ( )

virtual

Copy constructor.

Definition at line 138 of file PColor.cpp.

139{

140}

Member Function Documentation

◆ ClearChanged()

void PColor::ClearChanged ( )

inline

Definition at line 79 of file PColor.h.

79{ mChanged = false; }

Referenced by PlatformFont::ClearChanged().

◆ GetAlpha()

int PColor::GetAlpha ( ) const

Definition at line 229 of file PColor.cpp.

229{ return mAlpha;}

Referenced by PlatformWindow::Draw(), SDLUtility::DrawLine(), SDLUtility::DrawPixel(), main(), PColor(), PColor(), PColor(), SDLUtility::PColorToSDLColor(), PlatformTextBox::RenderText(), PlatformCanvas::Reset(), SetAlpha(), PWidget::SetBackgroundColor(), PFont::SetBackgroundColor(), and PFont::SetFontColor().

◆ GetBlue()

int PColor::GetBlue ( ) const

Definition at line 228 of file PColor.cpp.

228{ return mBlue;}

Referenced by PlatformWindow::Draw(), SDLUtility::DrawLine(), SDLUtility::DrawPixel(), main(), PColor(), PColor(), PColor(), SDLUtility::PColorToSDLColor(), PlatformTextBox::RenderText(), PlatformCanvas::Reset(), PWidget::SetBackgroundColor(), PFont::SetBackgroundColor(), SetBlue(), and PFont::SetFontColor().

◆ GetColor()

unsigned int PColor::GetColor ( ) const

Gets 32-bit unsigned int color.

this is a bit clearer and easier to deal with cross-platform.

Definition at line 395 of file PColor.cpp.

{
    unsigned int color=0;
    color = mAlpha + (255 * mBlue)  + (255 * 255 * mGreen) + (255 * 255 * 255 * mRed);
    return color;
}

Referenced by main(), and ObjectName().

◆ GetGreen()

int PColor::GetGreen ( ) const

Definition at line 227 of file PColor.cpp.

227{ return mGreen;}

Referenced by PlatformWindow::Draw(), SDLUtility::DrawLine(), SDLUtility::DrawPixel(), main(), PColor(), PColor(), PColor(), SDLUtility::PColorToSDLColor(), PlatformTextBox::RenderText(), PlatformCanvas::Reset(), PWidget::SetBackgroundColor(), PFont::SetBackgroundColor(), PFont::SetFontColor(), and SetGreen().

◆ GetRed()

int PColor::GetRed ( ) const

Definition at line 226 of file PColor.cpp.

226{ return mRed;}

Referenced by PlatformWindow::Draw(), SDLUtility::DrawLine(), SDLUtility::DrawPixel(), main(), PColor(), PColor(), PColor(), SDLUtility::PColorToSDLColor(), PlatformTextBox::RenderText(), PlatformCanvas::Reset(), PWidget::SetBackgroundColor(), PFont::SetBackgroundColor(), PFont::SetFontColor(), and SetRed().

◆ HasChanged()

bool PColor::HasChanged ( ) const

inline

Change detection for nested property modifications.

Definition at line 78 of file PColor.h.

78{ return mChanged; }

Referenced by PlatformFont::HasChanged().

◆ ObjectName()

std::string PColor::ObjectName ( ) const

protectedvirtual

Reimplemented from PEBLObjectBase.

Definition at line 412 of file PColor.cpp.

{
    Variant tmp = "<PColor: Red: [";
 
    tmp = tmp + Variant((int)mRed) ;
    tmp = tmp + Variant("] Green: [");
    tmp = tmp +  Variant((int)mGreen);
    tmp = tmp + Variant("] Blue: [");
    tmp = tmp + Variant((int)mBlue );
    tmp = tmp + Variant("] Alpha: [");
    tmp = tmp + Variant((int)mAlpha );
    tmp = tmp + Variant("] Color Code: [");
    tmp = tmp + Variant((long unsigned int)GetColor());
    tmp = tmp + Variant("]>");
 
    return tmp.GetString();
}

References GetColor(), and Variant::GetString().

Referenced by SendToStream().

◆ SendToStream()

std::ostream & PColor::SendToStream ( std::ostream & out ) const

protectedvirtual

This sends the color descriptions to the specified stream.

Reimplemented from PEBLObjectBase.

Definition at line 406 of file PColor.cpp.

{
    out << ObjectName() << std::flush;
    return out;
}

References ObjectName().

◆ SetAlpha()

void PColor::SetAlpha ( int color )

Definition at line 218 of file PColor.cpp.

{
    mAlpha = To8BitColor(color);
    PEBLObjectBase::SetProperty("ALPHA",GetAlpha());
    mChanged = true;
}

References GetAlpha(), and PEBLObjectBase::SetProperty().

Referenced by main(), PWidget::SetBackgroundColor(), PFont::SetBackgroundColor(), PFont::SetFontColor(), and SetProperty().

◆ SetBlue()

void PColor::SetBlue ( int color )

Definition at line 211 of file PColor.cpp.

{
    mBlue  = To8BitColor(color);
    PEBLObjectBase::SetProperty("BLUE",GetBlue());
    mChanged = true;
}

References GetBlue(), and PEBLObjectBase::SetProperty().

Referenced by main(), PWidget::SetBackgroundColor(), PFont::SetBackgroundColor(), PFont::SetFontColor(), and SetProperty().

◆ SetColorByName()

void PColor::SetColorByName ( const std::string & colorname )

Sets color as by its name.

the RGBNames::Colornames is uppercase and sorted, so use a simple search to find the right one really fast.

Definition at line 257 of file PColor.cpp.

{
 
    // Check if this is a hex color code (starts with #)
    if (!colorname.empty() && colorname[0] == '#')
    {
        std::string hexcode = colorname.substr(1);  // Remove the '#'
 
        // Validate that hexcode contains only hex digits (0-9, A-F, a-f)
        bool valid = true;
        for (size_t i = 0; i < hexcode.length(); i++) {
            char c = hexcode[i];
            if (!((c >= '0' && c <= '9') || (c >= 'A' && c <= 'F') || (c >= 'a' && c <= 'f'))) {
                valid = false;
                break;
            }
        }
 
        if (valid && (hexcode.length() == 3 || hexcode.length() == 6 || hexcode.length() == 8))
        {
            int r = 0, g = 0, b = 0, a = 255;
 
            if (hexcode.length() == 3) {
                // #RGB format - expand to #RRGGBB
                r = std::stoi(hexcode.substr(0, 1), nullptr, 16) * 17;  // 0xF becomes 0xFF
                g = std::stoi(hexcode.substr(1, 1), nullptr, 16) * 17;
                b = std::stoi(hexcode.substr(2, 1), nullptr, 16) * 17;
            }
            else if (hexcode.length() == 6) {
                // #RRGGBB format
                r = std::stoi(hexcode.substr(0, 2), nullptr, 16);
                g = std::stoi(hexcode.substr(2, 2), nullptr, 16);
                b = std::stoi(hexcode.substr(4, 2), nullptr, 16);
            }
            else if (hexcode.length() == 8) {
                // #RRGGBBAA format
                r = std::stoi(hexcode.substr(0, 2), nullptr, 16);
                g = std::stoi(hexcode.substr(2, 2), nullptr, 16);
                b = std::stoi(hexcode.substr(4, 2), nullptr, 16);
                a = std::stoi(hexcode.substr(6, 2), nullptr, 16);
            }
 
            mRed   = To8BitColor(r);
            mGreen = To8BitColor(g);
            mBlue  = To8BitColor(b);
            mAlpha = To8BitColor(a);
            __SetProps__();
            return;  // Successfully parsed hex color
        }
    }
 
    std::string ucasename = PEBLUtility::ToUpper(colorname);
 
 
    int bottom = 0;
    int top    = RGBNames::NumRGBColorNames-1;
    int mid = (top + bottom)/2;
    int foundindex = -1;
    int test;
    bool sep1=false;          //This flags if the separation between top and bottom is 1.
 
 
    //Check the top-most name first.  If this is a hit, we could get stuck
    if(ucasename ==  RGBNames::ColorNames[top].name)
        {
            foundindex = top;    //It is a hit.
        }
 
    //Check the bottom-most name.  If this is a hit, we could get stuck
    if(ucasename == RGBNames::ColorNames[bottom].name)
        {
            foundindex = bottom;    //It is a hit.
        }
 
 
    //repeat until you find it or there is nothing to find.
    while(((top - bottom) > 1) && (foundindex == -1) && !sep1)
        {
 
 
            mid = (top + bottom)/2;
 
            //set the '1-item separation' flag to true.
            if((top - bottom) == 1) sep1 = true;
 
 
            //Compare the library color and the current color. 0 means they are the same.
            test =strcmp(ucasename.c_str(), RGBNames::ColorNames[mid].name.c_str());
 
 
            if(test < 0)           //If test < 0, the chosen word comes before the point in the dictionary. Move top down.
                {
                    top = mid;
                }
            else if(test > 0)       //If test > 0, the chosen word comes after the point in the dictionary. Move bottom up.
                {
                    bottom = mid;
                }
            else
                {
                    foundindex = mid;
                }
 
 
        }
 
    //Check top & bottom to see if there is a match.
    //if(strcmp(ucasename, RGBNames::ColorNames[top].name) == 0) foundindex = top;
    //if(strcmp(ucasename, RGBNames::ColorNames[bottom].name) == 0) foundindex = bottom;
 
 
    //If foundindex is still -1, we did not find the color name in the library.
    if(foundindex == -1)
        {
            PError::SignalWarning("Color name [" + string(ucasename) + "] not found.  Using Black.");
            foundindex = 25;   //25 is the index of black.
 
            //Better error detection should be done here: searching with levenshtien distance,
            //ignoring _ or - or #s, etc.
        }
 
 
 
    mRed   = RGBNames::ColorNames[foundindex].r;
    mGreen = RGBNames::ColorNames[foundindex].g;
    mBlue  = RGBNames::ColorNames[foundindex].b;
    mAlpha = 255;
    __SetProps__();
 
    //    cout << mRed << "-" << mGreen << "-" << mBlue << "-" <<endl;
}

References RGBNames::PEBL_RGB_Color_Names::b, RGBNames::ColorNames, RGBNames::PEBL_RGB_Color_Names::g, RGBNames::PEBL_RGB_Color_Names::name, RGBNames::NumRGBColorNames, RGBNames::PEBL_RGB_Color_Names::r, PError::SignalWarning(), and PEBLUtility::ToUpper().

Referenced by main().

◆ SetColorByRGBA() [1/2]

void PColor::SetColorByRGBA	(	int	red,
		int	green,
		int	blue,
		int	alpha
	)

Sets color as a 4 8-bit unsigned int.

Convenience constructor of PColor:

Definition at line 247 of file PColor.cpp.

{
    mRed   = To8BitColor(red);
    mGreen = To8BitColor(green);
    mBlue  = To8BitColor(blue);
    mAlpha = To8BitColor(alpha);
    __SetProps__();
}

◆ SetColorByRGBA() [2/2]

void PColor::SetColorByRGBA ( unsigned int color )

Sets color as a 32-bit unsigned int.

This uses modular arithmetic to extract colors from unsigned int. There could be more efficient ways to do it, but this is clear, and More likely to work cross-platform.

Definition at line 235 of file PColor.cpp.

{
    mAlpha  = color % 255;
    mBlue   = color / 255 % 255;
    mGreen  = color / (255 * 255) % 255;
    mRed    = color / ( 255 * 255 * 255) % 255;
    __SetProps__();
}

Referenced by main(), and PColor().

◆ SetGreen()

void PColor::SetGreen ( int color )

Definition at line 204 of file PColor.cpp.

{
    mGreen = To8BitColor(color);
    PEBLObjectBase::SetProperty("GREEN",GetGreen());
    mChanged = true;
}

References GetGreen(), and PEBLObjectBase::SetProperty().

Referenced by main(), PWidget::SetBackgroundColor(), PFont::SetBackgroundColor(), PFont::SetFontColor(), and SetProperty().

◆ SetProperty()

bool PColor::SetProperty	(	std::string	name,
		Variant	v
	)

virtual

Standard Destructor.

Reimplemented from PEBLObjectBase.

Definition at line 153 of file PColor.cpp.

{
 
    if(name == "RED") SetRed(v);
    else if(name == "GREEN") SetGreen(v);
    else if(name == "BLUE") SetBlue(v);
    else if(name == "ALPHA") SetAlpha(v);
    else return false;
 
    return true;
}

References SetAlpha(), SetBlue(), SetGreen(), and SetRed().

◆ SetRed()

void PColor::SetRed ( int color )

Definition at line 197 of file PColor.cpp.

{
    mRed   = To8BitColor(color);
    PEBLObjectBase::SetProperty("RED",GetRed());
    mChanged = true;
}

References GetRed(), and PEBLObjectBase::SetProperty().

Referenced by main(), PWidget::SetBackgroundColor(), PFont::SetBackgroundColor(), PFont::SetFontColor(), and SetProperty().

◆ ValidateProperty() [1/2]

ObjectValidationError PColor::ValidateProperty ( std::string name ) const

virtual

Reimplemented from PEBLObjectBase.

Definition at line 177 of file PColor.cpp.

 {
     return PEBLObjectBase::ValidateProperty(name);
 }

References PEBLObjectBase::ValidateProperty().

◆ ValidateProperty() [2/2]

ObjectValidationError PColor::ValidateProperty	(	std::string	name,
		Variant	v
	)		const

virtual

Reimplemented from PEBLObjectBase.

Definition at line 167 of file PColor.cpp.

{
    if(ValidateProperty(name) == OVE_INVALID_PROPERTY_NAME) return OVE_INVALID_PROPERTY_NAME;
 
    if(!v.IsNumber()) return OVE_INVALID_PROPERTY_TYPE;
    if( v < Variant(0) || v > Variant(255)) return OVE_INVALID_PROPERTY_VALUE;
    return OVE_SUCCESS;
}

References Variant::IsNumber(), OVE_INVALID_PROPERTY_NAME, OVE_INVALID_PROPERTY_TYPE, OVE_INVALID_PROPERTY_VALUE, OVE_SUCCESS, and ValidateProperty().

Referenced by ValidateProperty().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PColor() [1/5]

◆ PColor() [2/5]

◆ PColor() [3/5]

◆ PColor() [4/5]

◆ PColor() [5/5]

◆ ~PColor()

Member Function Documentation

◆ ClearChanged()

◆ GetAlpha()

◆ GetBlue()

◆ GetColor()

◆ GetGreen()

◆ GetRed()

◆ HasChanged()

◆ ObjectName()

◆ SendToStream()

◆ SetAlpha()

◆ SetBlue()

◆ SetColorByName()

◆ SetColorByRGBA() [1/2]

◆ SetColorByRGBA() [2/2]

◆ SetGreen()

◆ SetProperty()

◆ SetRed()

◆ ValidateProperty() [1/2]

◆ ValidateProperty() [2/2]