All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
common.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_COMMON_H
8#define PXR_USD_USD_COMMON_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usd/api.h"
17
18#include "pxr/usd/usd/primDataHandle.h"
19#include "pxr/usd/usd/timeCode.h"
20
21#include <string>
22#include <map>
23
24PXR_NAMESPACE_OPEN_SCOPE
25
26// Forward declare Usd classes.
27class UsdStage;
28class UsdObject;
29class UsdPrim;
30class UsdProperty;
31class UsdAttribute;
32class UsdRelationship;
33class UsdStageCache;
34
35class VtValue;
36
38typedef UsdStagePtr UsdStageWeakPtr;
39
41USD_API
42std::string UsdDescribe(const UsdObject &);
44USD_API
45std::string UsdDescribe(const UsdStageRefPtr &);
47USD_API
48std::string UsdDescribe(const UsdStageWeakPtr &);
50USD_API
51std::string UsdDescribe(const UsdStage *);
53USD_API
54std::string UsdDescribe(const UsdStage &);
56USD_API
57std::string UsdDescribe(const UsdStageCache &);
58
59// XXX:
60// Currently used for querying composed values from text layers, so VtValue is
61// the optimal value-store, but this may not always be the case.
62typedef std::map<class TfToken, VtValue,
64 > UsdMetadataValueMap;
65
92};
93
105
112enum class UsdSchemaKind {
114 Invalid,
130};
131
132PXR_NAMESPACE_CLOSE_SCOPE
133
134#endif
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:160
Base class for Usd scenegraph objects, providing common API.
Definition: object.h:115
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
Base class for UsdAttribute and UsdRelationship scenegraph objects.
Definition: property.h:38
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:111
A strongly concurrency safe collection of UsdStageRefPtr s, enabling sharing across multiple clients ...
Definition: stageCache.h:68
The outermost container for scene description, which owns and presents composed prims as a scenegraph...
Definition: stage.h:136
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:147
USD_API std::string UsdDescribe(const UsdObject &)
Return a human-readable description.
UsdListPosition
Specifies a position to add items to lists.
Definition: common.h:71
@ UsdListPositionFrontOfPrependList
The position at the front of the prepend list.
Definition: common.h:76
@ UsdListPositionBackOfPrependList
The position at the back of the prepend list.
Definition: common.h:81
@ UsdListPositionFrontOfAppendList
The position at the front of the append list.
Definition: common.h:86
@ UsdListPositionBackOfAppendList
The position at the back of the append list.
Definition: common.h:91
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:112
@ AbstractTyped
Represents a non-concrete typed schema.
@ AbstractBase
Represents abstract or base schema types that are interface-only and cannot be instantiated.
@ Invalid
Invalid or unknown schema kind.
@ MultipleApplyAPI
Multiple Apply API Schema.
@ SingleApplyAPI
Single Apply API schema.
@ ConcreteTyped
Represents a concrete typed schema.
@ NonAppliedAPI
Non-applied API schema.
UsdLoadPolicy
Controls UsdStage::Load() and UsdPrim::Load() behavior regarding whether or not descendant prims are ...
Definition: common.h:99
@ UsdLoadWithoutDescendants
Load a prim by itself with no descendants.
Definition: common.h:103
@ UsdLoadWithDescendants
Load a prim plus all its descendants.
Definition: common.h:101
Standard pointer typedefs.
#define TF_DECLARE_WEAK_AND_REF_PTRS(type)
Define standard weak, ref, and vector pointer types.
Definition: declarePtrs.h:72
Definitions of basic string utilities in tf.
Provides dictionary ordering binary predicate function on strings.
Definition: stringUtils.h:511