HOM/HOM_FloatParmTemplate.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_FloatParmTemplate_h__
#define __HOM_FloatParmTemplate_h__

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

SWIGOUT(%feature("notabstract") HOM_FloatParmTemplate;)
SWIGOUT(%rename(FloatParmTemplate) HOM_FloatParmTemplate;)

class HOM_API HOM_FloatParmTemplate : virtual public HOM_ParmTemplate
{
public:
#ifdef SWIG
%extend {
    %kwargs HOM_FloatParmTemplate;
    HOM_FloatParmTemplate(
            const char *name,
            const char *label,
            int num_components,
            const std::vector<double> &default_value = std::vector<double>(),
            double min = 0.0, double max = 10.0,
            bool min_is_strict = false, bool max_is_strict = false,
            HOM_EnumValue &look = HOM_parmLook::Regular,
            HOM_EnumValue &naming_scheme = HOM_parmNamingScheme::XYZW,
            const char *disable_when = NULL,
            bool is_hidden = false,
            bool is_label_hidden = false,
            bool join_with_next = false,
            const char *help = NULL,
            const char *script_callback = NULL,
            HOM_EnumValue &script_callback_language =
                HOM_scriptLanguage::Hscript,
            const std::map<std::string, std::string> &tags =
                HOM_StdMapStringString())
        throw(HOM_OperationFailed, HOM_TypeError, HOM_Error)
    {
        return HOM().newFloatParmTemplate(
            name, label, num_components, default_value,
            min, max, min_is_strict, max_is_strict, look, naming_scheme,
            disable_when, is_hidden, is_label_hidden, join_with_next, help,
            script_callback, script_callback_language, tags);
    }
};
#else
    HOM_FloatParmTemplate()
    { HOM_CONSTRUCT_OBJECT(this) }

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

    virtual ~HOM_FloatParmTemplate()
    { 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 double minValue() = 0;
    virtual void setMinValue(double min_value) throw(HOM_Error) = 0;
    virtual double maxValue() = 0;
    virtual void setMaxValue(double max_value) throw(HOM_Error) = 0;
    virtual bool minIsStrict() = 0;
    virtual void setMinIsStrict(bool on) throw(HOM_Error) = 0;
    virtual bool maxIsStrict() = 0;
    virtual void setMaxIsStrict(bool on) throw(HOM_Error) = 0;

    virtual std::vector<double> defaultValue() = 0;
    virtual void setDefaultValue(const std::vector<double> &default_value)
        throw(HOM_Error) = 0;

};

#endif

---