HOM_qt.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_qt_h__
#define __HOM_qt_h__

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

class HOM_LopNode;
class HOM_FloatingPanel;
class HOM_Node;

SWIGOUT(%rename(qt) HOM_qt;)
class HOM_API HOM_qt
{
public:
    virtual ~HOM_qt()
    {}

    virtual std::string __repr__() = 0;

    virtual void* _mainWindow() = 0;
    virtual void* _floatingPanelWindow(HOM_FloatingPanel *panel) = 0;

    virtual void* _createWindow() = 0;
    virtual void* _createDialog() = 0;
    virtual void* _createMenu() = 0;
    virtual void* _createIcon(
                    const char* icon_name, int width, int height,
                    double device_pixel_ratio,
                    const char *accent_color_name, const char *tint_color_name)
                    = 0;
    virtual bool canCreateIcon(const char *icon_name) = 0;
    virtual void *_createIconPixmap(
        const char* icon_name, int size, double device_pixel_ratio,
        int neutral_tint_r, int neutral_tint_g, int neutral_tint_b,
        int accent_color_r, int accent_color_g, int accent_color_b) = 0;

    virtual void* _createParmDialog(HOM_Node *hom_node, bool showTitleBar, bool compact, double labelsize) = 0;
    virtual void _setParmDialogNode(void *widget, HOM_Node *hom_node) = 0;
    virtual HOM_Node* _parmDialogNode(void *widget) = 0;

    virtual std::vector<std::string> _getParmDialogValueNames(void *widget) = 0;
    virtual std::string _getParmDialogValue(void *widget,const char *name) = 0;
    virtual bool _setParmDialogValue(void *widget,const char *name, const char* value) = 0;
    virtual bool _pressParmDialogButton(void *widget,const char *name) = 0;

    virtual std::vector<std::pair<std::string, std::vector<std::string>>>
            _getFeelNames(void *widget) = 0;
    virtual bool _setUIAttribute(void *widget, const char *multiparm,
            const char *name, const char *value) = 0;
    virtual std::string _getUIValue(void *widget, const char *multiparm,
            const char *name) = 0;
    virtual bool _setUIValue(void *widget, const char *multiparm,
            const char *name, const char *value) = 0;

    virtual std::vector<HOM_ElemPtr<HOM_ParmTuple> > _getParmDialogVisibleParms(void *widget) = 0;

    virtual bool _filterParmDialogFolders(void *widget, const char *pattern) = 0;

    virtual void* _getColor(const char* color_name) = 0;
    virtual void* _getCursor(const char *cursor_name) = 0;
    virtual void* _getBrush(const char* color_name) = 0;

    virtual std::string styleSheet(const char *file_path=nullptr) = 0;

    virtual std::map<std::string, int> _qtKeyToUIKey(int qtKey,
                                                    int qtKeymodifiers) = 0;
    virtual std::string _qtKeyToString(int qtKey,
                                       int qtKeymodifiers,
                                       std::string qtkeystring) = 0;

    virtual HOM_OptionalInt _nativeModifierIndependentKeyCode(
                                           int native_scan_code,
                                           int native_virtual_key) = 0;
    virtual bool _hasExtendedKeyEventInfo(int native_key_code) = 0;
    virtual int _eventKeyIfNoModifiers(int native_key_code) = 0;
    virtual std::string _eventTextIfNoModifiers(int native_key_code) = 0;

    SWIGOUT(%ignore _registerOpaqueKeyResolveInfoCallback;)
    virtual void _registerOpaqueKeyResolveInfoCallback(
                        void *widget,
                        void *py_callback) = 0;
    SWIGOUT(%ignore _unregisterOpaqueKeyResolveInfoCallback;)
    virtual void _unregisterOpaqueKeyResolveInfoCallback(
                        void *widget) = 0;

    SWIGOUT(%ignore _opaqueHotkeyAssignments;)
    virtual void _opaqueHotkeyAssignments(
                        void *widget,
                        const std::vector<std::string> &hotkey_symbols,
                        std::vector<std::vector<std::string> > &result) = 0;

#ifdef SWIG
%extend
{
    // TODO: Take an InterpreterObject for the widget and call python to run
    //       hou.qt.__utils__.getCppPointer() on it ourselves?
    void _registerKeyResolveInfoCallback(int64 widget,
                                         InterpreterObject callback)
    {
        self->_registerOpaqueKeyResolveInfoCallback(
                reinterpret_cast<void *>(widget), callback);
    }

    void _unregisterKeyResolveInfoCallback(int64 widget)
    {
        self->_unregisterOpaqueKeyResolveInfoCallback(
                reinterpret_cast<void *>(widget));
    }

    std::vector<std::vector<std::string> >
        _hotkeyAssignments(int64 widget,
                           const std::vector<std::string> &hotkey_symbols)
    {
        std::vector<std::vector<std::string> > result;
        self->_opaqueHotkeyAssignments(
                reinterpret_cast<void *>(widget), hotkey_symbols, result);
        return result;
    }
}
#endif

    virtual std::string _resolveKeyToCommand(
                         const char *key,
                         const std::vector<std::string> &override_contexts) = 0;

    virtual void _setDebugKeyEvents(bool on) = 0;

    virtual double inchesToPixels(double inches) = 0;
    virtual double pixelsToInches(double pixels) = 0;

    virtual void skipClosingMenusForCurrentButtonPress() = 0;
    
    virtual bool _launchRenderGalleryBackgroundRender(
            const char *delegate,
            const char *usd_filepath,
            const char *rendersettings_prim,
            const char *override_camera,
            int override_res_x, int override_res_y,
            const char *lopnet_path,
            const char *item_id
            ) = 0;

    virtual void _renderGalleryBackgroundRenderMouseClick(
            int x, int y, const char *lopnet_path,
            const char *item_id
            ) = 0;

    virtual bool _stopRenderGalleryBackgroundRender(
            const char *lopnet_path,
            const char *item_id
            ) = 0;

    virtual std::string _launchRenderGalleryLiveRender(
            HOM_LopNode *lop
            ) = 0;
    virtual bool _cancelRenderGalleryLiveRender(
            const char *id
            ) = 0;
    virtual bool _pauseRenderGalleryLiveRender(
            const char *id
            ) = 0;
    virtual bool _resumeRenderGalleryLiveRender(
            const char *id
            ) = 0;

    // Supported mime-types for drag-and-drop.
    virtual std::string _channelPathMimeType() = 0;
    virtual std::string _chopTrackPathMimeType() = 0;
    virtual std::string _galleryEntryMimeType() = 0;
    virtual std::string _galleryEntryNameMimeType() = 0;
    virtual std::string _itemPathMimeType() = 0;
    virtual std::string _nodeFlagPathMimeType() = 0;
    virtual std::string _nodePathMimeType() = 0;
    virtual std::string _orboltNodeTypeNameMimeType() = 0;
    virtual std::string _paneTabNameMimeType() = 0;
    virtual std::string _parmPathMimeType() = 0;
    virtual std::string _persistentHandleNameMimeType() = 0;
    virtual std::string _primitivePathMimeType() = 0;
    virtual std::string _shelfNameMimeType() = 0;
    virtual std::string _shelfToolNameMimeType() = 0;
    virtual std::string _takeNameMimeType() = 0;
    virtual std::string _usdPrimitivePathMimeType() = 0;
    virtual std::string _usdPrimitivePythonMimeType() = 0;
    virtual std::string _usdPropertyPathMimeType() = 0;
    virtual std::string _usdPropertyPythonMimeType() = 0;
    virtual std::string _nodePathAndUsdPrimitivePathMimeType() = 0;
    virtual std::string _assetGalleryEntryMimeType() = 0;

    // If adding a role that reflects a fixed-list of "acceptable values",
    // you may want to also update __init.py__ (or other files) in
    // ${PYHOM}/houpythonportion/qt
    virtual int _galleryNameRole() = 0;
    virtual int _galleryThumbRole() = 0;
    virtual int _galleryCreationDateRole() = 0;
    virtual int _galleryStarRole() = 0;
    virtual int _galleryDiffMarkerRole() = 0;
    virtual int _galleryColorRole() = 0;
    virtual int _galleryTagsRole() = 0;
    virtual int _galleryThumbValidRole() = 0;
    virtual int _galleryMetadataRole() = 0;
    virtual int _gallerySnapshotFileRole() = 0;
    virtual int _galleryOwnsFileRole() = 0;
    virtual int _gallerySnapshotRole() = 0;
    virtual int _galleryRenderMethodRole() = 0;
    virtual int _galleryRenderingRole() = 0;
    virtual int _galleryCloneIdRole() = 0;
};

#endif