UsdImagingUsdSceneIndexInputArgsSchema Class Reference

#include <usdSceneIndexInputArgsSchema.h>

Inheritance diagram for UsdImagingUsdSceneIndexInputArgsSchema:

Classes
class	Builder

Public Member Functions
Member accessor
USDIMAGING_API UsdStageRefPtrDataSourceHandle	GetStage () const
USDIMAGING_API HdBoolDataSourceHandle	GetIncludeUnloadedPrims () const
USDIMAGING_API HdBoolDataSourceHandle	GetDisplayUnloadedPrimsWithBounds () const
USDIMAGING_API HdBoolDataSourceHandle	GetAddDrawModeSceneIndex () 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 ()
Schema construction
static USDIMAGING_API HdContainerDataSourceHandle	BuildRetained (const UsdStageRefPtrDataSourceHandle &stage, const HdBoolDataSourceHandle &includeUnloadedPrims, const HdBoolDataSourceHandle &displayUnloadedPrimsWithBounds, const HdBoolDataSourceHandle &addDrawModeSceneIndex)

Schema retrieval
	UsdImagingUsdSceneIndexInputArgsSchema (HdContainerDataSourceHandle container)
static USDIMAGING_API UsdImagingUsdSceneIndexInputArgsSchema	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 53 of file usdSceneIndexInputArgsSchema.h.

Constructor & Destructor Documentation

UsdImagingUsdSceneIndexInputArgsSchema::UsdImagingUsdSceneIndexInputArgsSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "usdSceneIndex" from the parent container and constructs a UsdImagingUsdSceneIndexInputArgsSchema 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 59 of file usdSceneIndexInputArgsSchema.h.

Member Function Documentation

static USDIMAGING_API HdContainerDataSourceHandle UsdImagingUsdSceneIndexInputArgsSchema::BuildRetained ( const UsdStageRefPtrDataSourceHandle &  stage, const HdBoolDataSourceHandle &  includeUnloadedPrims, const HdBoolDataSourceHandle &  displayUnloadedPrimsWithBounds, const HdBoolDataSourceHandle &  addDrawModeSceneIndex  )

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.

USDIMAGING_API HdBoolDataSourceHandle UsdImagingUsdSceneIndexInputArgsSchema::GetAddDrawModeSceneIndex

(

)

const

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdSceneIndexInputArgsSchema::GetDefaultLocator ( )

static

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

USDIMAGING_API HdBoolDataSourceHandle UsdImagingUsdSceneIndexInputArgsSchema::GetDisplayUnloadedPrimsWithBounds

(

)

const

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

static

Retrieves a container data source with the schema's default name token "usdSceneIndex" from the parent container and constructs a UsdImagingUsdSceneIndexInputArgsSchema 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 UsdImagingUsdSceneIndexInputArgsSchema::GetIncludeUnloadedPrims

(

)

const

static USDIMAGING_API const TfToken& UsdImagingUsdSceneIndexInputArgsSchema::GetSchemaToken ( )

static

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

USDIMAGING_API UsdStageRefPtrDataSourceHandle UsdImagingUsdSceneIndexInputArgsSchema::GetStage

(

)

const

---

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

• pxr/usdImaging/usdImaging/usdSceneIndexInputArgsSchema.h