HOM/HOM_RampParmTemplate.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_RampParmTemplate_h__
#define __HOM_RampParmTemplate_h__

#include "HOM_API.h"
#include "HOM_ParmTemplate.h"

SWIGOUT(%feature("notabstract") HOM_RampParmTemplate;)
SWIGOUT(%rename(RampParmTemplate) HOM_RampParmTemplate;)

class HOM_API HOM_RampParmTemplate : virtual public HOM_ParmTemplate
{
public:
#ifdef SWIG
#ifdef SWIGPYTHON
    %feature("autodoc",
        "__init__(self, name, label, ramp_parm_type, default_value=2,"
        " default_basis=None, show_controls=True, color_type=None,"
        " disable_when=None, is_hidden=False, help=None, tags={})")
        HOM_RampParmTemplate;
#endif
%extend {
    %kwargs HOM_RampParmTemplate;
    HOM_RampParmTemplate(
            const char *name,
            const char *label,
            HOM_EnumValue &ramp_parm_type,
            int default_value = 2,
            HOM_EnumValue *default_basis = NULL,
            bool show_controls = true,
            HOM_EnumValue *color_type = NULL,
            const char *disable_when = NULL,
            bool is_hidden = false,
            const char *help = NULL,
            const std::map<std::string, std::string> &tags =
                HOM_StdMapStringString())
        throw(HOM_OperationFailed, HOM_TypeError, HOM_Error)
    {
        return HOM().newRampParmTemplate(name, label, ramp_parm_type,
                                         default_value,
                                         default_basis, show_controls,
                                         color_type,
                                         disable_when,
                                         is_hidden, help, tags);
    }
};
#else
    HOM_RampParmTemplate()
    { HOM_CONSTRUCT_OBJECT(this) }

    HOM_RampParmTemplate(const HOM_RampParmTemplate &parm_template)
    : HOM_ParmTemplate(parm_template)
    { HOM_CONSTRUCT_OBJECT(this) }
#endif

    virtual ~HOM_RampParmTemplate()
    { HOM_DESTRUCT_OBJECT(this) }

    // Let swig think we're overriding __repr__ for this class so it doesn't
    // provide its own __repr__.
    SWIGOUT(virtual std::string __repr__() throw(HOM_Error);)

    virtual int defaultValue() = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "parmType(self) -> hou.rampParmType enum value") type;)
    virtual HOM_EnumValue &parmType() = 0;
};

#endif

---