HOM/HOM_shelves.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_shelves_h__
#define __HOM_shelves_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Errors.h"
#include "HOM_EnumValue.h"
#include "HOM_EnumModules.h"
#include "HOM_ElemPtr.h"
#include <map>
#include <vector>

class HOM_NodeTypeCategory;
class HOM_ShelfSet;
class HOM_Shelf;
class HOM_Tool;

SWIGOUT(%rename(shelves) HOM_shelves;)

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

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

    SWIGPYTHONOUT(%feature("autodoc",
        "shelfSets(self) -> dict of strings to ShelfSets") shelfSets;)
    virtual std::map<std::string, HOM_ElemPtr<HOM_ShelfSet> > shelfSets()
        throw(HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "shelves(self) -> dict of strings to Shelfs") shelves;)
    virtual std::map<std::string, HOM_ElemPtr<HOM_Shelf> > shelves()
        throw(HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "tools(self) -> dict of strings to Tools") tools;)
    virtual std::map<std::string, HOM_ElemPtr<HOM_Tool> > tools()
        throw(HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "runningTool(self) -> Tool or None") runningTool;)
    virtual HOM_Tool *runningTool()
        throw(HOM_Error) = 0;

    SWIGOUT(%newobject newShelfSet;)
    SWIGOUT(%kwargs newShelfSet;)
    virtual HOM_ShelfSet *newShelfSet(const char *file_path = NULL,
                                      const char *name = NULL,
                                      const char *label = NULL)
        throw(HOM_PermissionError, HOM_Error) = 0;

    SWIGOUT(%newobject newShelf;)
    SWIGOUT(%kwargs newShelf;)
    virtual HOM_Shelf *newShelf(const char *file_path = NULL,
                                const char *name = NULL,
                                const char *label = NULL)
        throw(HOM_PermissionError, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "newTool(self, file_path=None, name=None, label=None, script=None,"
        " language=hou.scriptLanguage.Python, icon=None, help=None,"
        " help_url=None, network_categories=(), viewer_categories=(),"
        " pop_viewer_categories=(), cop_viewer_categories=(),"
        " network_op_type=None, viewer_op_type=None, locations=())"
        " -> Tool") newTool;)
    SWIGOUT(%newobject newTool;)
    SWIGOUT(%kwargs newTool;)
    virtual HOM_Tool *newTool(const char *file_path = NULL,
                const char *name = NULL,
                const char *label = NULL,
                const char *script = NULL,
                HOM_EnumValue &language = HOM_scriptLanguage::Python,
                const char *icon = NULL,
                const char *help = NULL,
                const char *help_url = NULL,
                const std::vector<HOM_NodeTypeCategory *> &network_categories =
                    std::vector<HOM_NodeTypeCategory *>(),
                const std::vector<HOM_NodeTypeCategory*> &viewer_categories =
                    std::vector<HOM_NodeTypeCategory *>(),
                const std::vector<HOM_NodeTypeCategory*> &pop_viewer_categories
                    = std::vector<HOM_NodeTypeCategory *>(),
                const std::vector<HOM_NodeTypeCategory*> &cop_viewer_categories
                    = std::vector<HOM_NodeTypeCategory *>(),
                const char *network_op_type = NULL,
                const char *viewer_op_type = NULL,
                const std::vector<std::string> &locations =
                    std::vector<std::string>())
        throw(HOM_PermissionError, HOM_TypeError, HOM_Error) = 0;

    virtual std::string defaultFilePath()
        throw(HOM_Error) = 0;
};

#endif

---