All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
common.h File Reference
+ Include dependency graph for common.h:

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 }
 Specifies a position to add items to lists. More...
 
enum  UsdLoadPolicy { UsdLoadWithDescendants, UsdLoadWithoutDescendants }
 Controls UsdStage::Load() and UsdPrim::Load() behavior regarding whether or not descendant prims are loaded. More...
 
enum  UsdSchemaType {
  AbstractBase, AbstractTyped, ConcreteTyped, NonAppliedAPI,
  SingleApplyAPI, MultipleApplyAPI
}
 An enum representing which type of schema a given schema class belongs to. More...
 

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 &)
 
USD_API bool UsdUsesInverseLayerOffset ()
 Returns true if USD uses the historical behavior of applying the inverse of composed layer offsets to map layer time to stage time. More...
 
USD_API SdfLayerOffset UsdPrepLayerOffset (SdfLayerOffset offset)
 Prepare the given offset for application to map layer time to stage time, respecting the environment variable USD_USE_INVERSE_LAYER_OFFSET. More...
 

Enumeration Type Documentation

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 110 of file common.h.

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 138 of file common.h.

enum UsdSchemaType
strong

An enum representing which type of schema a given schema class belongs to.

Enumerator
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 149 of file common.h.

Function Documentation

USD_API std::string UsdDescribe ( const UsdObject )

Return a human-readable description.

USD_API std::string UsdDescribe ( const UsdStageRefPtr )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

USD_API std::string UsdDescribe ( const UsdStageWeakPtr &  )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

USD_API std::string UsdDescribe ( const UsdStage )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

USD_API std::string UsdDescribe ( const UsdStage )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

USD_API std::string UsdDescribe ( const UsdStageCache )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

USD_API SdfLayerOffset UsdPrepLayerOffset ( SdfLayerOffset  offset)

Prepare the given offset for application to map layer time to stage time, respecting the environment variable USD_USE_INVERSE_LAYER_OFFSET.

Typically, the supplied SdfLayerOffset will come from Pcp – in a PcpNodeRef or PcpLayerStack – and represent the cumulative offset to transform data from a layer to the Usd stage.

Historically, USD applied the inverse of that offset, flipping the intended semantics. To address this, this function provides a temporary measure to control whether to take the inverse or not. Under the new behavior this function will become a no-op, and can eventually be phased out.

USD_API bool UsdUsesInverseLayerOffset ( )

Returns true if USD uses the historical behavior of applying the inverse of composed layer offsets to map layer time to stage time.

Respects the env setting USD_USE_INVERSE_LAYER_OFFSET.