include/fwData/Color.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2018.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#pragma once

#include "fwData/config.hpp"
#include "fwData/factory/new.hpp"
#include "fwData/Object.hpp"

#include <array>

fwCampAutoDeclareDataMacro((fwData)(Color), FWDATA_API);

namespace fwData
{
class FWDATA_CLASS_API Color : public Object
{

public:

    typedef float ColorType;
    typedef std::array<ColorType, 4> ColorArray;

    fwCoreClassDefinitionsWithNFactoriesMacro( (Color)(::fwData::Object),
                                               ((::fwData::factory::New< Color >, () ))
                                                   ((ColorFactory,
                                                     ((ColorType))((ColorType)(1.0)) ((ColorType) (1.0)) ((ColorType)(
                                                                                                              1.0)) ))
                                               );

    fwCampMakeFriendDataMacro((fwData)(Color));

    FWDATA_API Color( ::fwData::Object::Key key );

    FWDATA_API virtual ~Color();

    FWDATA_API void shallowCopy( const Object::csptr& _source ) override;

    FWDATA_API void cachedDeepCopy(const Object::csptr& _source, DeepCopyCacheType& cache) override;

    ColorArray& getRGBA();
    const ColorArray& getRGBA() const;
    void setRGBA(const ColorArray&  _vRGBA);
    FWDATA_API void setRGBA( const ColorType red, const ColorType green, const ColorType blue,
                             const ColorType alpha = 1.0 );

    FWDATA_API void setRGBA( std::string hexaColor );

    FWDATA_API ColorType& red();
    FWDATA_API ColorType& green();
    FWDATA_API ColorType& blue();
    FWDATA_API ColorType& alpha();

    FWDATA_API const ColorType& red()   const;
    FWDATA_API const ColorType& green() const;
    FWDATA_API const ColorType& blue()  const;
    FWDATA_API const ColorType& alpha() const;

protected:

    FWDATA_API static sptr ColorFactory(ColorType red, ColorType green, ColorType blue, ColorType alpha);

    ColorArray m_vRGBA;

}; // end class Color

//-----------------------------------------------------------------------------

inline Color::ColorArray& Color::getRGBA()
{
    return this->m_vRGBA;
}

//-----------------------------------------------------------------------------

inline const Color::ColorArray& Color::getRGBA() const
{
    return this->m_vRGBA;
}

//-----------------------------------------------------------------------------

inline void Color::setRGBA(const Color::ColorArray&  _vRGBA)
{
    this->m_vRGBA = _vRGBA;
}

//-----------------------------------------------------------------------------

} // end namespace fwData