Loading...
Searching...
No Matches
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"
18#include "pxr/usd/usdUtils/registeredVariantSet.h"
19
20#include "pxr/base/tf/envSetting.h"
21#include "pxr/base/tf/token.h"
22#include "pxr/usd/sdf/declareHandles.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
33USDUTILS_API
34extern TfEnvSetting<bool> USD_POPULATE_LEGACY_ALLOWED_TOKENS;
35
39USDUTILS_API
40TfToken UsdUtilsGetAlphaAttributeNameForColor(TfToken const &colorAttrName);
41
45USDUTILS_API
46TfToken UsdUtilsGetModelNameFromRootLayer(const SdfLayerHandle& rootLayer);
47
93USDUTILS_API
94const std::set<UsdUtilsRegisteredVariantSet>& UsdUtilsGetRegisteredVariantSets();
95
99USDUTILS_API
100void UsdUtilsRegisterVariantSet(
101 const std::string& variantSetName,
102 const UsdUtilsRegisteredVariantSet::SelectionExportPolicy&
103 selectionExportPolicy);
104
115USDUTILS_API
116UsdPrim UsdUtilsGetPrimAtPathWithForwarding(const UsdStagePtr &stage,
117 const SdfPath &path);
118
123USDUTILS_API
124UsdPrim UsdUtilsUninstancePrimAtPath(const UsdStagePtr &stage,
125 const SdfPath &path);
126
129USDUTILS_API
130const TfToken& UsdUtilsGetPrimaryUVSetName();
131
134USDUTILS_API
135const TfToken& UsdUtilsGetPrefName();
136
151USDUTILS_API
152TfToken UsdUtilsGetMaterialsScopeName(const bool forceDefault = false);
153
168USDUTILS_API
169TfToken UsdUtilsGetPrimaryCameraName(const bool forceDefault = false);
170
171PXR_NAMESPACE_CLOSE_SCOPE
172
173#endif
SdfLayer
A scene description container that can combine with other such containers to form simple component as...
Definition: layer.h:84
SdfPath
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
TfToken
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
UsdPrim
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
envSetting.h
Environment setting variable.
UsdUtilsGetPrefName
USDUTILS_API const TfToken & UsdUtilsGetPrefName()
Returns the name of the reference position used on meshes and nurbs.
UsdUtilsGetMaterialsScopeName
USDUTILS_API TfToken UsdUtilsGetMaterialsScopeName(const bool forceDefault=false)
Get the name of the USD prim under which materials are expected to be authored.
UsdUtilsRegisterVariantSet
USDUTILS_API void UsdUtilsRegisterVariantSet(const std::string &variantSetName, const UsdUtilsRegisteredVariantSet::SelectionExportPolicy &selectionExportPolicy)
Registers variantSetName with selectionExportPolicy.
UsdUtilsGetPrimaryCameraName
USDUTILS_API TfToken UsdUtilsGetPrimaryCameraName(const bool forceDefault=false)
Get the name of the USD prim representing the primary camera.
UsdUtilsGetPrimaryUVSetName
USDUTILS_API const TfToken & UsdUtilsGetPrimaryUVSetName()
Returns the name of the primary UV set used on meshes and nurbs.
UsdUtilsGetModelNameFromRootLayer
USDUTILS_API TfToken UsdUtilsGetModelNameFromRootLayer(const SdfLayerHandle &rootLayer)
Returns the model name associated with a given root layer.
UsdUtilsGetAlphaAttributeNameForColor
USDUTILS_API TfToken UsdUtilsGetAlphaAttributeNameForColor(TfToken const &colorAttrName)
Define the shading pipeline's convention for naming a companion alpha/opacity attribute and primvarna...
UsdUtilsGetPrimAtPathWithForwarding
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.
UsdUtilsGetRegisteredVariantSets
USDUTILS_API const std::set< UsdUtilsRegisteredVariantSet > & UsdUtilsGetRegisteredVariantSets()
Certain variant sets can be registered with the system.
UsdUtilsUninstancePrimAtPath
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...
UsdUtilsRegisteredVariantSet::SelectionExportPolicy
SelectionExportPolicy
This specifies how the variantSet should be treated during export.
Definition: registeredVariantSet.h:38
token.h
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...