HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | Static Public Member Functions | List of all members
UsdImagingUsdPrimInfoSchema Class Reference

#include <usdPrimInfoSchema.h>

+ Inheritance diagram for UsdImagingUsdPrimInfoSchema:

Classes

class  Builder
 

Public Member Functions

 UsdImagingUsdPrimInfoSchema (HdContainerDataSourceHandle container)
 
USDIMAGING_API
HdPathDataSourceHandle 		GetNiPrototypePath ()
 
USDIMAGING_API
HdBoolDataSourceHandle 		GetIsNiPrototype ()
 
USDIMAGING_API
HdTokenDataSourceHandle 		GetSpecifier ()
 
USDIMAGING_API
HdContainerDataSourceHandle 		GetPiPropagatedPrototypes ()
 
USDIMAGING_API
HdBoolDataSourceHandle 		GetIsLoaded ()
 
- Public Member Functions inherited from HdSchema
 HdSchema (HdContainerDataSourceHandle container)
 
HD_API HdContainerDataSourceHandle GetContainer ()
 Returns the container data source that this schema is interpreting. More...
 
HD_API bool IsDefined () const
 
 operator bool () const
 

Static Public Member Functions

static USDIMAGING_API
HdContainerDataSourceHandle 		BuildRetained (const HdPathDataSourceHandle &niPrototypePath, const HdBoolDataSourceHandle &isNiPrototype, const HdTokenDataSourceHandle &specifier, const HdContainerDataSourceHandle &piPropagatedPrototypes, const HdBoolDataSourceHandle &isLoaded)
 
static USDIMAGING_API
UsdImagingUsdPrimInfoSchema 		GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
 
static USDIMAGING_API const
TfToken & 		GetSchemaToken ()
 
static USDIMAGING_API const
HdDataSourceLocator & 		GetDefaultLocator ()
 
static USDIMAGING_API const
HdDataSourceLocator & 		GetNiPrototypePathLocator ()
 

Additional Inherited Members

- Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle _GetTypedDataSource (TfToken name)
 
- Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle _container
 

Detailed Description

Definition at line 58 of file usdPrimInfoSchema.h.

Constructor & Destructor Documentation

UsdImagingUsdPrimInfoSchema::UsdImagingUsdPrimInfoSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 61 of file usdPrimInfoSchema.h.

Member Function Documentation

static USDIMAGING_API HdContainerDataSourceHandle UsdImagingUsdPrimInfoSchema::BuildRetained ( const HdPathDataSourceHandle &  niPrototypePath,
const HdBoolDataSourceHandle &  isNiPrototype,
const HdTokenDataSourceHandle &  specifier,
const HdContainerDataSourceHandle &  piPropagatedPrototypes,
const HdBoolDataSourceHandle &  isLoaded 
)
static

Builds a container data source which includes the provided child data sources. Parameters with nullptr values are excluded. This is a low-level interface. For cases in which it's desired to define the container with a sparse set of child fields, the Builder class is often more convenient and readable.

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdPrimInfoSchema::GetDefaultLocator ( )
static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the container representing this schema is found by default.

static USDIMAGING_API UsdImagingUsdPrimInfoSchema UsdImagingUsdPrimInfoSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer)
static

Retrieves a container data source with the schema's default name token "__usdPrimInfo" from the parent container and constructs a UsdImagingUsdPrimInfoSchema instance. Because the requested container data source may not exist, the result should be checked with IsDefined() or a bool comparison before use.

USDIMAGING_API HdBoolDataSourceHandle UsdImagingUsdPrimInfoSchema::GetIsLoaded ( )
USDIMAGING_API HdBoolDataSourceHandle UsdImagingUsdPrimInfoSchema::GetIsNiPrototype ( )
USDIMAGING_API HdPathDataSourceHandle UsdImagingUsdPrimInfoSchema::GetNiPrototypePath ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdPrimInfoSchema::GetNiPrototypePathLocator ( )
static

Returns an HdDataSourceLocator (relative to the prim-level data source) where the niprototypepath data source can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.

USDIMAGING_API HdContainerDataSourceHandle UsdImagingUsdPrimInfoSchema::GetPiPropagatedPrototypes ( )
static USDIMAGING_API const TfToken& UsdImagingUsdPrimInfoSchema::GetSchemaToken ( )
static

Returns a token where the container representing this schema is found in a container by default.

USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdPrimInfoSchema::GetSpecifier ( )
The documentation for this class was generated from the following file: