HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdImagingUsdRenderSettingsSchema Class Reference

#include <usdRenderSettingsSchema.h>

+ Inheritance diagram for UsdImagingUsdRenderSettingsSchema:

Classes

class  Builder
 

Public Member Functions

 UsdImagingUsdRenderSettingsSchema (HdContainerDataSourceHandle container)
 
USDIMAGING_API
HdVec2iDataSourceHandle 
GetResolution ()
 
USDIMAGING_API
HdFloatDataSourceHandle 
GetPixelAspectRatio ()
 
USDIMAGING_API
HdTokenDataSourceHandle 
GetAspectRatioConformPolicy ()
 
USDIMAGING_API
HdVec4fDataSourceHandle 
GetDataWindowNDC ()
 
USDIMAGING_API
HdBoolDataSourceHandle 
GetDisableMotionBlur ()
 
USDIMAGING_API
HdPathDataSourceHandle 
GetCamera ()
 
USDIMAGING_API
HdTokenArrayDataSourceHandle 
GetIncludedPurposes ()
 
USDIMAGING_API
HdTokenArrayDataSourceHandle 
GetMaterialBindingPurposes ()
 
USDIMAGING_API
HdTokenDataSourceHandle 
GetRenderingColorSpace ()
 
USDIMAGING_API
HdPathArrayDataSourceHandle 
GetProducts ()
 
USDIMAGING_API
HdContainerDataSourceHandle 
GetNamespacedSettings ()
 
- 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 HdVec2iDataSourceHandle &resolution, const HdFloatDataSourceHandle &pixelAspectRatio, const HdTokenDataSourceHandle &aspectRatioConformPolicy, const HdVec4fDataSourceHandle &dataWindowNDC, const HdBoolDataSourceHandle &disableMotionBlur, const HdPathDataSourceHandle &camera, const HdTokenArrayDataSourceHandle &includedPurposes, const HdTokenArrayDataSourceHandle &materialBindingPurposes, const HdTokenDataSourceHandle &renderingColorSpace, const HdPathArrayDataSourceHandle &products, const HdContainerDataSourceHandle &namespacedSettings)
 
static USDIMAGING_API
UsdImagingUsdRenderSettingsSchema 
GetFromParent (const HdContainerDataSourceHandle &fromParentContainer)
 
static USDIMAGING_API const
TfToken
GetSchemaToken ()
 
static USDIMAGING_API const
HdDataSourceLocator
GetDefaultLocator ()
 
static USDIMAGING_API const
HdDataSourceLocator
GetResolutionLocator ()
 
static USDIMAGING_API const
HdDataSourceLocator
GetPixelAspectRatioLocator ()
 
static USDIMAGING_API const
HdDataSourceLocator
GetAspectRatioConformPolicyLocator ()
 
static USDIMAGING_API const
HdDataSourceLocator
GetDataWindowNDCLocator ()
 
static USDIMAGING_API const
HdDataSourceLocator
GetDisableMotionBlurLocator ()
 
static USDIMAGING_API const
HdDataSourceLocator
GetCameraLocator ()
 
static USDIMAGING_API const
HdDataSourceLocator
GetIncludedPurposesLocator ()
 
static USDIMAGING_API const
HdDataSourceLocator
GetMaterialBindingPurposesLocator ()
 
static USDIMAGING_API const
HdDataSourceLocator
GetRenderingColorSpaceLocator ()
 
static USDIMAGING_API const
HdDataSourceLocator
GetProductsLocator ()
 
static USDIMAGING_API const
HdDataSourceLocator
GetNamespacedSettingsLocator ()
 

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 61 of file usdRenderSettingsSchema.h.

Constructor & Destructor Documentation

UsdImagingUsdRenderSettingsSchema::UsdImagingUsdRenderSettingsSchema ( HdContainerDataSourceHandle  container)
inline

Definition at line 64 of file usdRenderSettingsSchema.h.

Member Function Documentation

static USDIMAGING_API HdContainerDataSourceHandle UsdImagingUsdRenderSettingsSchema::BuildRetained ( const HdVec2iDataSourceHandle resolution,
const HdFloatDataSourceHandle pixelAspectRatio,
const HdTokenDataSourceHandle aspectRatioConformPolicy,
const HdVec4fDataSourceHandle dataWindowNDC,
const HdBoolDataSourceHandle disableMotionBlur,
const HdPathDataSourceHandle camera,
const HdTokenArrayDataSourceHandle includedPurposes,
const HdTokenArrayDataSourceHandle materialBindingPurposes,
const HdTokenDataSourceHandle renderingColorSpace,
const HdPathArrayDataSourceHandle products,
const HdContainerDataSourceHandle &  namespacedSettings 
)
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.

USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetAspectRatioConformPolicy ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetAspectRatioConformPolicyLocator ( )
static

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

USDIMAGING_API HdPathDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetCamera ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetCameraLocator ( )
static

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

USDIMAGING_API HdVec4fDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetDataWindowNDC ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetDataWindowNDCLocator ( )
static

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

static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::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 UsdImagingUsdRenderSettingsSchema::GetDisableMotionBlur ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetDisableMotionBlurLocator ( )
static

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

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

Retrieves a container data source with the schema's default name token "__usdRenderSettings" from the parent container and constructs a UsdImagingUsdRenderSettingsSchema 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 HdTokenArrayDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetIncludedPurposes ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetIncludedPurposesLocator ( )
static

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

USDIMAGING_API HdTokenArrayDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetMaterialBindingPurposes ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetMaterialBindingPurposesLocator ( )
static

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

USDIMAGING_API HdContainerDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetNamespacedSettings ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetNamespacedSettingsLocator ( )
static

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

USDIMAGING_API HdFloatDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetPixelAspectRatio ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetPixelAspectRatioLocator ( )
static

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

USDIMAGING_API HdPathArrayDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetProducts ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetProductsLocator ( )
static

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

USDIMAGING_API HdTokenDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetRenderingColorSpace ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetRenderingColorSpaceLocator ( )
static

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

USDIMAGING_API HdVec2iDataSourceHandle UsdImagingUsdRenderSettingsSchema::GetResolution ( )
static USDIMAGING_API const HdDataSourceLocator& UsdImagingUsdRenderSettingsSchema::GetResolutionLocator ( )
static

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

static USDIMAGING_API const TfToken& UsdImagingUsdRenderSettingsSchema::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: