|
Represents a payload and all its meta data. More...
#include <payload.h>
Public Member Functions | |
SDF_API | SdfPayload (const std::string &assetPath=std::string(), const SdfPath &primPath=SdfPath(), const SdfLayerOffset &layerOffset=SdfLayerOffset()) |
Create a payload. | |
const std::string & | GetAssetPath () const |
Returns the asset path of the layer that the payload uses. | |
void | SetAssetPath (const std::string &assetPath) |
Sets a new asset path for the layer the payload uses. | |
const SdfPath & | GetPrimPath () const |
Returns the scene path of the prim for the payload. | |
void | SetPrimPath (const SdfPath &primPath) |
Sets a new prim path for the prim that the payload uses. | |
const SdfLayerOffset & | GetLayerOffset () const |
Returns the layer offset associated with the payload. | |
void | SetLayerOffset (const SdfLayerOffset &layerOffset) |
Sets a new layer offset. | |
SDF_API bool | operator== (const SdfPayload &rhs) const |
Returns whether this payload equals rhs. | |
bool | operator!= (const SdfPayload &rhs) const |
SDF_API bool | operator< (const SdfPayload &rhs) const |
Returns whether this payload is less than rhs. | |
bool | operator> (const SdfPayload &rhs) const |
bool | operator<= (const SdfPayload &rhs) const |
bool | operator>= (const SdfPayload &rhs) const |
Friends | |
size_t | hash_value (const SdfPayload &p) |
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.
SDF_API SdfPayload | ( | const std::string & | assetPath = std::string() , |
const SdfPath & | primPath = SdfPath() , |
||
const SdfLayerOffset & | layerOffset = SdfLayerOffset() |
||
) |
Create a payload.
See SdfAssetPath for what characters are valid in assetPath
. If assetPath
contains invalid characters, issue an error and set this payload's asset path to the empty asset path.
|
inline |
|
inline |
|
inline |
|
inline |
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.
|
inline |
SDF_API bool operator== | ( | const SdfPayload & | rhs | ) | const |
Returns whether this payload equals rhs.
|
inline |
|
inline |
|
inline |
Sets a new asset path for the layer the payload uses.
See SdfAssetPath for what characters are valid in assetPath
. If assetPath
contains invalid characters, issue an error and set this payload's asset path to the empty asset path.
|
inline |
|
inline |
|
friend |