HOM_Handle.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_Handle_h
#define HOM_Handle_h

#include "HOM_API.h"
#include "HOM_Module.h"
#include "HOM_Defines.h"

SWIGOUT(%rename(Handle) HOM_Handle;)
SWIGOUT(%feature("notabstract") HOM_Handle;)

class HOM_API HOM_Handle
{
public:
#ifdef SWIG
%extend
{   
    HOM_Handle(
        HOM_PaneTab& scene_viewer,
        std::string const &name )
    {
        return HOM().newHandle(scene_viewer, name);
    }
}
#else
    HOM_Handle()
    { 
        HOM_CONSTRUCT_OBJECT(this) 
    }
#endif

    virtual ~HOM_Handle()
    { 
        HOM_DESTRUCT_OBJECT(this) 
    }

    virtual std::string __repr__() = 0;
    virtual std::string name() const = 0;
    virtual std::string label() const = 0;
    SWIGOUT(%warnfilter(321) type;)
    virtual std::string type() const = 0;
    virtual void        show(bool value) = 0;
    SWIGOUT(%ignore _update;)
    SWIGOUT(%kwargs _update;)
    virtual void _update(bool immediate=false,
                        bool node_update=false,
                        bool force_update=false,
                        void* args=nullptr) = 0;

#ifdef SWIG
%extend
{
    SWIGOUT(%kwargs update;)
    virtual void update(bool immediate=false,
                        bool node_update=false,
                        bool force_update=false,
                        InterpreterObject values=nullptr)
    {
        self->_update(immediate, node_update, force_update, values);
    }
}
#endif

    virtual void        enable() = 0;
    virtual void        disable() = 0;
    virtual bool        isEnabled() const = 0;
    virtual bool        visible() const = 0;
    virtual void        enableParms(std::vector<std::string> const & parm_names=std::vector<std::string>()) = 0;
    virtual void        disableParms(std::vector<std::string> const & parm_names=std::vector<std::string>()) = 0;
    virtual void        applySettings(std::string const& settings) = 0;
    virtual hboost::any settingValue(std::string const& setting_name) const = 0;
    virtual void        makePersistent(bool value) = 0;
    virtual bool        isPersistent() const = 0;
    virtual bool        isValid() const = 0;
    virtual bool        isActive() const = 0;
    virtual std::vector<std::string> 
                        parmPaths() const = 0;
    virtual bool        isDynamic() const = 0;
    virtual std::string info() const = 0;
    SWIGOUT(%kwargs nodePath;)
    virtual std::string nodePath(int index = 0) const = 0;

    virtual void        makeAsDefault() = 0;
    virtual void        revertToDefault() = 0;
    virtual void        revertToFactoryDefault() = 0;
    virtual void        exportToHDA() = 0;
    virtual void        exportParmsToHDA() = 0;

    virtual void        beginUndo() = 0;
    virtual void        endUndo() = 0;

    virtual void        detach() = 0;
    virtual void        attach() = 0;
    virtual bool        isDetached() const = 0;
    virtual bool        isDetachable() const = 0;
};


#endif // HOM_Handle_h