ImageFilterDescriptor.h

Go to the documentation of this file.

/*
 * The information in this file is
 * Copyright(c) 2007 Ball Aerospace & Technologies Corporation
 * and is subject to the terms and conditions of the
 * GNU Lesser General Public License Version 2.1
 * The license text is available from   
 * http://www.gnu.org/licenses/lgpl.html
 */

#ifndef IMAGE_FILTER_DESCRIPTOR_H
#define IMAGE_FILTER_DESCRIPTOR_H

#include "EnumWrapper.h"
#include <string>
#include <vector>

class DataVariant;
class DynamicObject;

class GpuProgramDescriptor;

/**
 * Provides information on image filter.
 *
 * This class provides information on a specific image filter, which 
 * is implemented via Graphical Processor Unit (GPU) programs. It
 * provides the name, description, GPU programs, and parameters
 * for the image filter.
 *
 */
class ImageFilterDescriptor
{
public:
   /**
    * This type specifies how the shader program will be treated by the application.
    */
   enum ImageProcessTypeEnum
   {
      GPU_PROCESS,      /**< Generic process running on Gpu. */
      IMAGE_FILTER,     /**< Image filter process running on Gpu. */
      FEEDBACK_FILTER   /**< Recursive filter process running on Gpu. */
   };

   /**
   * @EnumWrapper ::ImageProcessTypeEnum.
   */
   typedef EnumWrapper<ImageProcessTypeEnum> ImageProcessType;

   /**
    *  Gets the name of the image filter.
    *
    *  @return   Name of the image filter.
    *           
    */
   virtual const std::string& getName() const = 0;

   /**
    *  Gets the description of the image filter.
    *
    *  @return  Description of the image filter.
    *
    */
   virtual const std::string& getDescription() const = 0;

   /**
    *  Gets the type of the image filter.
    *
    *  @return   Type of the image filter.
    */
   virtual ImageProcessType getType() const = 0;

   /**
    *  Queries for one of the image filter's GPU programs in the list.
    *
    *  @param   gpuDescriptor
    *           GPU Program descriptor.
    *
    *  @return  True if GPU program is in image filter descriptor list, 
    *           otherwise false.
    *
    *  @see     addGpuProgram()
    */
   virtual bool hasGpuProgram(const GpuProgramDescriptor& gpuDescriptor) const = 0;

   /**
    *  Gets the image filter's GPU programs list.
    *
    *  @return  The image filter's GPU programs.
    */
   virtual const std::vector<GpuProgramDescriptor*>& getGpuPrograms() const = 0;

   /**
    *  Sets the value of a parameter in this filter's parameter specification.
    *
    *  @param   name
    *           The name of the parameter to set.
    *  @param   value
    *           The new value of the parameter.
    *
    *  @return  Returns \c true if the parameter's value was set or \c false if
    *           the parameter does not exist.
    */
   virtual bool setParameter(const std::string& name, const DataVariant& value) = 0;

   /**
    *  Gets the value of a parameter in this filter's parameter specification.
    *
    *  @param   name
    *           The name of the parameter to get.
    *
    *  @return  The value of the parameter.  If the parameter does not exist,
    *           this will be an invalid DataVariant.
    */
   virtual const DataVariant& getParameter(const std::string& name) const = 0;

   /**
    *  Gets all the parameters and values in this filter's parameter
    *  specification.
    *
    *  @return  A DynamicObject containing the parameter names and values.
    */
   virtual const DynamicObject* getParameters() const = 0;

   /**
    *  Removes a parameter from this filter's parameter specification.
    *
    *  @param   name
    *           The name of the parameter to remove.
    *
    *  @return  Returns \c true if successful or \c false if the parameter does
    *           not exist.
    */
   virtual bool removeParameter(const std::string& name) = 0;

protected:
   /**
    * This is automatically destroyed by the application.
    */
   virtual ~ImageFilterDescriptor() {}
};

#endif