#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/tf/stringUtils.h"
#include "pxr/usd/sdf/layerOffset.h"
#include "pxr/usd/usd/primDataHandle.h"
#include "pxr/usd/usd/timeCode.h"
#include <string>
#include <map>

Include dependency graph for common.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef UsdStagePtr	UsdStageWeakPtr

typedef std::map< class TfToken, VtValue, TfDictionaryLessThan >	UsdMetadataValueMap

Enumerations
enum	UsdListPosition { UsdListPositionFrontOfPrependList, UsdListPositionBackOfPrependList, UsdListPositionFrontOfAppendList, UsdListPositionBackOfAppendList }

enum	UsdLoadPolicy { UsdLoadWithDescendants, UsdLoadWithoutDescendants }

enum	UsdSchemaKind { UsdSchemaKind::Invalid, UsdSchemaKind::AbstractBase, UsdSchemaKind::AbstractTyped, UsdSchemaKind::ConcreteTyped, UsdSchemaKind::NonAppliedAPI, UsdSchemaKind::SingleApplyAPI, UsdSchemaKind::MultipleApplyAPI }

Functions
	TF_DECLARE_WEAK_AND_REF_PTRS (UsdStage)

USD_API std::string	UsdDescribe (const UsdObject &)
	Return a human-readable description. More...

USD_API std::string	UsdDescribe (const UsdStageRefPtr &)

USD_API std::string	UsdDescribe (const UsdStageWeakPtr &)

USD_API std::string	UsdDescribe (const UsdStage *)

USD_API std::string	UsdDescribe (const UsdStage &)

USD_API std::string	UsdDescribe (const UsdStageCache &)

Typedef Documentation

typedef std::map<class TfToken, VtValue, TfDictionaryLessThan > UsdMetadataValueMap

Definition at line 81 of file common.h.

typedef UsdStagePtr UsdStageWeakPtr

Definition at line 55 of file common.h.

Enumeration Type Documentation

enum UsdListPosition

Specifies a position to add items to lists. Used by some Add() methods in the USD API that manipulate lists, such as AddReference().

Enumerator
UsdListPositionFrontOfPrependList	The position at the front of the prepend list. An item added at this position will, after composition is applied, be stronger than other items prepended in this layer, and stronger than items added by weaker layers.
UsdListPositionBackOfPrependList	The position at the back of the prepend list. An item added at this position will, after composition is applied, be weaker than other items prepended in this layer, but stronger than items added by weaker layers.
UsdListPositionFrontOfAppendList	The position at the front of the append list. An item added at this position will, after composition is applied, be stronger than other items appended in this layer, and stronger than items added by weaker layers.
UsdListPositionBackOfAppendList	The position at the back of the append list. An item added at this position will, after composition is applied, be weaker than other items appended in this layer, but stronger than items added by weaker layers.

Definition at line 88 of file common.h.

enum UsdLoadPolicy

Controls UsdStage::Load() and UsdPrim::Load() behavior regarding whether or not descendant prims are loaded.

Enumerator
UsdLoadWithDescendants	Load a prim plus all its descendants.
UsdLoadWithoutDescendants	Load a prim by itself with no descendants.

Definition at line 116 of file common.h.

enum UsdSchemaKind

strong

An enum representing which kind of schema a given schema class belongs to. For more details on the different kinds of schemas, see Usd_Page_GeneratingSchemas.

Enumerator
Invalid	Invalid or unknown schema kind.
AbstractBase	Represents abstract or base schema types that are interface-only and cannot be instantiated. These are reserved for core base classes known to the usdGenSchema system, so this should never be assigned to generated schema classes.
AbstractTyped	Represents a non-concrete typed schema.
ConcreteTyped	Represents a concrete typed schema.
NonAppliedAPI	Non-applied API schema.
SingleApplyAPI	Single Apply API schema.
MultipleApplyAPI	Multiple Apply API Schema.

Definition at line 129 of file common.h.

Function Documentation

TF_DECLARE_WEAK_AND_REF_PTRS ( UsdStage )

USD_API std::string UsdDescribe ( const UsdObject & )

Return a human-readable description.

USD_API std::string UsdDescribe ( const UsdStageRefPtr & )