HOM/HOM_Selector.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_Selector_h__
#define __HOM_Selector_h__

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

class HOM_EnumValue;
class HOM_NodeType;

SWIGOUT(%rename(Selector) HOM_Selector;)

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

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

    // These functions identify the selector, and the node type it is
    // bound to.
    virtual std::string name()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    SWIGOUT(%newobject nodeType;)
    virtual HOM_NodeType *nodeType()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    // These functions relate to the selector type. The geometry types
    // that can be selected, and the group type parm values that correspond
    // to those geometry types are both defined by the selector type.
    virtual std::string selectorType()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "geometryTypes(self) -> tuple of hou.geometryType enum values")
        geometryTypes;)
    virtual std::vector<HOM_EnumValue *> geometryTypes()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGPYTHONOUT(%feature("autodoc",
        "groupTypeParmValues(self) -> tuple of ints") groupTypeParmValues;)
    virtual std::vector<int> groupTypeParmValues()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual bool ordered()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    // These functions access information about the selector configuration.
    // These are all options that can be controlled when creating the
    // selector.
    virtual std::string prompt()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    SWIGPYTHONOUT(%feature("autodoc",
        "primitiveTypes(self) -> tuple of hou.primitiveType enum values")
        primitiveTypes;)
    virtual std::vector<HOM_EnumValue *> primitiveTypes()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual std::string groupParmName()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual std::string groupTypeParmName()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual int inputIndex()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual bool inputRequired()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual bool allowDragging()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual bool emptyStringSelectsAll()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    // Unbinds the selector. Use NodeType::addSelector to make a new one.
    virtual void destroy()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
};

#endif

---