HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
HOM_Selector.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  * COMMENTS:
7  */
8 
9 #ifndef __HOM_Selector_h__
10 #define __HOM_Selector_h__
11 
12 #include "HOM_API.h"
13 #include "HOM_Defines.h"
14 #include "HOM_Module.h"
15 #include "HOM_Errors.h"
16 #include <vector>
17 #include <string>
18 
19 class HOM_EnumValue;
20 class HOM_NodeType;
21 
22 SWIGOUT(%rename(Selector) HOM_Selector;)
23 
25 {
26 public:
28  { HOM_CONSTRUCT_OBJECT(this) }
29  HOM_Selector(const HOM_Selector &element)
30  { HOM_CONSTRUCT_OBJECT(this) }
31  virtual ~HOM_Selector()
32  { HOM_DESTRUCT_OBJECT(this) }
33 
34  virtual std::string __repr__() = 0;
35 
36  // These functions identify the selector, and the node type it is
37  // bound to.
38  virtual std::string name() = 0;
39  SWIGOUT(%newobject nodeType;)
40  virtual HOM_NodeType *nodeType() = 0;
41 
42  // These functions relate to the selector type. The geometry types
43  // that can be selected, and the group type parm values that correspond
44  // to those geometry types are both defined by the selector type.
45  virtual std::string selectorType() = 0;
46 
47  virtual std::vector<HOM_EnumValue *> geometryTypes() = 0;
48 
49  virtual std::vector<int> groupTypeParmValues() = 0;
50  virtual bool ordered() = 0;
51 
52  // These functions access information about the selector configuration.
53  // These are all options that can be controlled when creating the
54  // selector.
55  virtual std::string prompt() = 0;
56  virtual std::vector<HOM_EnumValue *> primitiveTypes() = 0;
57  virtual std::string groupParmName() = 0;
58  virtual std::string groupTypeParmName() = 0;
59  virtual int inputIndex() = 0;
60  virtual bool inputRequired() = 0;
61  virtual bool allowDragging() = 0;
62  virtual bool emptyStringSelectsAll() = 0;
63 
64  virtual std::string extraInfo() = 0;
65 
66  // Unbinds the selector. Use NodeType::addSelector to make a new one.
67  virtual void destroy() = 0;
68 };
69 
70 #endif
#define HOM_DESTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:973
virtual ~HOM_Selector()
Definition: HOM_Selector.h:31
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
#define SWIGOUT(x)
Definition: HOM_Defines.h:24
HOM_Selector(const HOM_Selector &element)
Definition: HOM_Selector.h:29
#define HOM_API
Definition: HOM_API.h:13
virtual std::string __repr__()=0
#define HOM_CONSTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:972
GLuint const GLchar * name
Definition: glcorearb.h:785