HOM/HOM_NetworkEditor.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_NetworkEditor_h__
#define __HOM_NetworkEditor_h__

#include "HOM_PathBasedPaneTab.h"
#include "HOM_EnumModules.h"

class HOM_Vector2;
class HOM_Node;

SWIGOUT(%rename(NetworkEditor) HOM_NetworkEditor;)

class HOM_API HOM_NetworkEditor : virtual public HOM_PathBasedPaneTab
{
public:
    HOM_NetworkEditor()
    { HOM_CONSTRUCT_OBJECT(this) }
    // Because the lowermost base classes initialize the virtual bases
    // before any non-virtual bases, the correct thing to do here is
    // explicitly call the constructor for HOM_PaneTab.
    HOM_NetworkEditor(const HOM_NetworkEditor &pane)
    : HOM_PaneTab(pane), HOM_PathBasedPaneTab(pane)
    { HOM_CONSTRUCT_OBJECT(this) }

    virtual ~HOM_NetworkEditor()
    { 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;)

    // Return a bool value indicating whether or not the auto-place flag
    // is turned on.
    virtual bool autoPlaceNodes()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    // Functions to get and set the list mode state of the network editor.
    virtual bool listMode()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setListMode(bool list_mode)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    // Put the network editor into a position selection state. We remain in
    // this state until the user cancels the operation or picks a location
    // by clicking the mouse in the network editor.
    SWIGOUT(%kwargs selectPosition;)
    SWIGOUT(%newobject selectPosition;)
    virtual HOM_Vector2 *selectPosition(HOM_Node *input_node = NULL,
                                        int output_index = 0,
                                        HOM_Node *output_node = NULL,
                                        int input_index = 0)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_OperationFailed,
              HOM_OperationInterrupted, HOM_Error) = 0;

    // Home the network editor to the current selection.
    virtual void homeToSelection()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    // Frame current selection.
    virtual void frameSelection()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual void insertIntoUnderlyingConnections(HOM_Node &node, float x, float y) 
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual void autoAddToNetbox(HOM_Node &node)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
};

#endif

---