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

#include <renderProductSchema.h>

+ Inheritance diagram for HdRenderProductSchema:

Classes

class  Builder
 

Public Member Functions

Member accessor
HD_API HdPathDataSourceHandle GetPath () const
 
HD_API HdTokenDataSourceHandle GetType () const
 
HD_API HdTokenDataSourceHandle GetName () const
 
HD_API HdVec2iDataSourceHandle GetResolution () const
 
HD_API HdRenderVarVectorSchema GetRenderVars () const
 
HD_API HdPathDataSourceHandle GetCameraPrim () const
 
HD_API HdFloatDataSourceHandle GetPixelAspectRatio () const
 
HD_API HdTokenDataSourceHandle GetAspectRatioConformPolicy () const
 
HD_API HdVec2fDataSourceHandle GetApertureSize () const
 
HD_API HdVec4fDataSourceHandle GetDataWindowNDC () const
 
HD_API HdBoolDataSourceHandle GetDisableMotionBlur () const
 
HD_API HdBoolDataSourceHandle GetDisableDepthOfField () const
 
HD_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 HD_API const TfToken & GetSchemaToken ()
 
static HD_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 HD_API const
HdDataSourceLocator & 		GetResolutionLocator ()
 Prim-level relative data source locator to locate resolution. More...
 
static HD_API const
HdDataSourceLocator & 		GetRenderVarsLocator ()
 Prim-level relative data source locator to locate renderVars. More...
 
static HD_API const
HdDataSourceLocator & 		GetNamespacedSettingsLocator ()
 Prim-level relative data source locator to locate namespacedSettings. More...
 
Schema construction
static HD_API
HdContainerDataSourceHandle 		BuildRetained (const HdPathDataSourceHandle &path, const HdTokenDataSourceHandle &type, const HdTokenDataSourceHandle &name, const HdVec2iDataSourceHandle &resolution, const HdVectorDataSourceHandle &renderVars, const HdPathDataSourceHandle &cameraPrim, const HdFloatDataSourceHandle &pixelAspectRatio, const HdTokenDataSourceHandle &aspectRatioConformPolicy, const HdVec2fDataSourceHandle &apertureSize, const HdVec4fDataSourceHandle &dataWindowNDC, const HdBoolDataSourceHandle &disableMotionBlur, const HdBoolDataSourceHandle &disableDepthOfField, const HdContainerDataSourceHandle &namespacedSettings)
 

Schema retrieval

 HdRenderProductSchema (HdContainerDataSourceHandle container)
 
static HD_API HdRenderProductSchema 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 61 of file renderProductSchema.h.

Constructor & Destructor Documentation

HdRenderProductSchema::HdRenderProductSchema ( HdContainerDataSourceHandle  container)
inline

Retrieves a container data source with the schema's default name token "renderProduct" from the parent container and constructs a HdRenderProductSchema 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 67 of file renderProductSchema.h.

Member Function Documentation

static HD_API HdContainerDataSourceHandle HdRenderProductSchema::BuildRetained ( const HdPathDataSourceHandle &  path,
const HdTokenDataSourceHandle &  type,
const HdTokenDataSourceHandle &  name,
const HdVec2iDataSourceHandle &  resolution,
const HdVectorDataSourceHandle &  renderVars,
const HdPathDataSourceHandle &  cameraPrim,
const HdFloatDataSourceHandle &  pixelAspectRatio,
const HdTokenDataSourceHandle &  aspectRatioConformPolicy,
const HdVec2fDataSourceHandle &  apertureSize,
const HdVec4fDataSourceHandle &  dataWindowNDC,
const HdBoolDataSourceHandle &  disableMotionBlur,
const HdBoolDataSourceHandle &  disableDepthOfField,
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.

HD_API HdVec2fDataSourceHandle HdRenderProductSchema::GetApertureSize ( ) const
HD_API HdTokenDataSourceHandle HdRenderProductSchema::GetAspectRatioConformPolicy ( ) const
HD_API HdPathDataSourceHandle HdRenderProductSchema::GetCameraPrim ( ) const
HD_API HdVec4fDataSourceHandle HdRenderProductSchema::GetDataWindowNDC ( ) const
static HD_API const HdDataSourceLocator& HdRenderProductSchema::GetDefaultLocator ( )
static

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

HD_API HdBoolDataSourceHandle HdRenderProductSchema::GetDisableDepthOfField ( ) const
HD_API HdBoolDataSourceHandle HdRenderProductSchema::GetDisableMotionBlur ( ) const
static HD_API HdRenderProductSchema HdRenderProductSchema::GetFromParent ( const HdContainerDataSourceHandle &  fromParentContainer)
static

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

HD_API HdTokenDataSourceHandle HdRenderProductSchema::GetName ( ) const
HD_API HdContainerDataSourceHandle HdRenderProductSchema::GetNamespacedSettings ( ) const
static HD_API const HdDataSourceLocator& HdRenderProductSchema::GetNamespacedSettingsLocator ( )
static

Prim-level relative data source locator to locate namespacedSettings.

HD_API HdPathDataSourceHandle HdRenderProductSchema::GetPath ( ) const
HD_API HdFloatDataSourceHandle HdRenderProductSchema::GetPixelAspectRatio ( ) const
HD_API HdRenderVarVectorSchema HdRenderProductSchema::GetRenderVars ( ) const
static HD_API const HdDataSourceLocator& HdRenderProductSchema::GetRenderVarsLocator ( )
static

Prim-level relative data source locator to locate renderVars.

HD_API HdVec2iDataSourceHandle HdRenderProductSchema::GetResolution ( ) const
static HD_API const HdDataSourceLocator& HdRenderProductSchema::GetResolutionLocator ( )
static

Prim-level relative data source locator to locate resolution.

static HD_API const TfToken& HdRenderProductSchema::GetSchemaToken ( )
static

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

HD_API HdTokenDataSourceHandle HdRenderProductSchema::GetType ( ) const
The documentation for this class was generated from the following file: