HOM/HOM_ViewerState.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_ViewerState_h__
#define __HOM_ViewerState_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_Module.h"
#include "HOM_Errors.h"
#include <vector>
#include <string>

class HOM_NodeType;
class HOM_NodeTypeCategory;

SWIGOUT(%rename(ViewerState) HOM_ViewerState;)

class HOM_API HOM_ViewerState
{
public:
    HOM_ViewerState()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_ViewerState(const HOM_ViewerState &element)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_ViewerState()
    { HOM_DESTRUCT_OBJECT(this) }

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

    // These functions identify the state, and the node type and node
    // type category it is associated with.
    virtual std::string name()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual std::string description()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual std::string icon()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "categories(self) -> tuple of NodeTypeCategories") categories;)
    virtual std::vector<HOM_NodeTypeCategory *> categories()

        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    SWIGOUT(%newobject nodeType;)
    virtual HOM_NodeType *nodeType()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

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

};

#endif

---