HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SIM_QueryOptions.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  */
7 
8 #ifndef __SIM_QueryOptions_h__
9 #define __SIM_QueryOptions_h__
10 
11 #include "SIM_API.h"
12 #include "SIM_Query.h"
13 
14 class SIM_Options;
15 
16 /// This class provides an interface between a SIM_Data and the Houdini
17 /// expression language. It also helps in building the tree view of a
18 /// simulation.
20 {
21 public:
22  /// Constructor which takes a const SIM_Data as our owner.
23  explicit SIM_QueryOptions(const SIM_Data *owner,
24  const SIM_Options *options);
25  /// Destructor for this class.
26  virtual ~SIM_QueryOptions();
27 
28 protected:
29  const SIM_Options &getOptions() const;
30 
31  virtual int getNumRecordTypesSubclass() const;
32  virtual const char *getRecordTypeNameSubclass(
33  int recordtypenum) const;
34 
35  virtual int getNumRecordsSubclass(
36  const char *recordtype) const;
37  virtual int getNumFieldsSubclass(
38  const char *recordtype) const;
39  virtual const char *getFieldNameSubclass(
40  const char *recordtype,
41  int fieldnum) const;
43  const char *recordtype,
44  int fieldnum) const;
45  virtual bool getFieldRawSubclass(
46  const char *recordtype,
47  int recordnum,
48  const char *fieldname,
49  UT_OptionEntry *&result) const;
50 
51 private:
52  void buildNameList();
53 
54  const SIM_Options *myOptions;
57 };
58 
59 #endif
60 
UT_OptionType
virtual int getNumRecordsSubclass(const char *recordtype) const
virtual bool getFieldRawSubclass(const char *recordtype, int recordnum, const char *fieldname, UT_OptionEntry *&result) const
virtual int getNumRecordTypesSubclass() const
virtual const char * getFieldNameSubclass(const char *recordtype, int fieldnum) const
virtual int getNumFieldsSubclass(const char *recordtype) const
virtual UT_OptionType getFieldTypeSubclass(const char *recordtype, int fieldnum) const
#define SIM_API
Definition: SIM_API.h:10
virtual const char * getRecordTypeNameSubclass(int recordtypenum) const