HOM/HOM_IPRViewer.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_IPRViewer_h__
#define __HOM_IPRViewer_h__

#include "HOM_PathBasedPaneTab.h"
#include "HOM_EnumModules.h"
#include <vector>

class HOM_Node;
class HOM_Prim;

SWIGOUT(%rename(IPRViewer) HOM_IPRViewer;)

class HOM_API HOM_IPRViewer : virtual public HOM_PaneTab
{
public:
    HOM_IPRViewer()
    { HOM_CONSTRUCT_OBJECT(this) }

    HOM_IPRViewer(const HOM_IPRViewer &pane)
    : HOM_PaneTab(pane)
    { HOM_CONSTRUCT_OBJECT(this) }

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

    virtual bool isIPREnabled()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual void enableIPR(bool on)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual bool isAutoUpdateOn()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual void setAutoUpdate(bool on)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual double delay()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual void setDelay(double time)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual double updateTime()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual void setUpdateTime(double time)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::vector<int> lastClickLocation()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%newobject ropNode;)
    virtual HOM_Node *ropNode()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::vector<int> imageResolution()
        throw(HOM_OperationFailed, HOM_NotAvailable, HOM_ObjectWasDeleted,
            HOM_Error) = 0;

    virtual std::vector<double> cropRegion()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::vector<std::string> planes()
        throw(HOM_OperationFailed, HOM_NotAvailable, HOM_ObjectWasDeleted,
            HOM_Error) = 0;

    virtual std::vector<double> pixel(const char *plane_name, int x, int y)
        throw(HOM_OperationFailed, HOM_TypeError, HOM_NotAvailable,
            HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%newobject objectNode;)
    virtual HOM_Node *objectNode(int x, int y)
        throw(HOM_OperationFailed, HOM_NotAvailable, HOM_ObjectWasDeleted,
            HOM_Error) = 0;

    SWIGOUT(%newobject prim;)
    virtual HOM_Prim *prim(int x, int y)
        throw(HOM_OperationFailed, HOM_NotAvailable, HOM_ObjectWasDeleted,
            HOM_Error) = 0;

    SWIGOUT(%newobject materialNode;)
    virtual HOM_Node *materialNode(int x, int y)
        throw(HOM_OperationFailed, HOM_NotAvailable, HOM_ObjectWasDeleted,
            HOM_Error) = 0;
};

#endif

---