All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pipeline.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef USDUTILS_PIPELINE_H_
25 #define USDUTILS_PIPELINE_H_
26 
32 
33 #include "pxr/pxr.h"
34 #include "pxr/usd/usdUtils/api.h"
35 #include "pxr/usd/usdUtils/registeredVariantSet.h"
36 
37 #include "pxr/base/tf/envSetting.h"
38 #include "pxr/base/tf/token.h"
39 #include "pxr/usd/sdf/declareHandles.h"
40 #include "pxr/usd/sdf/path.h"
41 #include "pxr/usd/usd/common.h"
42 
43 
44 PXR_NAMESPACE_OPEN_SCOPE
45 
46 
47 SDF_DECLARE_HANDLES(SdfLayer);
48 
49 
50 USDUTILS_API
51 extern TfEnvSetting<bool> USD_FORCE_DEFAULT_MATERIALS_SCOPE_NAME;
52 
53 
57 USDUTILS_API
59 
63 USDUTILS_API
64 TfToken UsdUtilsGetModelNameFromRootLayer(const SdfLayerHandle& rootLayer);
65 
69 
92 USDUTILS_API
93 const std::set<UsdUtilsRegisteredVariantSet>& UsdUtilsGetRegisteredVariantSets();
94 
105 USDUTILS_API
106 UsdPrim UsdUtilsGetPrimAtPathWithForwarding(const UsdStagePtr &stage,
107  const SdfPath &path);
108 
113 USDUTILS_API
114 UsdPrim UsdUtilsUninstancePrimAtPath(const UsdStagePtr &stage,
115  const SdfPath &path);
116 
119 USDUTILS_API
121 
124 USDUTILS_API
126 
141 USDUTILS_API
142 TfToken UsdUtilsGetMaterialsScopeName(const bool forceDefault = false);
143 
158 USDUTILS_API
159 TfToken UsdUtilsGetPrimaryCameraName(const bool forceDefault = false);
160 
161 
162 PXR_NAMESPACE_CLOSE_SCOPE
163 
164 
165 #endif
A unit of scene description that you combine with other units of scene description to form a shot...
Definition: layer.h:93
USDUTILS_API TfToken UsdUtilsGetModelNameFromRootLayer(const SdfLayerHandle &rootLayer)
Returns the model name associated with a given root layer.
USDUTILS_API UsdPrim UsdUtilsGetPrimAtPathWithForwarding(const UsdStagePtr &stage, const SdfPath &path)
If a valid UsdPrim already exists at path on the USD stage stage, returns it.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
USDUTILS_API TfToken UsdUtilsGetPrimaryCameraName(const bool forceDefault=false)
Get the name of the USD prim representing the primary camera.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a &quot;Prim&quot; as ...
Definition: prim.h:131
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDUTILS_API TfToken UsdUtilsGetMaterialsScopeName(const bool forceDefault=false)
Get the name of the USD prim under which materials are expected to be authored.
USDUTILS_API const std::set< UsdUtilsRegisteredVariantSet > & UsdUtilsGetRegisteredVariantSets()
Certain variant sets can be registered with the system.
USDUTILS_API UsdPrim UsdUtilsUninstancePrimAtPath(const UsdStagePtr &stage, const SdfPath &path)
Given a path, uninstances all the instanced prims in the namespace chain and returns the resulting pr...
USDUTILS_API TfToken UsdUtilsGetPrimaryUVSetName()
Returns the name of the primary UV set used on meshes and nurbs.
USDUTILS_API TfToken UsdUtilsGetPrefName()
Returns the name of the reference position used on meshes and nurbs.
USDUTILS_API TfToken UsdUtilsGetAlphaAttributeNameForColor(TfToken const &colorAttrName)
Define the shading pipeline&#39;s convention for naming a companion alpha/opacity attribute and primvarna...