Filter Library Camera Interface Physics

CScanFilterClip Class Reference
[Clip Filter]

#include <ScanFilterClip.h>

Inheritance diagram for CScanFilterClip:

CScanFilter List of all members.

Detailed Description

Definition at line 67 of file ScanFilterClip.h.

Public Member Functions

 CScanFilterClip ()
virtual ~CScanFilterClip ()
virtual BOOL RunModeless (CWnd *pParentWnd, CDocument *pDoc)
 start filter dialog, allow for user input and perform filter operations; default implementation: return FALSE.
virtual BOOL Apply ()
 perform the filter operation without user interaction; also used to process series of buffers.
virtual void SetDragInput (BOOL bL2R, CRect rcIn)
 set the rectangular drag area for given L2R or R2L part of frame; override for filters that support dragging.
virtual BOOL NeedRectSelection () const
 default is to not require a rectangular) selection before applying filter; override if filter does require it.
virtual BOOL CanDoDialogEntry () const
 default is to support a dialog; override if filter does not support it.
virtual BOOL SetParameters (LPCTSTR lpParameters)
 set parameters for filter-script execution of filter; may throw _T("message").
virtual LPCTSTR GetParameters () const
 provode current filter parameter(s) for filter-scripting capture in the main application.

Static Public Attributes

static LPCTSTR m_lpcsFilterName
 the class filtername (orig.comment: saves memory (???mo) ).
static LPCTSTR m_lpcsShortFilterName
 the class short filtername.

Protected Member Functions

virtual void Serialize (CArchive &ar)
 set parameters for filter-script execution of filter; may throw _T("message").

Protected Attributes

CRect m_rcClipArea


Member Function Documentation

BOOL CScanFilterClip::SetParameters ( LPCTSTR  lpParameters  )  [virtual]

This method initializes the filter parameters for filter-script execution of the filter to the given parameters.

Parameters:
lpParameters a C-string specifying the filter parameter values, e.g. "1.23,4.56".
Returns:
TRUE (Success), FALSE (Failure)
Exceptions:
C-string if the filter does not support this operation, this method may throw _T("message");

Reimplemented from CScanFilter.

Definition at line 56 of file ScanFilterClip.cpp.

References m_rcClipArea, and Q_INVALID.

LPCTSTR CScanFilterClip::GetParameters (  )  const [virtual]

Analogous to GetInitParameters(), this method returns filter parameters, in this case for the filter-scripting capture operation in the main application.

Returns:
C-string with parameter values, e.g. "1.23,4.56"
See also:
GetInitParameters().
Note:
caller is responsible for delete-ing returned string storage.

Reimplemented from CScanFilter.

Definition at line 86 of file ScanFilterClip.cpp.

References m_rcClipArea.

void CScanFilterClip::Serialize ( CArchive &  ar  )  [protected, virtual]

This method initializes the filter parameters for filter-script execution of the filter toe the parameters specified.

Parameters:
lpParameters a C-string specifying the filter parameter values, e.g. "1.23,4.56".
Returns:
TRUE (Success), FALSE (Failure)
Exceptions:
C-string if the filter does not support this operation, this method may throw _T("message");

Reimplemented from CScanFilter.

Definition at line 46 of file ScanFilterClip.cpp.

References CScanFilter::Serialize().


The documentation for this class was generated from the following files:
Camera Filter Library documentation © 2004-2007 by Leiden Probe Microscopy