HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HOM_lop.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_lop_h__
10 #define __HOM_lop_h__
11 
12 #include "HOM_API.h"
13 #include "HOM_Defines.h"
14 #include "HOM_EnumModules.h"
15 #include <UT/UT_Options.h>
16 
17 #include <map>
18 #include <string>
19 #include <vector>
20 
21 class HOM_Node;
22 class HOM_LopNode;
23 class HOM_ParmTuple;
24 class HOM_ParmTemplate;
26 
27 SWIGOUT(%rename(lop) HOM_lop;)
28 
30 {
31 public:
32  virtual ~HOM_lop()
33  { }
34 
35  virtual std::string __repr__() = 0;
36 
37  virtual std::string defaultNewPrimPath() = 0;
38  virtual void setDefaultNewPrimPath(const char *path) = 0;
39 
40  virtual std::string defaultCollectionsPrimPath() = 0;
41  virtual void setDefaultCollectionsPrimPath(const char *path) = 0;
42 
43  virtual std::string defaultCollectionsPrimType() = 0;
44  virtual void setDefaultCollectionsPrimType(const char *primtype) = 0;
45 
46  virtual std::string defaultLightsPrimPath() = 0;
47  virtual void setDefaultLightsPrimPath(const char *path) = 0;
48 
49  virtual std::string defaultCamerasPrimPath() = 0;
50  virtual void setDefaultCamerasPrimPath(const char *path) = 0;
51 
52  virtual std::string defaultTransformSuffix() = 0;
53  virtual void setDefaultTransformSuffix(const char *suffix) = 0;
54 
55  virtual bool showResolvedPaths() = 0;
56  virtual void setShowResolvedPaths(bool show_resolved_paths) = 0;
57 
58  virtual bool panesFollowCurrentNode() = 0;
59  virtual void setPanesFollowCurrentNode(bool follow_current_node) = 0;
60 
61  virtual bool panesShowViewportStage() = 0;
62  virtual void setPanesShowViewportStage(bool show_viewport_stage) = 0;
63 
64  virtual bool panesShowPostLayers() = 0;
65  virtual void setPanesShowPostLayers(bool show_post_layers) = 0;
66 
67  virtual bool autoSetAssetResolverContext() = 0;
68  virtual void setAutoSetAssetResolverContext(bool auto_set_context) = 0;
69 
70  virtual bool updateRendererInBackground() = 0;
71  virtual void setUpdateRendererInBackground(bool update_in_background) = 0;
72 
73  virtual bool loadPayloadsByDefault() = 0;
74  virtual void setLoadPayloadsByDefault(bool load_payloads) = 0;
75 
76  virtual bool allowViewportOnlyPayloads() = 0;
77  virtual void setAllowViewportOnlyPayloads(
78  bool allow_viewport_only_payloads) = 0;
79 
80  virtual bool useSimplifiedLinkerUi() = 0;
81  virtual void setUseSimplifiedLinkerUi(bool use_simplified_linker_ui) = 0;
82 
83  virtual double defaultMetersPerUnit() = 0;
84  virtual void setDefaultMetersPerUnit(double meters_per_unit) = 0;
85 
86  virtual std::string defaultUpAxis() = 0;
87  virtual void setDefaultUpAxis(const char *up_axis) = 0;
88 
89  virtual bool savePreferences() = 0;
90 
91  virtual void reloadLayer(const char *layer_path,
92  bool recursive = false) = 0;
93 
94  virtual std::string makeValidPrimName(const char *name) = 0;
95  SWIGOUT(%kwargs makeValidPrimPath;)
96  virtual std::string makeValidPrimPath(const char *path,
97  bool allow_relative = false) = 0;
98 
99  virtual HOM_ParmTemplateGroup *createParmsForProperty(HOM_LopNode *source,
100  const char *primpath,
101  const char *propertyname,
102  const char *parametername = nullptr,
103  bool prepend_control_parm = true,
104  bool prefix_xform_parms = true) = 0;
105  virtual HOM_ParmTemplateGroup *createParmsForProperty(const char *source,
106  const char *primpath,
107  const char *propertyname,
108  const char *parametername = nullptr,
109  bool prepend_control_parm = true,
110  bool prefix_xform_parms = true) = 0;
111  virtual HOM_ParmTemplateGroup *createParmsForParameter(
113  const char *parametername = nullptr,
114  const char *usdvaluetype = nullptr,
115  bool prepend_control_parm = true) = 0;
116  virtual void setParmTupleFromProperty(HOM_ParmTuple *parmtuple,
118  const char *primpath,
119  const char *propertyname) = 0;
120 
121  virtual int shaderTranslatorID(HOM_Node &node) = 0;
122  virtual std::string shaderRenderContextName(
123  HOM_Node &node, const char *node_output_name) = 0;
124  virtual std::string translateShader(
125  HOM_Node &node, const char *node_output_name,
126  const char *material_prim_path,
127  const char *shader_parent_prim_path) = 0;
128  virtual void reportShaderTranslation(HOM_Node &node,
129  const char *usd_shader_path) = 0;
130 
131  virtual std::vector<std::string> availableRendererNames() = 0;
132  virtual std::vector<std::string> availableRendererLabels() = 0;
133 
134  SWIGOUT(%ignore availableRendererInfos);
135  virtual std::vector<UT_Options>
136  availableRendererInfos() = 0;
137 
138  virtual std::vector<std::pair<std::string, std::string> >
139  outputProcessors() = 0;
140  SWIGOUT(%newobject outputProcessorParms);
141  virtual HOM_ParmTemplateGroup *outputProcessorParms(
142  const char *name) = 0;
143 
144  virtual std::map<std::string, std::string> usdVersionInfo() = 0;
145 
146  virtual HOM_EnumValue &usdOutputMinimumSeverity() = 0;
147  virtual void setUsdOutputMinimumSeverity(HOM_EnumValue &severity) = 0;
148 
149 #ifdef SWIG
150  %extend
151  {
152  InterpreterObject availableRendererInfo()
153  {
154  auto infos = self->availableRendererInfos();
155  return HOMoptionsListToInterpreterObject(infos);
156  }
157  }
158 #endif
159 };
160 
161 #endif
virtual ~HOM_lop()
Definition: HOM_lop.h:32
OIIO_API bool rename(string_view from, string_view to, std::string &err)
GLsizei const GLchar *const * path
Definition: glcorearb.h:3340
#define SWIGOUT(x)
Definition: HOM_Defines.h:24
string __repr__(VtArray< T > const &self)
Definition: wrapArray.h:353
GLuint const GLchar * name
Definition: glcorearb.h:785
#define HOM_API
Definition: HOM_API.h:13
GLsizei GLsizei GLchar * source
Definition: glcorearb.h:802
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
GLenum GLenum severity
Definition: glcorearb.h:2538