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

#include <XUSD_RenderSettings.h>

+ Inheritance diagram for XUSD_RenderProduct:

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)
 
const TfTokenproductType () const
 
const TfTokenproductName () const
 
const UT_StringHolderoutputName () const
 
const RenderVarListvars () const
 
const_iterator begin () const
 
const_iterator end () const
 
bool expandProduct (const XUSD_RenderSettingsContext &opts, int frame)
 
bool collectAovs (TfTokenVector &aovs, HdAovDescriptorList &descs) const
 
const HdAovSettingsMapsettings () const
 User settings for this product. More...
 
void dump (UT_JSONWriter &w) const
 Print out the settings. More...
 

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_NonCopyableoperator= (const UT_NonCopyable &)=delete
 

Protected Attributes

HdAovSettingsMap mySettings
 
UT_StringHolder myFilename
 
UT_StringHolder myPartname
 
RenderVarList myVars
 

Detailed Description

Definition at line 161 of file XUSD_RenderSettings.h.

Member Typedef Documentation

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 187 of file XUSD_RenderSettings.h.

bool XUSD_RenderProduct::buildDefault ( const XUSD_RenderSettingsContext ctx)
bool XUSD_RenderProduct::collectAovs ( TfTokenVector aovs,
HdAovDescriptorList descs 
) const
void XUSD_RenderProduct::dump ( UT_JSONWriter w) const

Print out the settings.

const_iterator XUSD_RenderProduct::end ( void  ) const
inline

Definition at line 188 of file XUSD_RenderSettings.h.

bool XUSD_RenderProduct::expandProduct ( const XUSD_RenderSettingsContext opts,
int  frame 
)

Expand product name variables. Returns false if there are multiple frames, but no frame expansion.

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 206 of file XUSD_RenderSettings.h.

const UT_StringHolder& XUSD_RenderProduct::outputName ( ) const
inline

Definition at line 183 of file XUSD_RenderSettings.h.

const TfToken& XUSD_RenderProduct::productName ( ) const
const TfToken& XUSD_RenderProduct::productType ( ) const
bool XUSD_RenderProduct::resolveFrom ( const UsdStageRefPtr &  usd,
const UsdRenderProduct prim,
const XUSD_RenderSettingsContext ctx 
)
const HdAovSettingsMap& XUSD_RenderProduct::settings ( ) const
inline

User settings for this product.

Definition at line 199 of file XUSD_RenderSettings.h.

const RenderVarList& XUSD_RenderProduct::vars ( ) const
inline

Definition at line 185 of file XUSD_RenderSettings.h.

Member Data Documentation

UT_StringHolder XUSD_RenderProduct::myFilename
protected

Definition at line 213 of file XUSD_RenderSettings.h.

UT_StringHolder XUSD_RenderProduct::myPartname
protected

Definition at line 214 of file XUSD_RenderSettings.h.

HdAovSettingsMap XUSD_RenderProduct::mySettings
protected

Definition at line 212 of file XUSD_RenderSettings.h.

RenderVarList XUSD_RenderProduct::myVars
protected

Definition at line 215 of file XUSD_RenderSettings.h.


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