HOM_CompositorViewer.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_CompositorViewer_h__
#define __HOM_CompositorViewer_h__

#include "HOM_PathBasedPaneTab.h"
#include "HOM_EnumModules.h"
#include "HOM_Viewport2D.h"

SWIGOUT(%rename(CompositorViewer) HOM_CompositorViewer;)

class HOM_API HOM_CompositorViewer : virtual public HOM_PathBasedPaneTab
{
public:
    typedef std::vector< std::pair<std::string, std::string> >  Bindings;
    typedef std::vector< std::string >                          HandleParmNames;

    HOM_CompositorViewer()
    { HOM_CONSTRUCT_OBJECT(this) }

    // Because the lowermost base classes initialize the virtual bases
    // before any non-virtual bases, the correct thing to do here is
    // explicitly call the constructor for HOM_PaneTab.
    HOM_CompositorViewer(const HOM_CompositorViewer &pane)
    : HOM_PaneTab(pane), HOM_PathBasedPaneTab(pane)
    { HOM_CONSTRUCT_OBJECT(this) }

    ~HOM_CompositorViewer() override
    { HOM_DESTRUCT_OBJECT(this) }

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

    virtual std::string currentState() = 0;

    virtual void enterViewState(bool wait_for_exit = false) = 0;

    virtual void setCurrentState(const char *state, bool wait_for_exit = false) = 0;

    virtual bool usingOCIO() = 0;
    virtual void setUsingOCIO(bool enable) = 0;

    SWIGOUT(%kwargs setOCIODisplayView;)
    virtual void setOCIODisplayView(const char *display = nullptr,
                                    const char *view = nullptr) = 0;
    virtual std::string getOCIODisplay() = 0;
    virtual std::string getOCIOView() = 0;

    SWIGOUT(%ignore _runStateCommand;)
    SWIGOUT(%kwargs _runStateCommand;)
    virtual void _runStateCommand(std::string const & name, void* args=nullptr) = 0;

    SWIGOUT(%newobject curViewport;)
    virtual HOM_Viewport2D *curViewport() = 0;

    virtual void showHandle(std::string const& name, bool value) = 0;

#ifdef SWIG
%extend
{
    SWIGOUT(%kwargs runStateCommand;)
    virtual void runStateCommand(std::string const & name, InterpreterObject args=nullptr)
    {
        self->_runStateCommand(name, args);
    }
}
#endif

    SWIGOUT(%kwargs bindViewerHandle;)
    virtual void bindViewerHandle(
        std::string const&      handle_type, 
        std::string const&      handle_instance_name, 
        std::string const&      settings=std::string(),
        bool                    cache_previous_parms = false,
        HandleParmNames const&  handle_parms = HandleParmNames()) = 0;

    SWIGOUT(%kwargs bindViewerHandleStatic;)
    virtual void bindViewerHandleStatic(
        std::string const&  handle_type, 
        std::string const&  handle_instance_name, 
        Bindings const &    bindings,
        std::string const&  settings=std::string() ) = 0;

    virtual void unbindViewerHandle(std::string const& handle_instance_name) = 0;
};

#endif