HOM/HOM_Ramp.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_Ramp_h__
#define __HOM_Ramp_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_EnumModules.h"
#include "HOM_Module.h"
#include <UT/UT_Ramp.h>


SWIGOUT(%rename(Ramp) HOM_Ramp;)

class HOM_API HOM_Ramp
{
public:
    HOM_Ramp() throw(HOM_Error)
        : myIsColor(false)
    { HOM_CONSTRUCT_OBJECT(this) }

    HOM_Ramp(std::vector<HOM_EnumValue *> basis,
             const std::vector<double> &keys,
             const std::vector<double> &values)
        throw(HOM_InvalidSize, HOM_TypeError, HOM_Error);

    HOM_Ramp(std::vector<HOM_EnumValue *> basis,
             const std::vector<double> &keys,
             const std::vector<std::vector<double> > &values)
        throw(HOM_InvalidSize, HOM_TypeError, HOM_Error);

    ~HOM_Ramp()
    { HOM_DESTRUCT_OBJECT(this) }


    SWIGOUT(%ignore operator=;)
    HOM_Ramp &operator=(const HOM_Ramp& ramp)
    {
        if (this != &ramp)
            myRamp = ramp.myRamp;
        return *this;
    }

    std::string __repr__();

    bool isColor()
    { return myIsColor; }

    HOM_EnumValue &colorType()
        throw(HOM_OperationFailed, HOM_Error);
    void setColorType(HOM_EnumValue &enum_value)
        throw(HOM_OperationFailed, HOM_TypeError, HOM_Error);


    SWIGPYTHONOUT(%feature("autodoc",
        "basis(self) -> tuple of hou.rampBasis enum values") basis();)
    std::vector<HOM_EnumValue *> basis()
        throw(HOM_ObjectWasDeleted, HOM_Error);

    SWIGPYTHONOUT(%feature("autodoc",
        "keys(self) -> tuple of floats") keys(); )
    std::vector<float> keys()
        throw(HOM_ObjectWasDeleted, HOM_Error);


    SWIGOUT(%ignore getUTRamp;)
    UT_Ramp &getUTRamp()
    { return myRamp; }

    SWIGOUT(%ignore setIsColor;)
    void setIsColor(bool is_color)
    { myIsColor = is_color; }

    SWIGOUT(%ignore rampLookup;)
    boost::any rampLookup(float pos) throw(HOM_OperationFailed);

    SWIGOUT(%ignore rampValues;)
    boost::any rampValues() throw(HOM_ObjectWasDeleted, HOM_Error);

    // Internal converters
    SWIGOUT(%ignore splineBasisForEnumValue;)
    static UT_SPLINE_BASIS splineBasisForEnumValue(
        HOM_EnumValue &enum_value) throw(HOM_TypeError);
    SWIGOUT(%ignore splineBasisToEnumValue;)
    static HOM_EnumValue & splineBasisToEnumValue(UT_SPLINE_BASIS basis);

#ifdef SWIG
%extend
{
    SWIGPYTHONOUT(%feature("autodoc",
        "lookup(self, pos) -> float or tuple") lookup(float pos);)
    InterpreterObject lookup(float pos) throw(HOM_OperationFailed)
    {
        return HOMboostAnyToInterpreterObject(self->rampLookup(pos));
    }

    SWIGPYTHONOUT(%feature("autodoc",
        "values(self) -> tuple of float or tuple values") values;)
    InterpreterObject values() throw(HOM_OperationFailed)
    {
        return HOMboostAnyToInterpreterObject(self->rampValues());
    }
}
#endif

private:
    UT_Ramp myRamp;
    bool myIsColor;
};

#endif

---