RenderOutput.h

Go to the documentation of this file.

/**<!-------------------------------------------------------------------->
   @class  RenderOutput
   @author Travis Fischer (fisch0920@gmail.com)
   @author Matthew Jacobs (jacobs.mh@gmail.com)
   @date   Fall 2008
   
   @brief
      Records point samples from a renderer which may be used to construct 
   an output image on a local or distributed machine
   <!-------------------------------------------------------------------->**/

#ifndef RENDER_OUTPUT_H_
#define RENDER_OUTPUT_H_

#include <utils/PropertyMap.h>
#include <core/Viewport.h>
#include <QMutex>

struct PointSample;

class RenderOutput : public PropertyMap {
   
   public:
      ///@name Constructors
      //@{-----------------------------------------------------------------
      
      inline RenderOutput(const Viewport &d)
         : PropertyMap(), m_viewport(d)
      { }
      
      inline RenderOutput()
         : PropertyMap(), m_viewport(480, 480)
      { }
      
      virtual ~RenderOutput()
      { }
      
      
      //@}-----------------------------------------------------------------
      ///@name Initialization
      //@{-----------------------------------------------------------------
      
      /**
       * @brief
       *    Performs any initialization which may be necessary before adding 
       * samples with 'addSample'
       * 
       * @note
       *    Default implementation initializes the viewport with the properties 
       * this RenderOutput has been assigned
       */
      virtual void init();
      
      /**
       * @brief
       *    Performs any post-processing on output after all samples have 
       * been collected (called after rendering is complete)
       * 
       * @note
       *    Default implementation is blank
       */
      virtual void finalize();
      
      
      //@}-----------------------------------------------------------------
      ///@name Main usage interface
      //@{-----------------------------------------------------------------
      
      /**
       * @brief
       *    Adds the given point sample, which is assumed to have been 
       * processed, to this output
       */
      virtual void addSample(const PointSample &sample);
      
      
      //@}-----------------------------------------------------------------
      ///@name Accessors / Mutators
      //@{-----------------------------------------------------------------
      
      inline const Viewport &getViewport() const {
         return m_viewport;
      }
      
      inline void setViewport(const Viewport &d) {
         m_viewport = d;
      }
      
      
      //@}-----------------------------------------------------------------
      
   protected:

      /**
       * @note default implementation does nothing
       */
      virtual void _addSample(const PointSample &sample);
      
   protected:
      /// Provides mutual exclusion to sample storage data structure(s)
      QMutex   m_mutex;
      
      Viewport m_viewport;
};

#endif // RENDER_OUTPUT_H_