SdfPayload Class Reference

#include <payload.h>

Inheritance diagram for SdfPayload:

Public Member Functions
SDF_API	SdfPayload (const std::string &assetPath=std::string(), const SdfPath &primPath=SdfPath(), const SdfLayerOffset &layerOffset=SdfLayerOffset())
const std::string &	GetAssetPath () const
	Returns the asset path of the layer that the payload uses. More...
void	SetAssetPath (const std::string &assetPath)
const SdfPath &	GetPrimPath () 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 SdfLayerOffset &	GetLayerOffset () 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

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 60 of file payload.h.

Constructor & Destructor Documentation

SDF_API SdfPayload::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.

Member Function Documentation

const std::string& SdfPayload::GetAssetPath ( ) const

inline

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

Definition at line 73 of file payload.h.

const SdfLayerOffset& SdfPayload::GetLayerOffset ( ) const

inline

Returns the layer offset associated with the payload.

Definition at line 98 of file payload.h.

const SdfPath& SdfPayload::GetPrimPath ( ) const

inline

Returns the scene path of the prim for the payload.

Definition at line 88 of file payload.h.

SDF_API bool SdfPayload::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 SdfPayload::operator==

(

const SdfPayload &

rhs

)

const

Returns whether this payload equals rhs.

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

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.

Definition at line 81 of file payload.h.

void SdfPayload::SetLayerOffset ( const SdfLayerOffset &  layerOffset )

inline

Sets a new layer offset.

Definition at line 103 of file payload.h.

void SdfPayload::SetPrimPath ( const SdfPath &  primPath )

inline

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

Definition at line 93 of file payload.h.

Friends And Related Function Documentation

size_t hash_value ( const SdfPayload &  p )

friend

Definition at line 115 of file payload.h.

---

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

• pxr/usd/sdf/payload.h