This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
siteUtils.h File Reference

Convenience API for working with SdfSite. More...

+ Include dependency graph for siteUtils.h:

Go to the source code of this file.

Functions

SdfSpecHandle SdfGetObjectAtPath (const SdfSite &site)
 
SdfPrimSpecHandle SdfGetPrimAtPath (const SdfSite &site)
 
SdfPropertySpecHandle SdfGetPropertyAtPath (const SdfSite &site)
 
bool SdfHasField (const SdfSite &site, const TfToken &field)
 
template<class T >
bool SdfHasField (const SdfSite &site, const TfToken &field, T *value)
 
const VtValue SdfGetField (const SdfSite &site, const TfToken &field)
 
template<class T >
SdfGetFieldAs (const SdfSite &site, const TfToken &field, const T &defaultValue=T())
 

Detailed Description

Convenience API for working with SdfSite.

These functions simply forward to the indicated functions on SdfLayer.

Definition in file siteUtils.h.

Function Documentation

◆ SdfGetField()

const VtValue SdfGetField ( const SdfSite site,
const TfToken field 
)
inline

Definition at line 62 of file siteUtils.h.

◆ SdfGetFieldAs()

T SdfGetFieldAs ( const SdfSite site,
const TfToken field,
const T &  defaultValue = T() 
)
inline

Definition at line 70 of file siteUtils.h.

◆ SdfGetObjectAtPath()

SdfSpecHandle SdfGetObjectAtPath ( const SdfSite site)
inline

Definition at line 27 of file siteUtils.h.

◆ SdfGetPrimAtPath()

SdfPrimSpecHandle SdfGetPrimAtPath ( const SdfSite site)
inline

Definition at line 34 of file siteUtils.h.

◆ SdfGetPropertyAtPath()

SdfPropertySpecHandle SdfGetPropertyAtPath ( const SdfSite site)
inline

Definition at line 41 of file siteUtils.h.

◆ SdfHasField() [1/2]

bool SdfHasField ( const SdfSite site,
const TfToken field 
)
inline

Definition at line 48 of file siteUtils.h.

◆ SdfHasField() [2/2]

bool SdfHasField ( const SdfSite site,
const TfToken field,
T *  value 
)
inline

Definition at line 55 of file siteUtils.h.