HOM/HOM_hda.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_hda_h__
#define __HOM_hda_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_ElemPtr.h"
#include "HOM_EnumModules.h"
#include <UT/UT_Experimental.h>
#include <vector>

class HOM_Node;
class HOM_EnumValue;
class HOM_HDADefinition;

SWIGOUT(%rename(hda) HOM_hda;)

class HOM_API HOM_hda
{
public:
    virtual ~HOM_hda()
    {}

    virtual std::string __repr__() throw(HOM_Error) = 0;

    virtual void installFile(const char *file_path,
            const char *oplibraries_file = NULL,
            bool change_oplibraries_file = true,
            bool force_use_assets = false)
        throw(HOM_OperationFailed, HOM_Error) = 0;

    virtual void uninstallFile(const char *file_path,
            const char *oplibraries_file = NULL,
            bool change_oplibraries_file = true)
        throw(HOM_OperationFailed, HOM_Error) = 0;

    virtual void reloadFile(const char *file_path)
        throw(HOM_OperationFailed, HOM_Error) = 0;

    virtual void expandToDirectory(const char *file_path,
                                   const char *directory_path)
        throw(HOM_OperationFailed, HOM_Error) = 0;

    virtual void collapseFromDirectory(const char *file_path,
                                       const char *directory_path)
        throw(HOM_OperationFailed, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "loadedFiles(self) -> tuple of strings") loadedFiles;)
    virtual std::vector<std::string> loadedFiles()
        throw(HOM_OperationFailed, HOM_Error) = 0;

    virtual void renameSource(const char *oplibraries_file,
            const char *source_name = NULL)
        throw(HOM_OperationFailed, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "definitionsInFile(self, file_path) -> tuple of HDADefinitions")
        definitionsInFile;)
    virtual std::vector<HOM_ElemPtr<HOM_HDADefinition> >
            definitionsInFile(const char *file_path)
        throw(HOM_OperationFailed, HOM_Error) = 0;

#ifdef ENABLE_LICENSED_ASSETS
    virtual void encryptAsset(
            HOM_Node &node,
            const char *file_path,
            const char *email,
            const char *password,
            const std::vector<std::string> &license_names,
            bool compile_basic = true,
            bool compile_vopnets = true,
            bool compile_channels = true,
            bool compile_nodenames = true)
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "createEntitlement(self, email, password, license_name,"
        " entitled_email, license_type=hou.hdaLicenseType.Execute,"
        " expiry=0.0)") createEntitlement;)
    SWIGOUT(%kwargs createEntitlement;)
    virtual void createEntitlement(
            const char *email,
            const char *password,
            const char *license_name,
            const char *entitled_email,
            HOM_EnumValue &license_type = HOM_hdaLicenseType::Execute,
            float expiry = 0.0f)
        throw(HOM_TypeError, HOM_OperationFailed, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "availableEntitlements(self, email, password) -> tuple of strings")
        availableEntitlements;)
    SWIGOUT(%kwargs availableEntitlements;)
    virtual std::vector<std::string> availableEntitlements(
                        const char *email,
                        const char *password)
        throw(HOM_OperationFailed, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "redeemEntitlements(self, email, password, license_file=None,"
        " entitlements=())") redeemEntitlements;)
    SWIGOUT(%kwargs redeemEntitlements;)
    virtual void redeemEntitlements(
            const char *email,
            const char *password,
            const char *license_file = NULL,
            const std::vector<std::string> &entitlements =
                std::vector<std::string>())
        throw(HOM_OperationFailed, HOM_Error) = 0;
#endif // ENABLE_LICENSED_ASSETS
};

#endif

---