HOM/HOM_NodeBundle.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_NodeBundle_h__
#define __HOM_NodeBundle_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_EnumModules.h"
#include "HOM_Errors.h"
#include "HOM_Module.h"
#include <boost/any.hpp>
#include <string>
#include <vector>

class HOM_Node;

SWIGOUT(%rename(Bundle) HOM_NodeBundle;)

class HOM_API HOM_NodeBundle
{
public:
    HOM_NodeBundle()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_NodeBundle(const HOM_Node &)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_NodeBundle()
    { HOM_DESTRUCT_OBJECT(this) }

    // We compare against a pointer instead of a reference because we want
    // to be able to compare against None.
    virtual bool operator==(HOM_NodeBundle *bundle)
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual bool operator!=(HOM_NodeBundle *bundle)
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual int __hash__() throw(HOM_Error) = 0;
    virtual std::string __repr__() throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

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

    virtual std::string name() throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setName(const char* name)
        throw(HOM_OperationFailed, HOM_TypeError, HOM_ObjectWasDeleted,
            HOM_Error) = 0;

    virtual HOM_EnumValue &filter()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setFilter(HOM_EnumValue &filter)
        throw(HOM_ObjectWasDeleted, HOM_TypeError, HOM_Error) = 0;

    SWIGOUT(%ignore boostAnyPattern;)
    virtual boost::any boostAnyPattern()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

#ifdef SWIG
%extend
{
    SWIGPYTHONOUT(%feature("autodoc",
        "pattern(self) -> string or None") pattern;)
    InterpreterObject pattern()
        throw(HOM_ObjectWasDeleted, HOM_Error)
    {
        return HOMboostAnyToInterpreterObject(self->boostAnyPattern());
    }
}
#endif

    virtual void setPattern(const char *pattern_or_none)
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

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

    virtual bool containsNode(HOM_Node &node)
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void addNode(HOM_Node &node)
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void removeNode(HOM_Node &base_node)
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void clear()
        throw(HOM_OperationFailed, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual bool isSelected()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%kwargs setSelected;)
    virtual void setSelected(bool on, bool clear_all_selected=false)
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
};

#endif

---