HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Member Functions | List of all members
HUSD_RenderSettingsContext Class Referenceabstract

#include <HUSD_RenderSettings.h>

+ Inheritance diagram for HUSD_RenderSettingsContext:

Classes

class  lookupSetting
 
class  storeProperty
 

Public Member Functions

 HUSD_RenderSettingsContext ()
 
virtual ~HUSD_RenderSettingsContext ()
 
virtual const HUSD_HuskEngine * huskEngine () const
 
virtual void initFromSettings (const lookupSetting &lookup)
 
virtual void setDefaultSettings (const HUSD_RenderSettings &settings, storeProperty &writer) const
 
virtual void overrideSettings (const HUSD_RenderSettings &settings, storeProperty &writer) const
 
virtual UT_StringHolder renderer () const =0
 
virtual UT_StringHolder overrideCamera () const
 
virtual const char * overrideSnapshotPath (const HUSD_RenderProduct &p, int raster_index) const
 
virtual const char * overrideSnapshotSuffix (const HUSD_RenderProduct &p, int raster_index) const
 Override the snapshot suffix (in husk) More...
 
virtual fpreal startFrame () const =0
 
virtual fpreal frameInc () const
 Frame increment, when computing sequences. More...
 
virtual int frameCount () const
 Return the number of frames being rendered. More...
 
virtual fpreal fps () const
 Return the FPS. More...
 
virtual const std::vector
< fpreal > * 		frameList () const
 Return a list of frames (if available) More...
 
virtual fpreal evalTime () const =0
 Current frame (when rendering a sequence) More...
 
virtual bool allowCameraless () const
 Allow render options to be applied without a camera present. More...
 
const
PXR_NS::XUSD_RenderSettingsContext & 		impl () const
 
PXR_NS::XUSD_RenderSettingsContext & impl ()
 
virtual const char * defaultProductName () const
 
virtual const char * overrideProductName (const HUSD_RenderProduct &p, int raster_index) const
 
virtual const char * defaultPurpose () const
 
virtual const char * overridePurpose () const
 
virtual UT_Vector2i defaultResolution () const =0
 
virtual UT_Vector2i overrideResolution (const UT_Vector2i &res) const
 
virtual UT_Vector4 overrideDataWindow (const UT_Vector4 &v) const
 
virtual fpreal overridePixelAspect (fpreal pa) const
 
virtual bool overrideDisableMotionBlur (bool is) const
 
virtual const char * tileSuffix () const
 
virtual int tileIndex () const
 

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

Detailed Description

Wrapper around XUSD_RenderSettings objects that has no dependencies on pxr libraries.

Definition at line 60 of file HUSD_RenderSettings.h.

Constructor & Destructor Documentation

HUSD_RenderSettingsContext::HUSD_RenderSettingsContext ( )
virtual HUSD_RenderSettingsContext::~HUSD_RenderSettingsContext ( )
virtual

Member Function Documentation

virtual bool HUSD_RenderSettingsContext::allowCameraless ( ) const
inlinevirtual

Allow render options to be applied without a camera present.

Definition at line 196 of file HUSD_RenderSettings.h.

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

Default & override product name. The raster_index is the offset into the list of ordered raster products. If the product is not a raster product, the product index is -1.

Definition at line 136 of file HUSD_RenderSettings.h.

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

Default & override render purpose

Definition at line 153 of file HUSD_RenderSettings.h.

virtual UT_Vector2i HUSD_RenderSettingsContext::defaultResolution ( ) const
pure virtual

Resolution, aspect ratio, data window and motion blur overrides

virtual fpreal HUSD_RenderSettingsContext::evalTime ( ) const
pure virtual

Current frame (when rendering a sequence)

virtual fpreal HUSD_RenderSettingsContext::fps ( ) const
inlinevirtual

Return the FPS.

Definition at line 188 of file HUSD_RenderSettings.h.

virtual int HUSD_RenderSettingsContext::frameCount ( ) const
inlinevirtual

Return the number of frames being rendered.

Definition at line 186 of file HUSD_RenderSettings.h.

virtual fpreal HUSD_RenderSettingsContext::frameInc ( ) const
inlinevirtual

Frame increment, when computing sequences.

Definition at line 184 of file HUSD_RenderSettings.h.

virtual const std::vector<fpreal>* HUSD_RenderSettingsContext::frameList ( ) const
inlinevirtual

Return a list of frames (if available)

Definition at line 190 of file HUSD_RenderSettings.h.

virtual const HUSD_HuskEngine* HUSD_RenderSettingsContext::huskEngine ( ) const
inlinevirtual

Definition at line 115 of file HUSD_RenderSettings.h.

const PXR_NS::XUSD_RenderSettingsContext& HUSD_RenderSettingsContext::impl ( ) const
inline

Definition at line 198 of file HUSD_RenderSettings.h.

PXR_NS::XUSD_RenderSettingsContext& HUSD_RenderSettingsContext::impl ( )
inline

Definition at line 199 of file HUSD_RenderSettings.h.

virtual void HUSD_RenderSettingsContext::initFromSettings ( const lookupSetting &  lookup)
inlinevirtual

Definition at line 118 of file HUSD_RenderSettings.h.

virtual UT_StringHolder HUSD_RenderSettingsContext::overrideCamera ( ) const
inlinevirtual

Definition at line 129 of file HUSD_RenderSettings.h.

virtual UT_Vector4 HUSD_RenderSettingsContext::overrideDataWindow ( const UT_Vector4 &  v) const
inlinevirtual

Resolution, aspect ratio, data window and motion blur overrides

Definition at line 166 of file HUSD_RenderSettings.h.

virtual bool HUSD_RenderSettingsContext::overrideDisableMotionBlur ( bool  is) const
inlinevirtual

Resolution, aspect ratio, data window and motion blur overrides

Definition at line 170 of file HUSD_RenderSettings.h.

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

Resolution, aspect ratio, data window and motion blur overrides

Definition at line 168 of file HUSD_RenderSettings.h.

virtual const char* HUSD_RenderSettingsContext::overrideProductName ( const HUSD_RenderProduct &  p,
int  raster_index 
) const
inlinevirtual

Default & override product name. The raster_index is the offset into the list of ordered raster products. If the product is not a raster product, the product index is -1.

Definition at line 137 of file HUSD_RenderSettings.h.

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

Default & override render purpose

Definition at line 158 of file HUSD_RenderSettings.h.

virtual UT_Vector2i HUSD_RenderSettingsContext::overrideResolution ( const UT_Vector2i &  res) const
inlinevirtual

Resolution, aspect ratio, data window and motion blur overrides

Definition at line 164 of file HUSD_RenderSettings.h.

virtual void HUSD_RenderSettingsContext::overrideSettings ( const HUSD_RenderSettings &  settings,
storeProperty &  writer 
) const
inlinevirtual

Definition at line 125 of file HUSD_RenderSettings.h.

virtual const char* HUSD_RenderSettingsContext::overrideSnapshotPath ( const HUSD_RenderProduct &  p,
int  raster_index 
) const
inlinevirtual

Default path for snapshots (in husk)

Definition at line 142 of file HUSD_RenderSettings.h.

virtual const char* HUSD_RenderSettingsContext::overrideSnapshotSuffix ( const HUSD_RenderProduct &  p,
int  raster_index 
) const
inlinevirtual

Override the snapshot suffix (in husk)

Definition at line 147 of file HUSD_RenderSettings.h.

virtual UT_StringHolder HUSD_RenderSettingsContext::renderer ( ) const
pure virtual
virtual void HUSD_RenderSettingsContext::setDefaultSettings ( const HUSD_RenderSettings &  settings,
storeProperty &  writer 
) const
inlinevirtual

Definition at line 121 of file HUSD_RenderSettings.h.

virtual fpreal HUSD_RenderSettingsContext::startFrame ( ) const
pure virtual
virtual int HUSD_RenderSettingsContext::tileIndex ( ) const
inlinevirtual

When composing an image with tiles, these options provide the image suffix and tile index

Definition at line 178 of file HUSD_RenderSettings.h.

virtual const char* HUSD_RenderSettingsContext::tileSuffix ( ) const
inlinevirtual

When composing an image with tiles, these options provide the image suffix and tile index

Definition at line 177 of file HUSD_RenderSettings.h.

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