This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
pipeline.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef PXR_USD_USD_UTILS_PIPELINE_H
8#define PXR_USD_USD_UTILS_PIPELINE_H
9
15
16#include "pxr/pxr.h"
17#include "pxr/usd/usdUtils/api.h"
19
21#include "pxr/base/tf/token.h"
23#include "pxr/usd/sdf/path.h"
24#include "pxr/usd/usd/common.h"
25
26PXR_NAMESPACE_OPEN_SCOPE
27
28SDF_DECLARE_HANDLES(SdfLayer);
29
30USDUTILS_API
31extern TfEnvSetting<bool> USD_FORCE_DEFAULT_MATERIALS_SCOPE_NAME;
32
36USDUTILS_API
38
42USDUTILS_API
43TfToken UsdUtilsGetModelNameFromRootLayer(const SdfLayerHandle& rootLayer);
44
90USDUTILS_API
91const std::set<UsdUtilsRegisteredVariantSet>& UsdUtilsGetRegisteredVariantSets();
92
96USDUTILS_API
98 const std::string& variantSetName,
100 selectionExportPolicy);
101
112USDUTILS_API
114 const SdfPath &path);
115
120USDUTILS_API
121UsdPrim UsdUtilsUninstancePrimAtPath(const UsdStagePtr &stage,
122 const SdfPath &path);
123
126USDUTILS_API
128
131USDUTILS_API
133
148USDUTILS_API
149TfToken UsdUtilsGetMaterialsScopeName(const bool forceDefault = false);
150
165USDUTILS_API
166TfToken UsdUtilsGetPrimaryCameraName(const bool forceDefault = false);
167
168PXR_NAMESPACE_CLOSE_SCOPE
169
170#endif
A scene description container that can combine with other such containers to form simple component as...
Definition: layer.h:84
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
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...