HOM/HOM_Shelf.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_Shelf_h__
#define __HOM_Shelf_h__

#include "HOM_API.h"
#include "HOM_ShelfElement.h"

class HOM_Tool;

SWIGOUT(%rename(Shelf) HOM_Shelf;)

class HOM_API HOM_Shelf : virtual public HOM_ShelfElement
{
public:
    HOM_Shelf()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_Shelf(const HOM_Shelf &shelfset)
    : HOM_ShelfElement(shelfset)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_Shelf()
    { 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__()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;)

    SWIGPYTHONOUT(%feature("autodoc",
        "tools(self) -> tuple of Tools") tools;)
    virtual std::vector<HOM_ElemPtr<HOM_Tool> > tools()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    // We need to receive the vector as a reference to a const, otherwise swig
    // won't convert from python sequences.
    virtual void setTools(const std::vector<HOM_Tool *> &tools)
        throw(HOM_ObjectWasDeleted, HOM_PermissionError, HOM_Error) = 0;

    virtual void destroy()
        throw(HOM_ObjectWasDeleted, HOM_PermissionError, HOM_Error) = 0;
};

#endif

---