HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
XUSD_RenderProduct Class Reference

#include <XUSD_RenderSettings.h>

+ Inheritance diagram for XUSD_RenderProduct:

Classes

struct  SettingOverride
 

Public Types

using RenderVarList = UT_Array< UT_UniquePtr< XUSD_RenderVar >>
 
using const_iterator = RenderVarList::const_iterator
 

Public Member Functions

 XUSD_RenderProduct ()
 
virtual ~XUSD_RenderProduct ()
 
bool loadFrom (const UsdStageRefPtr &usd, const UsdRenderProduct &prim, const XUSD_RenderSettingsContext &ctx)
 
bool resolveFrom (const UsdStageRefPtr &usd, const UsdRenderProduct &prim, const XUSD_RenderSettingsContext &ctx)
 
bool buildDefault (const XUSD_RenderSettingsContext &ctx)
 
bool buildDummyRaster (const XUSD_RenderSettingsContext &ctx, const XUSD_RenderProduct &src)
 
void updateSettings (const UsdStageRefPtr &use, const UsdRenderProduct &prim, const XUSD_RenderSettingsContext &ctx)
 
const TfToken & productType () const
 
TfToken productName (int frame=0) const
 
bool isRaster () const
 
const UT_StringHolder & outputName () const
 
const UT_StringHolder & fullOutputName () const
 
const RenderVarList & vars () const
 
const SdfPath & cameraPath () const
 
const_iterator begin () const
 
const_iterator end () const
 
bool expandProduct (const XUSD_RenderSettingsContext &opts, int product_index, int frame, UT_Set< UT_StringHolder > &other_products)
 
bool collectAovs (TfTokenVector &aovs, HdAovDescriptorList &descs) const
 
bool collectImageFilterLists (const UsdStageRefPtr &usd, UT_StringArray &paths, UT_Array< UsdPrim > &prims) const
 
const HdAovSettingsMap & settings () const
 User settings for this product. More...
 
void dump (UT_JSONWriter &w) const
 Print out the settings. More...
 
bool isDefault () const
 
void setIsDefault ()
 
bool cameraPath (SdfPath &val) const
 
bool shutter (GfVec2d &val) const
 
bool res (GfVec2i &val) const
 
bool pixelAspect (float &val) const
 
bool dataWindow (GfVec4f &val) const
 
bool disableMotionBlur (bool &val) const
 
bool disableDepthOfField (bool &val) const
 

Static Public Member Functions

static UT_StringHolder insertExtraBeforeExtension (const UT_StringHolder &filename, const char *extra, const char *path=nullptr)
 

Protected Member Functions

virtual UT_UniquePtr
< XUSD_RenderVar > 		newRenderVar () const
 If you have a sub-class of XUSD_RenderVar, you can create it here. More...
 
- Protected Member Functions inherited from UT_NonCopyableNS::UT_NonCopyable
 UT_NonCopyable ()=default
 
 ~UT_NonCopyable ()=default
 
 UT_NonCopyable (const UT_NonCopyable &)=delete
 
UT_NonCopyable & operator= (const UT_NonCopyable &)=delete
 

Protected Attributes

HdAovSettingsMap mySettings
 
SdfPath myCameraPath
 
UT_StringHolder myFilename
 
UT_StringHolder myFullFilename
 
UT_StringHolder myPartname
 
RenderVarList myVars
 
SettingOverride< GfVec2d > myShutter
 
SettingOverride< GfVec2i > myRes
 
SettingOverride< float > myPixelAspect
 
SettingOverride< GfVec4f > myDataWindowF
 
SettingOverride< bool > myInstantaneousShutter
 
SettingOverride< bool > myDisableMotionBlur
 
SettingOverride< bool > myDisableDepthOfField
 
bool myIsDefault
 
using ProductList = UT_Array< UT_UniquePtr< XUSD_RenderProduct >>
 
static bool specificRes (GfVec2i &val, const ProductList &products)
 
static bool specificPixelAspect (float &val, const ProductList &products)
 
static bool specificDataWindow (GfVec4f &val, const ProductList &products)
 
static bool specificDisableMotionBlur (bool &val, const ProductList &products)
 
static bool specificDisableDepthOfField (bool &val, const ProductList &products)
 

Detailed Description

Definition at line 202 of file XUSD_RenderSettings.h.

Member Typedef Documentation

using XUSD_RenderProduct::const_iterator = RenderVarList::const_iterator

Definition at line 207 of file XUSD_RenderSettings.h.

using XUSD_RenderProduct::ProductList = UT_Array<UT_UniquePtr<XUSD_RenderProduct>>

Test whether the product list has a specific value for the given attribute. If so, overwrite the value with the value of the product list. Note, all products must author the attribute and have the same value.

Definition at line 287 of file XUSD_RenderSettings.h.

using XUSD_RenderProduct::RenderVarList = UT_Array<UT_UniquePtr<XUSD_RenderVar>>

Definition at line 206 of file XUSD_RenderSettings.h.

Constructor & Destructor Documentation

XUSD_RenderProduct::XUSD_RenderProduct ( )
virtual XUSD_RenderProduct::~XUSD_RenderProduct ( )
virtual

Member Function Documentation

const_iterator XUSD_RenderProduct::begin ( void  ) const
inline

Definition at line 297 of file XUSD_RenderSettings.h.

bool XUSD_RenderProduct::buildDefault ( const XUSD_RenderSettingsContext &  ctx)
bool XUSD_RenderProduct::buildDummyRaster ( const XUSD_RenderSettingsContext &  ctx,
const XUSD_RenderProduct &  src 
)
bool XUSD_RenderProduct::cameraPath ( SdfPath &  val) const
inline

Definition at line 267 of file XUSD_RenderSettings.h.

const SdfPath& XUSD_RenderProduct::cameraPath ( ) const
inline

Definition at line 295 of file XUSD_RenderSettings.h.

bool XUSD_RenderProduct::collectAovs ( TfTokenVector &  aovs,
HdAovDescriptorList &  descs 
) const
bool XUSD_RenderProduct::collectImageFilterLists ( const UsdStageRefPtr &  usd,
UT_StringArray &  paths,
UT_Array< UsdPrim > &  prims 
) const
bool XUSD_RenderProduct::dataWindow ( GfVec4f &  val) const
inline

Definition at line 277 of file XUSD_RenderSettings.h.

bool XUSD_RenderProduct::disableDepthOfField ( bool &  val) const
bool XUSD_RenderProduct::disableMotionBlur ( bool &  val) const
void XUSD_RenderProduct::dump ( UT_JSONWriter &  w) const

Print out the settings.

const_iterator XUSD_RenderProduct::end ( void  ) const
inline

Definition at line 298 of file XUSD_RenderSettings.h.

bool XUSD_RenderProduct::expandProduct ( const XUSD_RenderSettingsContext &  opts,
int  product_index,
int  frame,
UT_Set< UT_StringHolder > &  other_products 
)

Expand product name variables. Returns false if there are multiple frames, but no frame expansion. The product_index is -1 for non-raster products or the offset into the list of raster products.

const UT_StringHolder& XUSD_RenderProduct::fullOutputName ( ) const
inline

Definition at line 235 of file XUSD_RenderSettings.h.

static UT_StringHolder XUSD_RenderProduct::insertExtraBeforeExtension ( const UT_StringHolder &  filename,
const char *  extra,
const char *  path = nullptr 
)
static

Create a "partial" filename by taking the original filename and inserting the extra string before the file suffix. If the path is not null, the path will be replaced.

bool XUSD_RenderProduct::isDefault ( ) const
inline

Definition at line 319 of file XUSD_RenderSettings.h.

bool XUSD_RenderProduct::isRaster ( ) const
bool XUSD_RenderProduct::loadFrom ( const UsdStageRefPtr &  usd,
const UsdRenderProduct &  prim,
const XUSD_RenderSettingsContext &  ctx 
)
virtual UT_UniquePtr<XUSD_RenderVar> XUSD_RenderProduct::newRenderVar ( ) const
inlineprotectedvirtual

If you have a sub-class of XUSD_RenderVar, you can create it here.

Definition at line 324 of file XUSD_RenderSettings.h.

const UT_StringHolder& XUSD_RenderProduct::outputName ( ) const
inline

Definition at line 232 of file XUSD_RenderSettings.h.

bool XUSD_RenderProduct::pixelAspect ( float &  val) const
inline

Definition at line 276 of file XUSD_RenderSettings.h.

TfToken XUSD_RenderProduct::productName ( int  frame = 0) const
const TfToken& XUSD_RenderProduct::productType ( ) const
bool XUSD_RenderProduct::res ( GfVec2i &  val) const
inline

Definition at line 275 of file XUSD_RenderSettings.h.

bool XUSD_RenderProduct::resolveFrom ( const UsdStageRefPtr &  usd,
const UsdRenderProduct &  prim,
const XUSD_RenderSettingsContext &  ctx 
)
void XUSD_RenderProduct::setIsDefault ( )
inline

Definition at line 320 of file XUSD_RenderSettings.h.

const HdAovSettingsMap& XUSD_RenderProduct::settings ( ) const
inline

User settings for this product.

Definition at line 314 of file XUSD_RenderSettings.h.

bool XUSD_RenderProduct::shutter ( GfVec2d &  val) const
inline

Definition at line 274 of file XUSD_RenderSettings.h.

static bool XUSD_RenderProduct::specificDataWindow ( GfVec4f &  val,
const ProductList &  products 
)
static

Test whether the product list has a specific value for the given attribute. If so, overwrite the value with the value of the product list. Note, all products must author the attribute and have the same value.

static bool XUSD_RenderProduct::specificDisableDepthOfField ( bool &  val,
const ProductList &  products 
)
static

Test whether the product list has a specific value for the given attribute. If so, overwrite the value with the value of the product list. Note, all products must author the attribute and have the same value.

static bool XUSD_RenderProduct::specificDisableMotionBlur ( bool &  val,
const ProductList &  products 
)
static

Test whether the product list has a specific value for the given attribute. If so, overwrite the value with the value of the product list. Note, all products must author the attribute and have the same value.

static bool XUSD_RenderProduct::specificPixelAspect ( float &  val,
const ProductList &  products 
)
static

Test whether the product list has a specific value for the given attribute. If so, overwrite the value with the value of the product list. Note, all products must author the attribute and have the same value.

static bool XUSD_RenderProduct::specificRes ( GfVec2i &  val,
const ProductList &  products 
)
static

Test whether the product list has a specific value for the given attribute. If so, overwrite the value with the value of the product list. Note, all products must author the attribute and have the same value.

void XUSD_RenderProduct::updateSettings ( const UsdStageRefPtr &  use,
const UsdRenderProduct &  prim,
const XUSD_RenderSettingsContext &  ctx 
)
const RenderVarList& XUSD_RenderProduct::vars ( ) const
inline

Definition at line 237 of file XUSD_RenderSettings.h.

Member Data Documentation

SdfPath XUSD_RenderProduct::myCameraPath
protected

Definition at line 331 of file XUSD_RenderSettings.h.

SettingOverride<GfVec4f> XUSD_RenderProduct::myDataWindowF
protected

Definition at line 341 of file XUSD_RenderSettings.h.

SettingOverride<bool> XUSD_RenderProduct::myDisableDepthOfField
protected

Definition at line 344 of file XUSD_RenderSettings.h.

SettingOverride<bool> XUSD_RenderProduct::myDisableMotionBlur
protected

Definition at line 343 of file XUSD_RenderSettings.h.

UT_StringHolder XUSD_RenderProduct::myFilename
protected

Definition at line 332 of file XUSD_RenderSettings.h.

UT_StringHolder XUSD_RenderProduct::myFullFilename
protected

Definition at line 333 of file XUSD_RenderSettings.h.

SettingOverride<bool> XUSD_RenderProduct::myInstantaneousShutter
protected

Definition at line 342 of file XUSD_RenderSettings.h.

bool XUSD_RenderProduct::myIsDefault
protected

Definition at line 345 of file XUSD_RenderSettings.h.

UT_StringHolder XUSD_RenderProduct::myPartname
protected

Definition at line 334 of file XUSD_RenderSettings.h.

SettingOverride<float> XUSD_RenderProduct::myPixelAspect
protected

Definition at line 340 of file XUSD_RenderSettings.h.

SettingOverride<GfVec2i> XUSD_RenderProduct::myRes
protected

Definition at line 339 of file XUSD_RenderSettings.h.

HdAovSettingsMap XUSD_RenderProduct::mySettings
protected

Definition at line 330 of file XUSD_RenderSettings.h.

SettingOverride<GfVec2d> XUSD_RenderProduct::myShutter
protected

Definition at line 338 of file XUSD_RenderSettings.h.

RenderVarList XUSD_RenderProduct::myVars
protected

Definition at line 335 of file XUSD_RenderSettings.h.

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