HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HUSD_Utils.h
Go to the documentation of this file.
1 /*
2  * Copyright 2019 Side Effects Software Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 
18 #ifndef __HUSD_Utils_h__
19 #define __HUSD_Utils_h__
20 
21 #include "HUSD_API.h"
22 #include "HUSD_DataHandle.h"
23 #include "HUSD_Path.h"
24 #include <UT/UT_Function.h>
25 #include <UT/UT_IntArray.h>
26 #include <UT/UT_Lock.h>
27 #include <UT/UT_Map.h>
28 #include <UT/UT_StringHolder.h>
29 #include <SYS/SYS_Hash.h>
30 
31 class HUSD_PathSet;
32 class HUSD_TimeCode;
33 class UT_Options;
34 class UT_String;
36 class PRM_Parm;
37 class OP_Node;
38 
45 
46  // This value is only used to create the scene graph tree through
47  // HUSD_PrimHandle. It should never be used to find prims to edit.
49 
50  // This places no limitations on which prims to return, but will not
51  // return instance proxies or prototype prims.
53 
54  // By default, place no demands on the traversal. This will even return
55  // pure "over" primitives, which may have incomplete definitions.
57 };
58 
59 // This enum specifies how a reference or sublayer or payload file reference
60 // is stored in the referring layer. The AUTO method stores paths specified
61 // as relative paths as relative paths, and paths specified as absolute paths
62 // as absolute paths. Paths specified as Search Paths (neither relative nor
63 // absolute) are always saved as-is.
65 {
69 };
70 
71 // This is the order of the viewport overrides layers. Note that they are
72 // ordered strongest to weakest, so the "solo" layers override the base layer,
73 // and the "custom" layer overrides the "solo" layers.
81 };
82 #define HUSD_OVERRIDES_NUM_LAYERS 6
83 
84 // Enum values that correspond to the SdfVariability values in the USD library.
88 };
89 
90 // Enum describing possible behaviors when layers are stripped off because of
91 // a layer break operation.
96 };
97 
98 // Enum describing the possible time sampling levels.
99 enum class HUSD_TimeSampling {
100  NONE, // no time samples; just the default value (not time varying)
101  SINGLE, // single time sample exists (value is not really time varying)
102  MULTIPLE // more than one time sample exists (value may be time varying)
103 };
104 
105 // Enum describing possible aspect ratio conformance policies.
107 {
108  INVALID = -1,
115 };
116 
117 // Describes the different ways of dealing with custom RenderProduct types:
118 // IGNORE: Do nothing, even if all products are custom types.
119 // ADD_AOVS: Request AOVs associated with custom products from the
120 // renderer. This is used for viewport renders.
121 // CREATE_DUMMY_RASTER: If all products are custom, create a dummy raster
122 // product to at least output a beauty image.
127 };
128 
129 // A "render key" which consists of the int values from the pickid and instid
130 // buffers generated by a render delegate.
132 {
133 public:
134  HUSD_RenderKey(int pick_id = -1, int inst_id = -1)
135  : myPickId(pick_id),
136  myInstId(inst_id)
137  { }
138 
139  bool operator==(const HUSD_RenderKey &other) const
140  {
141  return myPickId == other.myPickId &&
142  myInstId == other.myInstId;
143  }
144 
145  int myPickId;
146  int myInstId;
147 };
148 
149 // Hashing function for render keys.
150 inline size_t hash_value(const HUSD_RenderKey &key)
151 {
152  SYS_HashType hash = SYShash(key.myPickId);
153  SYShashCombine(hash, key.myInstId);
154 
155  return hash;
156 }
157 
158 // Map of render key to the scene graph path it corresponds to.
160 
161 // Callback function to be defined in the LOP library that returns a locked
162 // stage pointer for a LOP node given an "op:" prefixed path.
164 
165 // A list of path strings that contain instance id numbers (possibly nested).
166 // Expressed with a typedef in case we decide to make this a more efficient
167 // data structure in the future.
169 
170 // Configures the USD library for use within Houdini. The primary purpose is to
171 // set the prefered ArResolver to be the Houdini resolver. This should be
172 // called as soon as possible after loading the HUSD library.
173 HUSD_API void
175 
176 // Set the callback function that is used by the HUSD library to resolve a
177 // LOP node path into an HUSD_LockedStagePtr. This callback is used to help
178 // populate the GusdStageCache for a USD packed primitive with a "file" path
179 // that points to a LOP node using an "op:" style path.
180 HUSD_API void
182 
183 // Calls the GusdStageCache::SplitLopStageIdentifier method, without having to
184 // inclde the stageCache.h header, which is not allowed in the LOP library.
185 HUSD_API bool
186 HUSDsplitLopStageIdentifier(const UT_StringRef &identifier,
187  OP_Node *&lop,
188  bool &split_layers,
189  fpreal &t,
190  UT_Options &opts);
191 
192 /// Returns true if name is a valid identifier (ie, valid component of a path).
193 HUSD_API bool
195 
196 // Modifies the passed in string to make sure it conforms to USD primitive
197 // naming restrictions. Illegal characters are replaced by underscores.
198 HUSD_API bool
199 HUSDmakeValidUsdName(UT_String &name, bool addwarnings);
200 
201 // Returns the name of the node passed through the HUSDmakeValidUsdName method.
202 // This saves several lines of code every time we use this pattern.
205 
206 // Modifies the passed in string to make sure it conforms to USD primitive
207 // naming restrictions. Illegal characters are replaced by underscores. Each
208 // path component is validated separately. The returned path will always be
209 // an absolute path, prefixing "/" to any passed in relative path.
210 HUSD_API bool
211 HUSDmakeValidUsdPath(UT_String &path, bool addwarnings);
212 
213 // As the above function, except it has the option of allowing the passed in
214 // and returned path to be a relative path.
215 HUSD_API bool
216 HUSDmakeValidUsdPath(UT_String &path, bool addwarnings, bool allow_relative);
217 
218 // Like the above method, but accepts "defaultPrim" as well.
219 HUSD_API bool
221 
222 // Ensures the given primitive path is unique and does not conflict
223 // with any existing primitives on the stage given by the lock.
224 // If suffix is given, if the given path is colliding, the new path
225 // will use it along with a digit to disambiguate it.
226 // Returns true if given path had to be changed; false otherwise.
227 HUSD_API bool
229  const UT_StringRef &suffix = UT_StringRef());
230 
231 // Returns the path of the node passed through the HUSDmakeValidUsdPath method.
232 // This saves several lines of code every time we use this pattern.
235 
236 // Modifies the passed in string to make sure it conforms to USD property
237 // naming restrictions. This includes allowing multiple nested namespaces
238 // in the name. Illegal characters are replaced by underscores.
239 HUSD_API bool
240 HUSDmakeValidUsdPropertyName(UT_String &name, bool addwarnings);
241 
242 // Modifies the passed in string to make sure it conforms to USD variant
243 // naming restrictions. Note that these are different from normal primitive
244 // naming conventions, as defined in SdfSchemaBase::IsValidVariantIdentifier:
245 // One or more letter, number, '_', '|', or '-', with an optional leading '.'
246 // Illegal characters are replaced by underscores.
247 HUSD_API bool
248 HUSDmakeValidVariantName(UT_String &name, bool allowexprs, bool addwarnings);
249 
250 // Modifies the passed in string to make sure it conforms to USD primitive
251 // naming restrictions. Leading slashes are thrown away. Illegal characters
252 // are considered an error and cause this function to return false.
253 HUSD_API bool
254 HUSDmakeValidDefaultPrim(UT_String &default_prim, bool addwarnings);
255 
256 // Returns primitive name, given the primitive path.
258 HUSDgetUsdName(const UT_StringRef &primpath);
259 
260 // Returns primitive's parent path, given the primitive path.
262 HUSDgetUsdParentPath(const UT_StringRef &primpath);
263 
264 // Modifies the provided path set so that if all the children of a prim are
265 // in the set, the children are removed, and the parent prim is put in the
266 // set instead. This procedure is applied recursively. This converts some
267 // parameters to USD types then calls the XUSD_Utils version of this method.
268 HUSD_API void
270  bool skip_point_instancers,
271  const HUSD_AutoAnyLock &lock,
272  HUSD_PathSet &paths);
273 
274 // Return the primary alias for the specified USD primitive type.
276 HUSDgetPrimTypeAlias(const UT_StringRef &primtype);
277 
278 // If layers are stripped during a flatten operation, this function handles
279 // the error creation based on the requested response. Returns true of the
280 // requested response is to generate an error, which usually means we should
281 // also stop processing.
282 HUSD_API bool
284 
285 /// Enum of USD transform operation types.
286 /// Note, they need to correspond to UsdGeomXformOp::Type enum.
287 enum class HUSD_XformType {
288  Invalid,
289  Translate,
290  Scale,
293  Orient,
294  Transform
295 };
296 
297 /// Enum of rotation axis.
298 enum class HUSD_XformAxis { X, Y, Z };
299 
300 /// Enum of rotation order.
301 enum class HUSD_XformAxisOrder { XYZ, XZY, YXZ, YZX, ZXY, ZYX };
302 
303 /// @{ Functions for obtaining transform name, suffix, and type.
305  UT_StringHolder &xform_namesuffix,
306  const UT_StringRef& xform_fullname);
310  const UT_StringRef &xform_namesuffix);
312  UT_StringHolder *xform_type = nullptr,
313  UT_StringHolder *xform_name = nullptr);
314 /// @}
315 
316 /// @{ Manipulate collection paths and components. The individual components
317 /// must be validated (see HUSDmakeValidName and HUSDmakeValidPath) before
318 /// calling these methods.
320  const UT_StringRef &collection_name);
322  UT_StringHolder &collection_name,
323  const UT_StringRef &collection_path);
325 /// @}
326 
327 /// @{ Create property paths from their components. The individual components
328 /// must be validated (see HUSDmakeValidName and HUSDmakeValidPath) before
329 /// calling these methods.
331  const UT_StringRef &property_name);
333  const UT_StringRef &attribute_name);
335  const UT_StringRef &relationship_name);
336 /// @}
337 
338 /// Returns the prim path and the property name, given the property path.
339 HUSD_API std::pair<UT_StringHolder, UT_StringHolder>
340 HUSDsplitPropertyPath(const UT_StringRef &property_path);
341 
342 /// Returns the attribute name of the given primvar
344 
345 /// Returns the string name of the Usd Sdf type best suited for the parameter.
347 
348 /// Returns the time code at which to author an attribute value.
350  const HUSD_TimeCode &timecode,
351  HUSD_TimeSampling time_sampling);
352 
353 /// Returns true if there are more than one time samples.
354 HUSD_API bool HUSDisTimeVarying(HUSD_TimeSampling time_sampling);
355 
356 /// Returns true if there is at least one time sample.
357 HUSD_API bool HUSDisTimeSampled(HUSD_TimeSampling time_sampling);
358 
359 /// Set a parameter value from the value of a USD property.
361  const UT_StringRef &primpath,
362  const UT_StringRef &attribname,
363  const HUSD_TimeCode &tc,
364  PRM_Parm &parm,
365  HUSD_TimeSampling &timesampling);
366 
367 /// Split the found prims into shade and geo prims.
368 /// The parms control whether materials bound to geo prims are included
369 /// in the shade prims, and if so, whether to include material's surface
370 /// shader rather than material itself, if the material has no interface
371 /// input attributes (ie, is not particularly editable).
373  const HUSD_AutoAnyLock &anylock,
374  const HUSD_PathSet &primpaths,
375  UT_StringArray &shadeprimpaths,
376  UT_StringArray &geoprimpaths,
377  bool include_bound_materials = true,
378  bool use_shader_for_mat_with_no_inputs = true);
379 
380 /// Gets a list of primitives that are siblings or ancestors (or siblings
381 /// of ancestors) of any of the provided prims, and are also have any
382 /// of these prims as direct or indirect sources (via UsdConnectableAPI).
383 /// This method will work for materials, light filters, or any other
384 /// connectable prim type.
386  const HUSD_AutoAnyLock &anylock,
387  const UT_StringArray &modified_primpaths);
388 /// Bump metadata on a USD primitive to force a hydra update.
390  const HUSD_AutoWriteLock &writelock,
391  const UT_StringArray &bump_primpaths);
392 
393 /// Return a lock object that should be obtained by any code that is going
394 /// to call a USD method that reloads a layer, and by any code that needs to
395 /// be protected against layers being reloaded on another thread. This exists
396 /// primarily to protect background render delegate update threads from
397 /// reload calls happening while reading from the viewport stage.
399 
400 /// Takes the root layer of the USD file at path and searches for all
401 /// referenced asset paths in that layer, replacing them with the
402 /// return value of modifyFn. The resulting layer is saved at the path
403 /// specified by dest. If path and dest are the same, it overwrites
404 /// the file at path.
405 HUSD_API void
407  const UT_Function<UT_StringHolder(UT_StringHolder)> &modifyFn,
408  const UT_StringHolder &dest);
409 
410 #endif
HUSD_API bool HUSDmakeValidVariantName(UT_String &name, bool allowexprs, bool addwarnings)
HUSD_API void HUSDgetMinimalPathsForInheritableProperty(bool skip_point_instancers, const HUSD_AutoAnyLock &lock, HUSD_PathSet &paths)
HUSD_API bool HUSDmakeValidDefaultPrim(UT_String &default_prim, bool addwarnings)
HUSD_API UT_StringHolder HUSDmakePropertyPath(const UT_StringRef &prim_path, const UT_StringRef &property_name)
HUSD_RenderKey(int pick_id=-1, int inst_id=-1)
Definition: HUSD_Utils.h:134
HUSD_LockedStagePtr(* HUSD_LopStageResolver)(const UT_StringRef &path)
Definition: HUSD_Utils.h:163
HUSD_API void HUSDinitialize()
HUSD_API UT_StringHolder HUSDgetValidUsdPath(OP_Node &node)
HUSD_API bool HUSDisValidUsdName(const UT_StringRef &name)
Returns true if name is a valid identifier (ie, valid component of a path).
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
HUSD_API bool HUSDsetParmFromProperty(HUSD_AutoAnyLock &lock, const UT_StringRef &primpath, const UT_StringRef &attribname, const HUSD_TimeCode &tc, PRM_Parm &parm, HUSD_TimeSampling &timesampling)
Set a parameter value from the value of a USD property.
HUSD_API void HUSDsetLopStageResolver(HUSD_LopStageResolver resolver)
#define HUSD_API
Definition: HUSD_API.h:32
std::size_t SYS_HashType
Define the type for hash values.
Definition: SYS_Hash.h:19
HUSD_API bool HUSDmakeValidUsdPropertyName(UT_String &name, bool addwarnings)
HUSD_API bool HUSDmakeValidUsdPath(UT_String &path, bool addwarnings)
HUSD_API UT_StringHolder HUSDgetUsdName(const UT_StringRef &primpath)
HUSD_PrimTraversalDemands
Definition: HUSD_Utils.h:39
HUSD_XformAxis
Enum of rotation axis.
Definition: HUSD_Utils.h:298
HUSD_OverridesLayerId
Definition: HUSD_Utils.h:74
HUSD_Variability
Definition: HUSD_Utils.h:85
UT_StringSet HUSD_InstanceSelection
Definition: HUSD_Utils.h:168
HUSD_API UT_Lock & HUSDgetLayerReloadLock()
HUSD_API UT_StringHolder HUSDmakeCollectionPath(const UT_StringRef &prim_path, const UT_StringRef &collection_name)
HUSD_API UT_StringHolder HUSDgetUsdParentPath(const UT_StringRef &primpath)
HUSD_XformType
Definition: HUSD_Utils.h:287
HUSD_API bool HUSDmakeValidUsdName(UT_String &name, bool addwarnings)
HUSD_TimeSampling
Definition: HUSD_Utils.h:99
HUSD_API UT_StringArray HUSDgetConnectedPrimsToBumpForHydra(const HUSD_AutoAnyLock &anylock, const UT_StringArray &modified_primpaths)
bool operator==(const HUSD_RenderKey &other) const
Definition: HUSD_Utils.h:139
HUSD_API bool HUSDisValidCollectionPath(const UT_StringRef &path)
HUSD_API bool HUSDisXformAttribute(const UT_StringRef &attr, UT_StringHolder *xform_type=nullptr, UT_StringHolder *xform_name=nullptr)
Functions for obtaining transform name, suffix, and type.
HUSD_API UT_StringHolder HUSDmakeRelationshipPath(const UT_StringRef &prim_path, const UT_StringRef &relationship_name)
HUSD_API UT_StringHolder HUSDgetXformSuffix(const UT_StringRef &xform_fullname)
Functions for obtaining transform name, suffix, and type.
HUSD_API bool HUSDgetXformTypeAndSuffix(HUSD_XformType &xform_type, UT_StringHolder &xform_namesuffix, const UT_StringRef &xform_fullname)
Functions for obtaining transform name, suffix, and type.
size_t hash_value(const HUSD_RenderKey &key)
Definition: HUSD_Utils.h:150
HUSD_API bool HUSDsplitCollectionPath(UT_StringHolder &prim_path, UT_StringHolder &collection_name, const UT_StringRef &collection_path)
HUSD_StripLayerResponse
Definition: HUSD_Utils.h:92
HUSD_API HUSD_TimeCode HUSDgetEffectiveTimeCode(const HUSD_TimeCode &timecode, HUSD_TimeSampling time_sampling)
Returns the time code at which to author an attribute value.
HUSD_API bool HUSDisTimeVarying(HUSD_TimeSampling time_sampling)
Returns true if there are more than one time samples.
GLuint const GLchar * name
Definition: glcorearb.h:786
HUSD_API std::pair< UT_StringHolder, UT_StringHolder > HUSDsplitPropertyPath(const UT_StringRef &property_path)
Returns the prim path and the property name, given the property path.
std::function< T > UT_Function
Definition: UT_Function.h:37
HUSD_API bool HUSDmakeValidUsdPathOrDefaultPrim(UT_String &path, bool addwarnings)
HUSD_API bool HUSDpartitionShadePrims(const HUSD_AutoAnyLock &anylock, const HUSD_PathSet &primpaths, UT_StringArray &shadeprimpaths, UT_StringArray &geoprimpaths, bool include_bound_materials=true, bool use_shader_for_mat_with_no_inputs=true)
GLdouble t
Definition: glad.h:2397
A map of string to various well defined value types.
Definition: UT_Options.h:84
HUSD_API UT_StringHolder HUSDmakeAttributePath(const UT_StringRef &prim_path, const UT_StringRef &attribute_name)
HUSD_API bool HUSDsplitLopStageIdentifier(const UT_StringRef &identifier, OP_Node *&lop, bool &split_layers, fpreal &t, UT_Options &opts)
fpreal64 fpreal
Definition: SYS_Types.h:277
UT_SharedPtr< HUSD_LockedStage > HUSD_LockedStagePtr
HUSD_API UT_StringHolder HUSDgetXformName(HUSD_XformType xform_type, const UT_StringRef &xform_namesuffix)
Functions for obtaining transform name, suffix, and type.
HUSD_AspectConformPolicy
Definition: HUSD_Utils.h:106
HUSD_XformAxisOrder
Enum of rotation order.
Definition: HUSD_Utils.h:301
HUSD_API void HUSDmodifyAssetPaths(const UT_StringHolder &path, const UT_Function< UT_StringHolder(UT_StringHolder)> &modifyFn, const UT_StringHolder &dest)
HUSD_PathSaveStyle
Definition: HUSD_Utils.h:64
HUSD_API UT_StringHolder HUSDgetPrimvarAttribName(const UT_StringRef &primvar)
Returns the attribute name of the given primvar.
HUSD_API bool HUSDapplyStripLayerResponse(HUSD_StripLayerResponse response)
HUSD_API HUSD_XformType HUSDgetXformType(const UT_StringRef &xform_fullname)
Functions for obtaining transform name, suffix, and type.
UT_Map< HUSD_RenderKey, UT_StringHolder > HUSD_RenderKeyPathMap
Definition: HUSD_Utils.h:159
HUSD_API bool HUSDisTimeSampled(HUSD_TimeSampling time_sampling)
Returns true if there is at least one time sample.
HUSD_API UT_StringHolder HUSDgetPrimTypeAlias(const UT_StringRef &primtype)
HUSD_API bool HUSDmakeUniqueUsdPath(UT_String &path, const HUSD_AutoAnyLock &lock, const UT_StringRef &suffix=UT_StringRef())
HUSD_API bool HUSDbumpPrimsForHydra(const HUSD_AutoWriteLock &writelock, const UT_StringArray &bump_primpaths)
Bump metadata on a USD primitive to force a hydra update.
HUSD_API UT_StringHolder HUSDgetValidUsdName(OP_Node &node)
HUSD_API UT_StringHolder HUSDgetAttribTypeName(const PI_EditScriptedParm &p)
Returns the string name of the Usd Sdf type best suited for the parameter.
HUSD_CustomProductAction
Definition: HUSD_Utils.h:123