HOM/HOM_Color.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 */

#ifndef __HOM_Color_h__
#define __HOM_Color_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_Module.h"
#include <UT/UT_Color.h>
#include <vector>
#include <stdexcept>

SWIGOUT(%rename(Color) HOM_Color;)

class HOM_API HOM_Color
{
public:
    HOM_Color() throw(HOM_Error)
    : myColor(UT_RGB, 0.0f, 0.0f, 0.0f)
    { HOM_CONSTRUCT_OBJECT(this) }

    HOM_Color(const std::vector<float> &rgb_tuple) throw(HOM_Error);

    SWIGOUT(%ignore HOM_Color(const UT_Color&);)
    HOM_Color(const UT_Color &color) throw(HOM_Error)
    : myColor(color)
    { HOM_CONSTRUCT_OBJECT(this) }

    ~HOM_Color()
    { HOM_DESTRUCT_OBJECT(this) }

    bool operator==(HOM_Color &color)
    { return myColor == color.myColor; }

    bool operator!=(HOM_Color &color)
    { return !(myColor == color.myColor); }

    int __hash__();
    std::string __repr__();

    SWIGOUT(%ignore operator=;)
    HOM_Color &operator=(const HOM_Color& color)
    {
        myColor = color.myColor;
        return *this;
    }

    SWIGPYTHONOUT(%feature("autodoc",
        "rgb(self) -> (float, float, float)") rgb;)
    std::vector<float> rgb();

    SWIGPYTHONOUT(%feature("autodoc",
        "hsv(self) -> (float, float, float)") hsv;)
    std::vector<float> hsv();

    SWIGPYTHONOUT(%feature("autodoc",
        "hsl(self) -> (float, float, float)") hsl;)
    std::vector<float> hsl();

    SWIGPYTHONOUT(%feature("autodoc",
        "xyz(self) -> (float, float, float)") xyz;)
    std::vector<float> xyz();

    SWIGPYTHONOUT(%feature("autodoc",
        "lab(self) -> (float, float, float)") lab;)
    std::vector<float> lab();

    void setRGB(const std::vector<float> &tuple) throw(HOM_InvalidSize);
    void setHSV(const std::vector<float> &tuple) throw(HOM_InvalidSize);
    void setHSL(const std::vector<float> &tuple) throw(HOM_InvalidSize);
    void setXYZ(const std::vector<float> &tuple) throw(HOM_InvalidSize);
    void setLAB(const std::vector<float> &tuple) throw(HOM_InvalidSize);

    SWIGOUT(%ignore colorTypeForEnumValue;)
    static UT_ColorType     colorTypeForEnumValue(HOM_EnumValue &enum_value)
                                throw(HOM_TypeError);
    SWIGOUT(%ignore colorTypeToEnumValue;)
    static HOM_EnumValue &  colorTypeToEnumValue(UT_ColorType basis);

    SWIGOUT(%ignore myColor;)
    UT_Color myColor;
};

#endif

---