PColor.h

Go to the documentation of this file.

  //* -*- mode:C++; tab-width:4; c-basic-offset:4; indent-tabs-mode:nil -*- */
//    Name:       src/objects/PColor.h
//    Purpose:    Lightweight class representing color
//    Author:     Shane T. Mueller, Ph.D.
//    Copyright:  (c) 2003-2026 Shane T. Mueller <smueller@obereed.net>
//    License:    GPL 2
//
//
//
//     This file is part of the PEBL project.
//
//    PEBL is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    PEBL is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with PEBL; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#ifndef __PCOLOR_H__
#define __PCOLOR_H__
 
#include "../base/PEBLObject.h"
#include <iostream>
#include <string>
 
class PColor: public PEBLObjectBase
{
public:
    PColor();                                             
    PColor(unsigned int color);//{mRed=0;mGreen=0;mBlue=0;mAlpha=0;SetColorByRGBA(color);};   ///Constructor
    PColor(int red, int green, int blue, int alpha);      
    PColor(const std::string & colorname);                
 
    PColor(const PColor & pcolor);                        
    virtual ~PColor();                                    
 
    //overloaded generic PEBLObjectBase methods
    virtual bool SetProperty(std::string, Variant v);
    virtual ObjectValidationError ValidateProperty(std::string name, Variant v)const;
    virtual ObjectValidationError ValidateProperty(std::string name)const;
 
 
    //These will return a single color
    int GetRed  () const;
    int GetGreen() const;
    int GetBlue () const;
    int GetAlpha() const;
 
    //These will set a single color
    void SetRed  (int color);
    void SetGreen(int color);
    void SetBlue (int color);
    void SetAlpha(int color);
 
    void SetColorByRGBA(unsigned int color);
 
    void SetColorByRGBA(int red, int green, int blue, int alpha);
 
    void SetColorByName(const std::string & colorname);
 
    unsigned int GetColor() const;
 
    bool HasChanged() const { return mChanged; }
    void ClearChanged() { mChanged = false; }
 
protected:
 
    virtual std::string ObjectName() const;
    //Used by overloaded << operator in PComplexData.
    virtual std::ostream & SendToStream(std::ostream& out) const;
 
private:
 
    //Private function that ensures colors are between 0 and 255.
    int To8BitColor(int color);
 
    void __SetProps__();
 
 
    unsigned mRed:   8;
    unsigned mGreen: 8;
    unsigned mBlue:  8;
    unsigned mAlpha: 8;
 
    bool mChanged;
};
 
 
#endif