UsdImagingUsdRenderProductSchema Class Reference

#include <usdRenderProductSchema.h>

Inheritance diagram for UsdImagingUsdRenderProductSchema:

Classes
class	Builder

Public Member Functions
Member accessor
USDIMAGING_API HdVec2iDataSourceHandle	GetResolution () const
USDIMAGING_API HdFloatDataSourceHandle	GetPixelAspectRatio () const
USDIMAGING_API HdTokenDataSourceHandle	GetAspectRatioConformPolicy () const
USDIMAGING_API HdVec4fDataSourceHandle	GetDataWindowNDC () const
USDIMAGING_API HdBoolDataSourceHandle	GetDisableMotionBlur () const
USDIMAGING_API HdBoolDataSourceHandle	GetDisableDepthOfField () const
USDIMAGING_API HdPathDataSourceHandle	GetCamera () const
USDIMAGING_API HdTokenDataSourceHandle	GetProductType () const
USDIMAGING_API HdTokenDataSourceHandle	GetProductName () const
USDIMAGING_API HdPathArrayDataSourceHandle	GetOrderedVars () const
USDIMAGING_API HdContainerDataSourceHandle	GetNamespacedSettings () 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 &	GetNamespacedSettingsLocator ()
	Prim-level relative data source locator to locate namespacedSettings. More...
Schema construction
static USDIMAGING_API HdContainerDataSourceHandle	BuildRetained (const HdVec2iDataSourceHandle &resolution, const HdFloatDataSourceHandle &pixelAspectRatio, const HdTokenDataSourceHandle &aspectRatioConformPolicy, const HdVec4fDataSourceHandle &dataWindowNDC, const HdBoolDataSourceHandle &disableMotionBlur, const HdBoolDataSourceHandle &disableDepthOfField, const HdPathDataSourceHandle &camera, const HdTokenDataSourceHandle &productType, const HdTokenDataSourceHandle &productName, const HdPathArrayDataSourceHandle &orderedVars, const HdContainerDataSourceHandle &namespacedSettings)

Schema retrieval
	UsdImagingUsdRenderProductSchema (HdContainerDataSourceHandle container)
static USDIMAGING_API UsdImagingUsdRenderProductSchema	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 usdRenderProductSchema.h.

Constructor & Destructor Documentation

UsdImagingUsdRenderProductSchema::UsdImagingUsdRenderProductSchema ( HdContainerDataSourceHandle  container )

inline

Retrieves a container data source with the schema's default name token "__usdRenderProduct" from the parent container and constructs a UsdImagingUsdRenderProductSchema 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 usdRenderProductSchema.h.

Member Function Documentation

static USDIMAGING_API HdContainerDataSourceHandle UsdImagingUsdRenderProductSchema::BuildRetained ( const HdVec2iDataSourceHandle &  resolution, const HdFloatDataSourceHandle &  pixelAspectRatio, const HdTokenDataSourceHandle &  aspectRatioConformPolicy, const HdVec4fDataSourceHandle &  dataWindowNDC, const HdBoolDataSourceHandle &  disableMotionBlur, const HdBoolDataSourceHandle &  disableDepthOfField, const HdPathDataSourceHandle &  camera, const HdTokenDataSourceHandle &  productType, const HdTokenDataSourceHandle &  productName, const HdPathArrayDataSourceHandle &  orderedVars, const HdContainerDataSourceHandle &  namespacedSettings  )

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 HdTokenDataSourceHandle UsdImagingUsdRenderProductSchema::GetAspectRatioConformPolicy

(

)

const

USDIMAGING_API HdPathDataSourceHandle UsdImagingUsdRenderProductSchema::GetCamera

(

)

const

USDIMAGING_API HdVec4fDataSourceHandle UsdImagingUsdRenderProductSchema::GetDataWindowNDC

(

)

const

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderProductSchema::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 UsdImagingUsdRenderProductSchema::GetDisableDepthOfField

(

)

const

USDIMAGING_API HdBoolDataSourceHandle UsdImagingUsdRenderProductSchema::GetDisableMotionBlur

(

)

const

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

static

Retrieves a container data source with the schema's default name token "__usdRenderProduct" from the parent container and constructs a UsdImagingUsdRenderProductSchema 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 HdContainerDataSourceHandle UsdImagingUsdRenderProductSchema::GetNamespacedSettings

(

)

const

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderProductSchema::GetNamespacedSettingsLocator ( )

static

Prim-level relative data source locator to locate namespacedSettings.

USDIMAGING_API HdPathArrayDataSourceHandle UsdImagingUsdRenderProductSchema::GetOrderedVars

(

)

const

USDIMAGING_API HdFloatDataSourceHandle UsdImagingUsdRenderProductSchema::GetPixelAspectRatio

(

)

const

USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdRenderProductSchema::GetProductName

(

)

const

USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdRenderProductSchema::GetProductType

(

)

const

USDIMAGING_API HdVec2iDataSourceHandle UsdImagingUsdRenderProductSchema::GetResolution

(

)

const

static USDIMAGING_API const TfToken& UsdImagingUsdRenderProductSchema::GetSchemaToken ( )

static

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

---

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

• pxr/usdImaging/usdImaging/usdRenderProductSchema.h