UsdImagingUsdPrimInfoSchema Class Reference

#include <usdPrimInfoSchema.h>

Inheritance diagram for UsdImagingUsdPrimInfoSchema:

Classes
class	Builder

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

Static Public Member Functions
Schema location
static USDIMAGING_API const TfToken &	GetSchemaToken ()
static USDIMAGING_API const HdDataSourceLocator &	GetDefaultLocator ()
Data source locators for members
The following methods return an HdDataSourceLocator (relative to the prim-level data source) where the data source for a member can be found. This is often useful for checking intersection against the HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
static USDIMAGING_API const HdDataSourceLocator &	GetNiPrototypePathLocator ()
	Prim-level relative data source locator to locate niPrototypePath. More...
Schema construction
static USDIMAGING_API HdContainerDataSourceHandle	BuildRetained (const HdTokenDataSourceHandle &specifier, const HdTokenDataSourceHandle &typeName, const HdBoolDataSourceHandle &isLoaded, const HdTokenArrayDataSourceHandle &apiSchemas, const HdTokenDataSourceHandle &kind, const HdPathDataSourceHandle &niPrototypePath, const HdBoolDataSourceHandle &isNiPrototype, const HdContainerDataSourceHandle &piPropagatedPrototypes)
static USDIMAGING_API HdTokenDataSourceHandle	BuildSpecifierDataSource (const TfToken &specifier)

Schema retrieval
	UsdImagingUsdPrimInfoSchema (HdContainerDataSourceHandle container)
static USDIMAGING_API UsdImagingUsdPrimInfoSchema	GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)

Additional Inherited Members
Public Types inherited from HdSchema
using	UnderlyingDataSource = HdContainerDataSource
Protected Member Functions inherited from HdSchema
template<typename T >
T::Handle	_GetTypedDataSource (TfToken name) const
Protected Attributes inherited from HdSchema
HdContainerDataSourceHandle	_container

Detailed Description

Definition at line 55 of file usdPrimInfoSchema.h.

Constructor & Destructor Documentation

UsdImagingUsdPrimInfoSchema::UsdImagingUsdPrimInfoSchema ( HdContainerDataSourceHandle  container )

inline

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.

Definition at line 61 of file usdPrimInfoSchema.h.

Member Function Documentation

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

static

Deprecated:

Use Builder instead.

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 HdTokenDataSourceHandle UsdImagingUsdPrimInfoSchema::BuildSpecifierDataSource ( const TfToken &  specifier )

static

Returns token data source for use as specifier value.

The following values will be stored statically and reused for future calls:

• UsdImagingUsdPrimInfoSchemaTokens->def
• UsdImagingUsdPrimInfoSchemaTokens->over
• UsdImagingUsdPrimInfoSchemaTokens->class_

USDIMAGING_API HdTokenArrayDataSourceHandle UsdImagingUsdPrimInfoSchema::GetApiSchemas

(

)

const

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

(

)

const

USDIMAGING_API HdBoolDataSourceHandle UsdImagingUsdPrimInfoSchema::GetIsNiPrototype

(

)

const

USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdPrimInfoSchema::GetKind

(

)

const

USDIMAGING_API HdPathDataSourceHandle UsdImagingUsdPrimInfoSchema::GetNiPrototypePath

(

)

const

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdPrimInfoSchema::GetNiPrototypePathLocator ( )

static

Prim-level relative data source locator to locate niPrototypePath.

USDIMAGING_API HdContainerDataSourceHandle UsdImagingUsdPrimInfoSchema::GetPiPropagatedPrototypes

(

)

const

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

(

)

const

USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdPrimInfoSchema::GetTypeName

(

)

const

---

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

• pxr/usdImaging/usdImaging/usdPrimInfoSchema.h