HOM_ViewerHandleTemplate.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.
 *
 * COMMENTS:
 */

#ifndef HOM_ViewerHandleTemplate_h
#define HOM_ViewerHandleTemplate_h

#include "HOM_API.h"
#include "HOM_Module.h"
#include "HOM_EnumValue.h"
#include "HOM_Defines.h"
//#include "HOM_ViewerHandleMenu.h"
#include "HOM_ViewerStateMenu.h"

#include <string>
#include <vector>
#include <utility>

SWIGOUT(%rename(ViewerHandleTemplate) HOM_ViewerHandleTemplate;)
SWIGOUT(%feature("notabstract") HOM_ViewerHandleTemplate;)

class HOM_API HOM_ViewerHandleTemplate
{
public:

#ifdef SWIG
%extend
{   
    %kwargs HOM_ViewerHandleTemplate;
    HOM_ViewerHandleTemplate(
        std::string const &                         type_name, 
        std::string const &                         label,
        std::vector<HOM_NodeTypeCategory*> const&   categories = std::vector<HOM_NodeTypeCategory*>())
    { 
        return HOM().newViewerHandleTemplate(type_name, label, categories); 
    }
}
#else
    HOM_ViewerHandleTemplate()
    { HOM_CONSTRUCT_OBJECT(this) }
#endif

    virtual ~HOM_ViewerHandleTemplate()
    { HOM_DESTRUCT_OBJECT(this) }

    virtual std::string __repr__() = 0;

    virtual std::string typeName() const = 0;

    virtual std::vector<HOM_NodeTypeCategory*> categories() const = 0;

    SWIGOUT(%ignore bindFactory_internal;)
    virtual void bindFactory_internal(void *callback) = 0;
    virtual void bindMenu( HOM_ViewerStateMenu const & menu ) = 0;
    virtual void bindIcon( std::string const & name ) = 0;

    SWIGOUT(%kwargs bindGadget;)
    virtual void bindGadget(HOM_EnumValue const & drawable_type, std::string const & name, 
        std::string const & label=std::string(), std::vector<std::string> const & parms=std::vector<std::string>()) = 0;

    SWIGOUT(%kwargs bindParameter;)
    virtual void bindParameter(
        HOM_EnumValue const&    param_type,
        std::string const&      name,
        std::string const&      label=std::string(),
        hboost::any             default_value=hboost::any(),
        int                     num_components=1,
        double                  min_limit=0,
        double                  max_limit=1,
        bool                    visible=true ) = 0;

    virtual void exportParameters(std::vector<std::string> const & params) = 0;

    SWIGOUT(%kwargs bindSetting;)
    virtual void bindSetting(
        HOM_EnumValue const&    param_type,
        std::string const&      name=std::string(),
        std::string const&      label=std::string(),
        std::vector< std::vector<std::string> > const & 
                                menu_items=std::vector< std::vector<std::string> >(),
        bool                    menu_as_button_strip=false,
        hboost::any             default_value=hboost::any(),
        int                     num_components=1,
        double                  min_limit=0,
        double                  max_limit=1,
        bool                    align=false) = 0;

 #ifdef SWIG
%extend
{
    virtual void bindFactory(InterpreterObject callback)
    {
        self->bindFactory_internal(callback);
    }
}
#endif // SWIG
};

#endif // HOM_ViewerHandleTemplate_h