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_Geometry;
22 class HOM_Node;
23 class HOM_NodeType;
24 class HOM_LopNode;
25 class HOM_ParmTuple;
26 class HOM_ParmTemplate;
28 
29 SWIGOUT(%rename(lop) HOM_lop;)
30 
32 {
33 public:
34  virtual ~HOM_lop()
35  { }
36 
37  virtual std::string __repr__() = 0;
38 
39  virtual std::string defaultNewPrimPath() = 0;
40  virtual void setDefaultNewPrimPath(const char *path) = 0;
41 
42  virtual std::string defaultCollectionsPrimPath() = 0;
43  virtual void setDefaultCollectionsPrimPath(const char *path) = 0;
44 
45  virtual std::string defaultCollectionsPrimType() = 0;
46  virtual void setDefaultCollectionsPrimType(const char *primtype) = 0;
47 
48  virtual std::string defaultLightsPrimPath() = 0;
49  virtual void setDefaultLightsPrimPath(const char *path) = 0;
50 
51  virtual std::string defaultCamerasPrimPath() = 0;
52  virtual void setDefaultCamerasPrimPath(const char *path) = 0;
53 
54  virtual std::string defaultTransformSuffix() = 0;
55  virtual void setDefaultTransformSuffix(const char *suffix) = 0;
56 
57  virtual bool showResolvedPaths() = 0;
58  virtual void setShowResolvedPaths(bool show_resolved_paths) = 0;
59 
60  virtual bool panesFollowCurrentNode() = 0;
61  virtual void setPanesFollowCurrentNode(bool follow_current_node) = 0;
62 
63  virtual bool panesShowViewportStage() = 0;
64  virtual void setPanesShowViewportStage(bool show_viewport_stage) = 0;
65 
66  virtual bool panesShowPostLayers() = 0;
67  virtual void setPanesShowPostLayers(bool show_post_layers) = 0;
68 
69  virtual bool autoSetAssetResolverContext() = 0;
70  virtual void setAutoSetAssetResolverContext(bool auto_set_context) = 0;
71 
72  virtual bool updateRendererInBackground() = 0;
73  virtual void setUpdateRendererInBackground(bool update_in_background) = 0;
74 
75  virtual bool loadPayloadsByDefault() = 0;
76  virtual void setLoadPayloadsByDefault(bool load_payloads) = 0;
77 
78  virtual bool allowViewportOnlyPayloads() = 0;
79  virtual void setAllowViewportOnlyPayloads(
80  bool allow_viewport_only_payloads) = 0;
81 
82  virtual bool pathParameterCompletion() = 0;
83  virtual void setPathParameterCompletion(
84  bool path_parameter_completion) = 0;
85 
86  virtual double defaultMetersPerUnit() = 0;
87  virtual void setDefaultMetersPerUnit(double meters_per_unit) = 0;
88 
89  virtual std::string defaultUpAxis() = 0;
90  virtual void setDefaultUpAxis(const char *up_axis) = 0;
91 
92  virtual bool savePreferences() = 0;
93 
94  virtual void reloadLayer(const char *layer_path,
95  bool recursive = false) = 0;
96 
97  virtual std::string makeValidPrimName(const char *name) = 0;
98  SWIGOUT(%kwargs makeValidPrimPath;)
99  virtual std::string makeValidPrimPath(const char *path,
100  bool allow_relative = false) = 0;
101 
102  virtual HOM_ParmTemplateGroup *createParmsForProperty(HOM_LopNode *source,
103  const char *primpath,
104  const char *propertyname,
105  const char *parametername = nullptr,
106  bool prepend_control_parm = true,
107  bool prefix_xform_parms = true) = 0;
108  virtual HOM_ParmTemplateGroup *createParmsForProperty(const char *source,
109  const char *primpath,
110  const char *propertyname,
111  const char *parametername = nullptr,
112  bool prepend_control_parm = true,
113  bool prefix_xform_parms = true) = 0;
114  virtual HOM_ParmTemplateGroup *createParmsForParameter(
116  const char *parametername = nullptr,
117  const char *usdvaluetype = nullptr,
118  bool prepend_control_parm = true,
119  const char *propertyname = nullptr) = 0;
120 
121  virtual HOM_ParmTemplateGroup *createConnectionParmsForProperty(
123  const char *primpath,
124  const char *propertyname,
125  const char *parametername = nullptr,
126  bool prepend_control_parm = true) = 0;
127  virtual HOM_ParmTemplateGroup *createConnectionParmsForProperty(
128  const char *source,
129  const char *primpath,
130  const char *propertyname,
131  const char *parametername = nullptr,
132  bool prepend_control_parm = true) = 0;
133 
134  virtual void setParmTupleFromProperty(HOM_ParmTuple *parmtuple,
136  const char *primpath,
137  const char *propertyname) = 0;
138  virtual void setParmTupleFromProperty(HOM_ParmTuple *parmtuple,
139  const char *source,
140  const char *primpath,
141  const char *propertyname) = 0;
142 
143  virtual int shaderTranslatorID(HOM_Node &node) = 0;
144  virtual std::string shaderRenderContextName(
145  HOM_Node &node, const char *node_output_name) = 0;
146  virtual std::string translateShader(
147  HOM_Node &node, const char *node_output_name,
148  const char *material_prim_path,
149  const char *shader_parent_prim_path,
150  const char *shader_prim_name = nullptr,
151  HOM_OptionalDouble frame = HOM_OptionalDouble()) = 0;
152  virtual void reportShaderTranslation(HOM_Node &node,
153  const char *usd_shader_path) = 0;
154  virtual HOM_NodeType *shaderNodeType(const char *shader_name) = 0;
155 
156  virtual std::vector<std::string> availableRendererNames() = 0;
157  virtual std::vector<std::string> availableRendererLabels() = 0;
158 
159  SWIGOUT(%ignore availableRendererInfos);
160  virtual std::vector<UT_Options>
161  availableRendererInfos() = 0;
162 
163  virtual std::vector<std::pair<std::string, std::string> >
164  outputProcessors() = 0;
165  SWIGOUT(%newobject outputProcessorParms);
166  virtual HOM_ParmTemplateGroup *outputProcessorParms(
167  const char *name) = 0;
168 
169  virtual std::map<std::string, std::string> usdVersionInfo() = 0;
170 
171  virtual HOM_EnumValue &usdOutputMinimumSeverity() = 0;
172  virtual void setUsdOutputMinimumSeverity(HOM_EnumValue &severity) = 0;
173 
174  virtual std::string addLockedGeometry(
175  const char *identifier,
176  HOM_Geometry &geo,
177  const std::map<std::string, std::string> &args = {}) = 0;
178  virtual bool removeLockedGeometry(const char *identifier) = 0;
179 
180  SWIGOUT(%ignore addOpaquePreferenceChangeCallback;)
181  virtual void addOpaquePreferenceChangeCallback(void *callback) = 0;
182  SWIGOUT(%ignore removeOpaquePreferenceChangeCallback;)
183  virtual void removeOpaquePreferenceChangeCallback(void *callback) = 0;
184 
185  virtual void forceReloadAllFilesFromDisk(bool reload_viewports=false) = 0;
186 
187  virtual bool _isProceduralSigned(const char *filepath) = 0;
188 
189 #ifdef SWIG
190  %extend
191  {
192  InterpreterObject availableRendererInfo()
193  {
194  auto infos = self->availableRendererInfos();
195  return HOMoptionsListToInterpreterObject(infos);
196  }
197 
198  void addPreferenceChangeCallback(InterpreterObject callback)
199  { self->addOpaquePreferenceChangeCallback(callback); }
200 
201  void removePreferenceChangeCallback(InterpreterObject callback)
202  { self->removeOpaquePreferenceChangeCallback(callback); }
203  }
204 #endif
205 };
206 
207 #endif
virtual ~HOM_lop()
Definition: HOM_lop.h:34
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
#define SWIGOUT(x)
Definition: HOM_Defines.h:24
string __repr__(VtArray< T > const &self)
Definition: wrapArray.h:349
#define HOM_API
Definition: HOM_API.h:13
void ignore(T const &) VULKAN_HPP_NOEXCEPT
Definition: vulkan.hpp:6508
GLsizei GLsizei GLchar * source
Definition: glcorearb.h:803
GLenum GLenum severity
Definition: glcorearb.h:2539
GLuint const GLchar * name
Definition: glcorearb.h:786
OIIO_UTIL_API bool rename(string_view from, string_view to, std::string &err)
**If you just want to fire and args
Definition: thread.h:609
UT_Optional< double > HOM_OptionalDouble
Definition: HOM_Defines.h:45