Loading...
Searching...
No Matches
Public Member Functions | List of all members
UsdUtilsDependencyInfo Class Reference

Class containing information from a processed dependency. More...

#include <userProcessingFunc.h>

Public Member Functions

USDUTILS_API UsdUtilsDependencyInfo (const std::string &assetPath)
 
USDUTILS_API UsdUtilsDependencyInfo (const std::string &assetPath, const std::vector< std::string > &dependencies)
 
USDUTILS_API const std::string & GetAssetPath () const
 Returns the asset value path for the dependency.
 
USDUTILS_API const std::string & GetRawAssetPath () const
 Gets the raw asset path that was authored in the layer without any substitutions or evaluations.
 
USDUTILS_API const VtDictionary & GetExpressionVariables () const
 Gets the current set of variable expressions relevant to this dependency.
 
USDUTILS_API const std::vector< std::string > & GetDependencies () const
 Returns a list of dependencies related to the asset path.
 
bool operator== (const UsdUtilsDependencyInfo &rhs) const
 Equality: Asset path and dependencies are the same.
 
bool operator!= (const UsdUtilsDependencyInfo &rhs) const
 Inequality operator.
 

Detailed Description

Class containing information from a processed dependency.

A UsdUtilsDependencyInfo object is passed into the user processing function and contains relevant asset path and dependency information. Additionally, a UsdUtilsDependencyInfo object is also returned from the user processing function and communicates back to the asset localization routine any changes that were made during processing.

Definition at line 28 of file userProcessingFunc.h.

Constructor & Destructor Documentation

◆ UsdUtilsDependencyInfo() [1/2]

USDUTILS_API UsdUtilsDependencyInfo ( const std::string & assetPath)
inlineexplicit

Definition at line 31 of file userProcessingFunc.h.

◆ UsdUtilsDependencyInfo() [2/2]

USDUTILS_API UsdUtilsDependencyInfo ( const std::string & assetPath,
const std::vector< std::string > & dependencies )
inline

Definition at line 34 of file userProcessingFunc.h.

Member Function Documentation

◆ GetAssetPath()

USDUTILS_API const std::string & GetAssetPath ( ) const
inline

Returns the asset value path for the dependency.

The string returned by this function will contain the result of evaluating any variable expressions present in the asset path string.

When UsdUtilsDependencyInfo is returned as a parameter from a user processing function, the localization system compares the value with the value that was originally authored in the layer.

If the values are the same, no special action is taken and processing will continue as normal.

If the returned value is an empty string, the system will ignore this path as well as any dependencies associated with it.

If the returned value differs from what what was originally authored into the layer, the system will instead operate on the updated. value. If the updated path can be opened as a layer, it will be enqueued and searched for additional dependencies.

Note: A coding error will be issued if a user processing function attempts to modify an asset path contained in an existing package.

Definition at line 76 of file userProcessingFunc.h.

◆ GetDependencies()

USDUTILS_API const std::vector< std::string > & GetDependencies ( ) const
inline

Returns a list of dependencies related to the asset path.

Paths in this vector are specified relative to their containing layer. When passed into the user processing function, if this array is populated, then the asset path resolved to one or more values, such as in the case of UDIM tiles or clip asset path template strings.

When this structure is returned from a processing function, each path contained within will in turn be processed by the system. Any path that can be opened as a layer, will be enqueued and searched for additional dependencies.

Definition at line 105 of file userProcessingFunc.h.

◆ GetExpressionVariables()

USDUTILS_API const VtDictionary & GetExpressionVariables ( ) const
inline

Gets the current set of variable expressions relevant to this dependency.

This value is ignored when UsdUtilsDependencyInfo is returned from a callback function.

Definition at line 90 of file userProcessingFunc.h.

◆ GetRawAssetPath()

USDUTILS_API const std::string & GetRawAssetPath ( ) const
inline

Gets the raw asset path that was authored in the layer without any substitutions or evaluations.

This value is ignored when UsdUtilsDependencyInfo is returned from a callback functions.

Definition at line 83 of file userProcessingFunc.h.

◆ operator!=()

bool operator!= ( const UsdUtilsDependencyInfo & rhs) const
inline

Inequality operator.

See also
UsdUtilsDependencyInfo::operator==(const UsdUtilsDependencyInfo&)

Definition at line 117 of file userProcessingFunc.h.

◆ operator==()

bool operator== ( const UsdUtilsDependencyInfo & rhs) const
inline

Equality: Asset path and dependencies are the same.

Definition at line 110 of file userProcessingFunc.h.

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