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

#include <TIL_HuskDevice.h>

Classes

struct  Factory
 

Public Types

using TIL_HuskDevicePtr = UT_UniquePtr< TIL_HuskDevice >
 

Public Member Functions

 TIL_HuskDevice ()=default
 
virtual ~TIL_HuskDevice ()
 
 UT_NON_COPYABLE (TIL_HuskDevice)
 
virtual bool getMousePosition (UT_Vector2i &pos) const
 
virtual bool create (const IMG_Stat &stat, const IMG_FileParms &parms, const UT_Options &creation_options, const UT_Options &update_options, float display_scale, bool first_frame)=0
 
virtual void update (const UT_Array< PXL_Raster > &rasters, const UT_Array< int > &save_rasters, const IMG_Stat &stat, const IMG_FileParms &parms, const UT_Options &update_options, const UT_Array< UT_DimRect > &active_buckets)=0
 

Static Public Member Functions

static void setDefaultFactory (UT_UniquePtr< Factory > factory)
 Register the default factory. More...
 
static TIL_HuskDevicePtr createDefault ()
 Return the default device (may be a nullptr) More...
 

Detailed Description

Definition at line 34 of file TIL_HuskDevice.h.

Member Typedef Documentation

using TIL_HuskDevice::TIL_HuskDevicePtr = UT_UniquePtr<TIL_HuskDevice>

Definition at line 37 of file TIL_HuskDevice.h.

Constructor & Destructor Documentation

TIL_HuskDevice::TIL_HuskDevice ( )
default
virtual TIL_HuskDevice::~TIL_HuskDevice ( )
virtual

Member Function Documentation

virtual bool TIL_HuskDevice::create ( const IMG_Stat &  stat,
const IMG_FileParms &  parms,
const UT_Options &  creation_options,
const UT_Options &  update_options,
float  display_scale,
bool  first_frame 
)
pure virtual

Open a new device:

  • stat contains the AOVs for the image (and contains metadata)
  • parms contains additional file parameters
  • creation_options contains creation options (like the frame range, and mplay specific settings).
  • update_options is a list of optional parameters containing stats like percentDone or renderStage.
  • display_scale is a scale to apply to the display of the rasters. The scale will always be greater than 0 and less than or equal to 1.
  • first_frame is set to true when this is the first frame of a sequence (even if the sequence is on frame long).
static TIL_HuskDevicePtr TIL_HuskDevice::createDefault ( )
static

Return the default device (may be a nullptr)

virtual bool TIL_HuskDevice::getMousePosition ( UT_Vector2i &  pos) const
virtual

If supported, return the current pixel location where the user has clicked the mouse. husk can pass this through to the render delegate.

Returns false if not supported or if the position passed in is the same as the last click.

static void TIL_HuskDevice::setDefaultFactory ( UT_UniquePtr< Factory >  factory)
static

Register the default factory.

virtual void TIL_HuskDevice::update ( const UT_Array< PXL_Raster > &  rasters,
const UT_Array< int > &  save_rasters,
const IMG_Stat &  stat,
const IMG_FileParms &  parms,
const UT_Options &  update_options,
const UT_Array< UT_DimRect > &  active_buckets 
)
pure virtual

Update the display with the current rasters

  • stat contains the AOVs for the image (and contains metadata)
  • parms contains additional file parameters
  • update_options is a list of optional parameters containing dynamic stats like percentDone or renderStage.
  • rasters is the full list of rasters provided by the render delegate
  • save_rasters is an array of rasters which should be saved
  • active_buckets is a list of the active bucket regions that the renderer provides to husk.

Note that the rasters array may be larger than the number of AOVs defined in the IMG_Stat passed in the create call. The save_rasters array will have an entry for each AOV defined in the IMG_Stat. For example:

for (int i = 0, n = save_rasters.size(); i < n; ++i) {
PXL_Raster &rp = rasters[save_rasters[i]];
saveRaster(stat.getPlane(i), rp);
}
TIL_HuskDevice::UT_NON_COPYABLE ( TIL_HuskDevice  )
The documentation for this class was generated from the following file: