All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SdfPayload Class Reference

Represents a payload and all its meta data. More...

Inherits totally_ordered< SdfPayload >.

Public Member Functions

SDF_API SdfPayload (const std::string &assetPath=std::string(), const SdfPath &primPath=SdfPath(), const SdfLayerOffset &layerOffset=SdfLayerOffset())
 Creates a payload. More...
 
const std::string & GetAssetPath () const
 Returns the asset path of the layer that the payload uses. More...
 
void SetAssetPath (const std::string &assetPath)
 Sets a new asset path for the layer the payload uses. More...
 
const SdfPathGetPrimPath () const
 Returns the scene path of the prim for the payload. More...
 
void SetPrimPath (const SdfPath &primPath)
 Sets a new prim path for the prim that the payload uses. More...
 
const SdfLayerOffsetGetLayerOffset () const
 Returns the layer offset associated with the payload. More...
 
void SetLayerOffset (const SdfLayerOffset &layerOffset)
 Sets a new layer offset. More...
 
SDF_API bool operator== (const SdfPayload &rhs) const
 Returns whether this payload equals rhs. More...
 
SDF_API bool operator< (const SdfPayload &rhs) const
 Returns whether this payload is less than rhs. More...
 

Friends

size_t hash_value (const SdfPayload &p)
 

Detailed Description

Represents a payload and all its meta data.

A payload represents a prim reference to an external layer. A payload is similar to a prim reference (see SdfReference) with the major difference that payloads are explicitly loaded by the user.

Unloaded payloads represent a boundary that lazy composition and system behaviors will not traverse across, providing a user-visible way to manage the working set of the scene.

Definition at line 59 of file payload.h.

Constructor & Destructor Documentation

SDF_API SdfPayload ( const std::string &  assetPath = std::string(),
const SdfPath primPath = SdfPath(),
const SdfLayerOffset layerOffset = SdfLayerOffset() 
)

Creates a payload.

Member Function Documentation

const std::string& GetAssetPath ( ) const
inline

Returns the asset path of the layer that the payload uses.

Definition at line 70 of file payload.h.

const SdfLayerOffset& GetLayerOffset ( ) const
inline

Returns the layer offset associated with the payload.

Definition at line 90 of file payload.h.

const SdfPath& GetPrimPath ( ) const
inline

Returns the scene path of the prim for the payload.

Definition at line 80 of file payload.h.

SDF_API bool operator< ( const SdfPayload rhs) const

Returns whether this payload is less than rhs.

The meaning of less than is arbitrary but stable.

SDF_API bool operator== ( const SdfPayload rhs) const

Returns whether this payload equals rhs.

void SetAssetPath ( const std::string &  assetPath)
inline

Sets a new asset path for the layer the payload uses.

Definition at line 75 of file payload.h.

void SetLayerOffset ( const SdfLayerOffset layerOffset)
inline

Sets a new layer offset.

Definition at line 95 of file payload.h.

void SetPrimPath ( const SdfPath primPath)
inline

Sets a new prim path for the prim that the payload uses.

Definition at line 85 of file payload.h.


The documentation for this class was generated from the following file: