HOM/HOM_ParticleViewer.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_ParticleViewer_h__
#define __HOM_ParticleViewer_h__

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

class HOM_GeometryViewport;

SWIGOUT(%rename(ParticleViewer) HOM_ParticleViewer;)

class HOM_API HOM_ParticleViewer : virtual public HOM_PathBasedPaneTab
{
public:
    HOM_ParticleViewer()
    { 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_ParticleViewer(const HOM_ParticleViewer &pane)
    : HOM_PaneTab(pane), HOM_PathBasedPaneTab(pane)
    { HOM_CONSTRUCT_OBJECT(this) }

    virtual ~HOM_ParticleViewer()
    { 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",
        "viewports(self) -> tuple of GeometryViewports") viewports;)
    virtual std::vector<HOM_ElemPtr<HOM_GeometryViewport> > viewports()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
    SWIGOUT(%newobject findViewport;)
    virtual HOM_GeometryViewport *findViewport(const char *name)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;

    virtual std::string currentState()
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void enterViewState(bool wait_for_exit = false)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_OperationFailed,
            HOM_OperationInterrupted, HOM_Error) = 0;
    virtual void enterCurrentNodeState(bool wait_for_exit = false)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_OperationFailed,
            HOM_OperationInterrupted, HOM_Error) = 0;
    virtual void setCurrentState(const char *state, bool wait_for_exit = false)
        throw(HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_OperationFailed,
            HOM_OperationInterrupted, HOM_Error) = 0;

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

    SWIGPYTHONOUT(%feature("autodoc",
        "viewportLayout(self) -> "
        " hou.geometryViewportLayout enum value") viewportLayout;)
    virtual HOM_EnumValue& viewportLayout()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setViewportLayout(HOM_EnumValue &layout, int single = -1)
        throw(HOM_ObjectWasDeleted, HOM_TypeError, HOM_Error) = 0;
};

#endif

---