Filter Library

Camera

Interface Physics

ScanFilter.h

/*
 * ScanFilter.h - scan filter base class.
 *
 * This file is part of the Camera Filter Library.
 * Computer Aided Measurement Environment for Realtime Atomic imaging (Camera)
 *
 * Copyright (C) 2004, Leiden Probe Microscopy.
 * Copyright (C) 2004, Universiteit Leiden.
 *
 * Authors: M. Seynen (original), Martin J. Moene
 *
 * $Id: ScanFilter.h 382 2006-07-05 14:51:03Z moene $
 */

#ifndef CFILTLIB_SCANFILTER_H
#define CFILTLIB_SCANFILTER_H

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

/**
 * drag support type.
 */
enum _eDragSupportType
{
   SFDS_NONE = 0,       ///< no drag support
   SFDS_RECT,           ///< rectangular drag support
   SFDS_POINT           ///< point-wise drag support
};

/**
 * drag support type.
 */
typedef _eDragSupportType DragSupportType;

/**
 * Pi.
 */
const double g_PI = 3.1415926535897932384626433832795;

/**
 * two Pi.
 */
const double g_2PI = 2.0 * g_PI;

#define CAMERAFILTERFILE _T("Camera.CFiltLib")

/**
 * base class for filters.
 *
 * Class CScanFilter is the base clas for the filters of the Camera Filter Library.
 *
 * \version 3.2 IMPORTANT: order of members has changed; affects main application.
 */

class CScanFilter : public CObject
{
   /**
    * class CFilterDlg requires access to m_lpsbIn and m_lpsbOut; instead we
    * also could use GetInputBuffer(0) and GetOutputBuffer(0); 
    * \todo remove friend class CFilterDlg requirement.
    */
   friend class CFilterDlg;

public:
   /**
    * this type.
    */
   typedef short Self;

   /**
    * the class derived from.
    */
   typedef CObject Super;

   /**
    * the filter's size type.
    */
   typedef DWORD SizeType;

   ///
   /// \name Construction
   /// @{

   /**
    * default constructor.
    */
   CScanFilter();

   /**
    * destructor.
    */
   virtual ~CScanFilter();

   /// @}
   /// \name Predicates
   /// @{

   /**
    * default is to not support partial data; override if filter does support it.
    */
   virtual BOOL CanDoPartialData() const;

   /**
    * default is to support a dialog; override if filter does not support it.
    */
   virtual BOOL CanDoDialogEntry() const;

   /**
    * default is to not support dragging; override if filter does support it.
    */
   virtual DragSupportType SupportDragInput() const;

   /**
    * default is to not require a rectangular) selection before applying filter;
    * override if filter does require it.
    */
   virtual BOOL NeedRectSelection() const;

   /// @}
   /// \name Accessors
   /// @{

   /**
    * the name of this filter.
    */
   virtual LPCTSTR GetFilterName() const;

   /// @}
   /// \name Mutators
   /// @{

   /**
    * set the rectangular drag area for given L2R or R2L part of frame; override
    * for filters that support dragging.
    */
   virtual void SetDragInput( BOOL bL2R, CRect rcIn );

   /// @}
   /// \name Input Buffers
   /// @{

   /**
    * default is one input buffer; override of filter uses more.
    */
   virtual SizeType GetNrOfInBuffers() const;

   /**
    * provide the input buffer for the given index.
    */
   virtual CScanBaseBuffer* GetInputBuffer( UINT nNr );

   /**
    * set the input buffer for the given index.
    */
   virtual void SetInputBuffer( UINT nNr, CScanBaseBuffer* lpsbIn );

   /// @}
   /// \name Output Buffers
   /// @{

   /**
    * default is one output buffer; override of filter uses more.
    */
   virtual SizeType GetNrOfOutBuffers() const;

   /**
    * provide the output buffer for the given index.
    */
   virtual CScanBaseBuffer* GetOutputBuffer( UINT nNr );

   /**
    * set the output buffer for the given index.
    */
   virtual void SetOutputBuffer( UINT nNr, CScanBaseBuffer* lpsbOut );

   /// @}
   /// \name Filtering
   /// @{

   /**
    * true if a dialog is present.
    */
   virtual bool IsInteractive() const;

   /**
    * \brief configure filter with default setting or with settings as saved
    * from the last invocation (e.g. from registry).
    *
    * This method configures the filter with it's default values or, if available,
    * with the settings as saved from the last invocation.
    *
    * No filter configuration happens if the filter does not override this method.
    *
    * ReadFilterSettings() is usually called from the constructor of the filter.
    *
    * \version 3.2
    */
   virtual void ReadFilterSettings();

   /**
    * \brief save filter settings e.g. for use with the filterlist window
    * (e.g. via registry).
    *
    * WriteFilterSettings() is called from the filter dialog's OnOK message handler.
    *
    * \version 3.2
    */
   virtual void WriteFilterSettings() const;

   /**
    * provode current filter parameter(s) for filter-scripting capture
    * in the main application.
    *
    * Analogous to GetInitParameters(), this method returns filter parameters, in
    * this case for the filter-scripting capture operation in the main application.
    *
    * \return C-string with parameter values, e.g. "1.23,4.56"
    * \see GetInitParameters().
    * \note caller is responsible for \c delete-ing returned string storage.
    */
   virtual LPCTSTR GetParameters() const;

   /**
    * set parameters for filter-script execution of filter; may throw _T("message").
    *
    * This method initializes the filter parameters for filter-script execution of
    * the filter to the given parameters.
    *
    * \param lpParameters a C-string specifying the filter parameter values, e.g. "1.23,4.56".
    * \return TRUE (Success), FALSE (Failure)
    * \throw C-string if the filter does not support this operation, this method may throw _T("message");
    */
   virtual BOOL SetParameters( LPCTSTR lpParameters );

   /**
    * start filter dialog, allow for user input but do not perform filter operations;
    * default implementation: return FALSE.
    */
   virtual BOOL EditModeless( CWnd *pParentWnd );

   /**
    * start filter dialog, allow for user input and perform filter operations;
    * default implementation: return FALSE.
    */
   virtual BOOL RunModeless( CWnd *pParentWnd, CDocument *pDoc );

   /**
    * perform the filter operation without user interaction; also used to
    * process series of buffers.
    */
   virtual BOOL Apply();

   /// @} Filtering

protected:
   /**
    * set parameters for filter-script execution of filter; may throw _T("message").
    *
    * This method initializes the filter parameters for filter-script execution of
    * the filter toe the parameters specified.
    *
    * \param lpParameters a C-string specifying the filter parameter values, e.g. "1.23,4.56".
    * \return TRUE (Success), FALSE (Failure)
    * \throw C-string if the filter does not support this operation, this method may throw _T("message");
    */
   virtual void Serialize(CArchive &ar);

   /**
    * implement the serialization.
    */
   DECLARE_SERIAL(CScanFilter)

private:
   ///
   /// \name Prohibited
   /// @{

   /**
    * prevent copy-assignment; virtual destructor requires canonical form
    * \ref coplien_1991 "[Coplien]".
    */
   CScanFilter( const Self& rhs );

   /**
    * prevent assignment; virtual destructor requires canonical form
    * \ref coplien_1991 "[Coplien]".
    */
   Self& operator= ( const Self& rhs );

   /// @}

protected:
   /**
    * the filter dialog.
    */
   CDialog* m_pDlg;

   /**
    * FIXME: the filter view.
    */
   CView* m_pView;

   /**
    * the (first) input buffer.
    */
   CScanBaseBuffer *m_lpsbIn;

   /**
    * the (first) output buffer.
    */
   CScanBaseBuffer *m_lpsbOut;

   /**
    * the class filtername (orig.comment: saves memory (???mo) ).
    */
   static LPCTSTR m_lpcsFilterName;

   /**
    * the class short filtername.
    */
   static LPCTSTR m_lpcsShortFilterName;

   /**
    * the individual filtername.
    */
   LPCTSTR m_csFilterName;

   /**
    * a non-intersecting rectangle.
    */
   static const CRect NonIntersectingRect;
};

/* -----------------------------------------------------------------------
** inline methods:
*/

/* -----------------------------------------------------------------------
** other:
*/

/**
 * type to support the export of filters to from the FilterLib to the main program.
 */
struct _tFilterList
{
   BOOL           bHasEditModeless;     ///< the filter supports EditModeless dialog
   BOOL           bIsOnlineFilter;      ///< the filter can be used as an online filter
   BOOL           bIsViewingFilter;     ///< the filter can be used as a viewing filter
   BOOL           bIsInteractiveFilter; ///< include the filter in the filter menu
   LPCTSTR        lpcsFilterMenuName;   ///< the filter menu name
   LPCTSTR        lpcsFilterName;       ///< the filter name
   CRuntimeClass* lpRuntimeClass;       ///< the filter class
};

/**
 * the filter list type.
 */
typedef _tFilterList FilterListType;

/**
 * the product name.
 */
extern LPCTSTR GetFilterLibraryName();

/**
 * the product description.
 */
extern LPCTSTR GetFilterLibraryDescription();

/**
 * the product version string.
 */
extern LPCTSTR GetFilterLibraryVersionString();

/**
 * \deprecated replaced by GetTotalNumberOfFilters(); 
 * the number of available filters: all or filters with EditModeless capability only.
 */
extern int GetNumberOfFilters( BOOL bEditModelessFiltersOnly );

/**
 * \deprecated replaced by GetXXXFilters() for various XXX;
 * interface to main application to communicate about the available filters.
 */
extern BOOL GetScanDataFilters( DWORD& dwNrOfFilters, _tFilterList* lpList, BOOL bEditModelessFiltersOnly );

/**
 * the number of available filters: online, viewing and other filters.
 */
extern int GetTotalNumberOfFilters();

/**
 * the number of filters that implement EditModeless().
 */
extern int GetNumberOfEditModelessFilters();

/**
 * the number of online filters.
 */
extern int GetNumberOfOnlineFilters();

/**
 * the number of viewing filters.
 */
extern int GetNumberOfViewingFilters();

/**
 * the number of filters in the filter menu.
 */
extern int GetNumberOfInteractiveFilters();

/**
 * obtain all filters: online, viewing and other filters;
 * reports actual number of filters obtained in count.
 */
extern BOOL GetAllFilters( FilterListType* lpList, DWORD& count );

/**
 * obtain online filters;
 * reports actual number of filters obtained in count.
 */
extern BOOL GetEditModelessFilters( FilterListType* lpList, DWORD& count );

/**
 * obtain online filters;
 * reports actual number of filters obtained in count.
 */
extern BOOL GetOnlineFilters( FilterListType* lpList, DWORD& count );

/**
 * obtain viewing filters;
 * reports actual number of filters obtained in count.
 */
extern BOOL GetViewingFilters( FilterListType* lpList, DWORD& count );

/**
 * obtain interactive filters;
 * reports actual number of filters obtained in count.
 */
extern BOOL GetInteractiveFilters( FilterListType* lpList, DWORD& count );

/**
 * obtain an image shift calculator object.
 */
extern CRuntimeClass* GetImageShiftCalculator();

#endif // ifndef CFILTLIB_SCANFILTER_H

/*
 * end of file
 */

---