HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
XUSD_RenderSettingsContext Class Referenceabstract

#include <XUSD_RenderSettings.h>

+ Inheritance diagram for XUSD_RenderSettingsContext:

Public Member Functions

 XUSD_RenderSettingsContext ()
 
virtual ~XUSD_RenderSettingsContext ()
 
virtual void initFromUSD (UsdRenderSettings &settings)
 
virtual TfToken renderer () const =0
 Return the name of the render delegate. More...
 
virtual SdfPath overrideCamera () const
 Override the path to the camera. More...
 
virtual GfVec2i defaultResolution () const =0
 Return the default resolution for rendering products. More...
 
virtual GfVec2i overrideResolution (const GfVec2i &res) const
 Optionally override the resolution of the product. More...
 
virtual fpreal overridePixelAspect (fpreal pa) const
 Optionally, override the pixel aspect ratio. More...
 
virtual const char * overridePurpose () const
 Return if there's an overridden purpose for the render. More...
 
virtual const char * defaultPurpose () const
 Return the default purpose (this is a comma separated list) More...
 
virtual fpreal startFrame () const =0
 Start frame for a render sequence. More...
 
virtual fpreal frameInc () const
 Frame increment, when computing sequences. More...
 
virtual int frameCount () const
 Return the number of frames being rendered. More...
 
virtual UsdTimeCode evalTime () const =0
 Start frame for a render sequence. More...
 
virtual HdAovDescriptor defaultAovDescriptor (const TfToken &aov) const
 Get a default rendering descriptor for a given AOV. More...
 
virtual const char * defaultProductName () const
 Default product name. More...
 
virtual const char * overrideProductName () const
 Return a product name override. More...
 
virtual void setDefaultSettings (const XUSD_RenderSettings &rset, HdRenderSettingsMap &settings) const
 Build initial render settings map. More...
 
virtual void overrideSettings (const XUSD_RenderSettings &rset, HdRenderSettingsMap &settings) const
 After the products have been loaded, apply any overrides. More...
 
virtual bool allowCameraless () const
 Allow render options to be applied without a camera present. More...
 

Additional Inherited Members

- 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
 

Detailed Description

Definition at line 43 of file XUSD_RenderSettings.h.

Constructor & Destructor Documentation

XUSD_RenderSettingsContext::XUSD_RenderSettingsContext ( )
inline

Definition at line 47 of file XUSD_RenderSettings.h.

virtual XUSD_RenderSettingsContext::~XUSD_RenderSettingsContext ( )
virtual

Member Function Documentation

virtual bool XUSD_RenderSettingsContext::allowCameraless ( ) const
inlinevirtual

Allow render options to be applied without a camera present.

Definition at line 124 of file XUSD_RenderSettings.h.

virtual HdAovDescriptor XUSD_RenderSettingsContext::defaultAovDescriptor ( const TfToken aov) const
inlinevirtual

Get a default rendering descriptor for a given AOV.

Definition at line 102 of file XUSD_RenderSettings.h.

virtual const char* XUSD_RenderSettingsContext::defaultProductName ( ) const
inlinevirtual

Default product name.

Definition at line 108 of file XUSD_RenderSettings.h.

virtual const char* XUSD_RenderSettingsContext::defaultPurpose ( ) const
inlinevirtual

Return the default purpose (this is a comma separated list)

Definition at line 81 of file XUSD_RenderSettings.h.

virtual GfVec2i XUSD_RenderSettingsContext::defaultResolution ( ) const
pure virtual

Return the default resolution for rendering products.

virtual UsdTimeCode XUSD_RenderSettingsContext::evalTime ( ) const
pure virtual

Start frame for a render sequence.

virtual int XUSD_RenderSettingsContext::frameCount ( ) const
inlinevirtual

Return the number of frames being rendered.

Definition at line 96 of file XUSD_RenderSettings.h.

virtual fpreal XUSD_RenderSettingsContext::frameInc ( ) const
inlinevirtual

Frame increment, when computing sequences.

Definition at line 93 of file XUSD_RenderSettings.h.

virtual void XUSD_RenderSettingsContext::initFromUSD ( UsdRenderSettings settings)
inlinevirtual

Update any settings from the render settings primitive. This allows the context to look at custom attributes on the RenderSettings.

This function will always be called - even if there are no settings.

Definition at line 54 of file XUSD_RenderSettings.h.

virtual SdfPath XUSD_RenderSettingsContext::overrideCamera ( ) const
inlinevirtual

Override the path to the camera.

Definition at line 60 of file XUSD_RenderSettings.h.

virtual fpreal XUSD_RenderSettingsContext::overridePixelAspect ( fpreal  pa) const
inlinevirtual

Optionally, override the pixel aspect ratio.

Definition at line 75 of file XUSD_RenderSettings.h.

virtual const char* XUSD_RenderSettingsContext::overrideProductName ( ) const
inlinevirtual

Return a product name override.

Definition at line 111 of file XUSD_RenderSettings.h.

virtual const char* XUSD_RenderSettingsContext::overridePurpose ( ) const
inlinevirtual

Return if there's an overridden purpose for the render.

Definition at line 78 of file XUSD_RenderSettings.h.

virtual GfVec2i XUSD_RenderSettingsContext::overrideResolution ( const GfVec2i res) const
inlinevirtual

Optionally override the resolution of the product.

Definition at line 69 of file XUSD_RenderSettings.h.

virtual void XUSD_RenderSettingsContext::overrideSettings ( const XUSD_RenderSettings rset,
HdRenderSettingsMap settings 
) const
inlinevirtual

After the products have been loaded, apply any overrides.

Definition at line 119 of file XUSD_RenderSettings.h.

virtual TfToken XUSD_RenderSettingsContext::renderer ( ) const
pure virtual

Return the name of the render delegate.

virtual void XUSD_RenderSettingsContext::setDefaultSettings ( const XUSD_RenderSettings rset,
HdRenderSettingsMap settings 
) const
inlinevirtual

Build initial render settings map.

Definition at line 114 of file XUSD_RenderSettings.h.

virtual fpreal XUSD_RenderSettingsContext::startFrame ( ) const
pure virtual

Start frame for a render sequence.


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