Loading...
Searching...
No Matches
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 PXR_USD_USD_UTILS_PIPELINE_H
25#define PXR_USD_USD_UTILS_PIPELINE_H
26
32
33#include "pxr/pxr.h"
34#include "pxr/usd/usdUtils/api.h"
36
38#include "pxr/base/tf/token.h"
40#include "pxr/usd/sdf/path.h"
41#include "pxr/usd/usd/common.h"
42
43PXR_NAMESPACE_OPEN_SCOPE
44
45SDF_DECLARE_HANDLES(SdfLayer);
46
47USDUTILS_API
48extern TfEnvSetting<bool> USD_FORCE_DEFAULT_MATERIALS_SCOPE_NAME;
49
53USDUTILS_API
55
59USDUTILS_API
60TfToken UsdUtilsGetModelNameFromRootLayer(const SdfLayerHandle& rootLayer);
61
107USDUTILS_API
108const std::set<UsdUtilsRegisteredVariantSet>& UsdUtilsGetRegisteredVariantSets();
109
113USDUTILS_API
115 const std::string& variantSetName,
117 selectionExportPolicy);
118
129USDUTILS_API
131 const SdfPath &path);
132
137USDUTILS_API
138UsdPrim UsdUtilsUninstancePrimAtPath(const UsdStagePtr &stage,
139 const SdfPath &path);
140
143USDUTILS_API
145
148USDUTILS_API
150
165USDUTILS_API
166TfToken UsdUtilsGetMaterialsScopeName(const bool forceDefault = false);
167
182USDUTILS_API
183TfToken UsdUtilsGetPrimaryCameraName(const bool forceDefault = false);
184
185PXR_NAMESPACE_CLOSE_SCOPE
186
187#endif
A scene description container that can combine with other such containers to form simple component as...
Definition: layer.h:100
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:291
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:88
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
Environment setting variable.
USDUTILS_API const TfToken & UsdUtilsGetPrefName()
Returns the name of the reference position used on meshes and nurbs.
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 void UsdUtilsRegisterVariantSet(const std::string &variantSetName, const UsdUtilsRegisteredVariantSet::SelectionExportPolicy &selectionExportPolicy)
Registers variantSetName with selectionExportPolicy.
USDUTILS_API TfToken UsdUtilsGetPrimaryCameraName(const bool forceDefault=false)
Get the name of the USD prim representing the primary camera.
USDUTILS_API const TfToken & UsdUtilsGetPrimaryUVSetName()
Returns the name of the primary UV set used on meshes and nurbs.
USDUTILS_API TfToken UsdUtilsGetModelNameFromRootLayer(const SdfLayerHandle &rootLayer)
Returns the model name associated with a given root layer.
USDUTILS_API TfToken UsdUtilsGetAlphaAttributeNameForColor(TfToken const &colorAttrName)
Define the shading pipeline's convention for naming a companion alpha/opacity attribute and primvarna...
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.
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...
SelectionExportPolicy
This specifies how the variantSet should be treated during export.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...