WAVESHEARDLGPARAMS

Summary

The WAVESHEARDLGPARAMS structure provides information used to initialize the dialog box created by the LDialogImageEffect::DoModalWaveShear function. After the user closes the dialog box, this structure is updated with information about the user's selections.

Syntax

typedef struct _WAVESHEARDLGPARAMS 
{ 
   L_UINT uStructSize; 
   pBITMAPHANDLE pBitmap; 
   L_BOOL bZoomToFit; 
   L_INT  * pAmplitudes; 
   L_UINT uAmplitudesCount; 
   L_UINT uScale; 
   COLORREF crFill; 
   L_UINT uWaveShearFlags; 
   L_UINT32 uDlgFlags; 
   LTCOMMDLGHELPCB pfnHelpCallback; 
   L_VOID  *pHelpCallBackUserData; 
} WAVESHEARDLGPARAMS,  * LPWAVESHEARDLGPARAMS; 

Members

uStructSize

Size of this structure, in bytes. Use the sizeof operator to calculate this value.

pBitmap

Pointer to the bitmap handle that references the bitmap used for preview or processing.

bZoomToFit

Flag that indicates the initial zoom level for previewing the image. Possible values are:

pAmplitudes

Array of integers that represent shear wave values. The valid value of each element in pAmplitudes array is between −1000 and 1000. These values are obtained through the Wave Shear Dialog; or, for image processing they may be obtained from the LBitmap::GetCurvePoints function. The toolkit will allocate this buffer for the user on function return. You should free this pointer using GlobalFree function unless you passed DLG_WAVESHEAR_AUTOPROCESS flag in the uDlgFlags field of this structure.

uAmplitudesCount

Number of entries in the pAmplitudes array.

uScale

Factor used to decrease the various amplitude values in the pAmplitudes array. Each value in the pAmplitudes array is multiplied by this factor. The real factor value is the uScale value divided by 100. Therefore, to multiply the amplitude values by 1.0, set this parameter to 100.The values range (1-100).

crFill

The COLORREF value that specifies the fill color for any exposed areas. You can specify a COLORREF value, such as the return value of the Windows RGB macro, or you can use the PALETTEINDEX macro to specify a palette color.

uWaveShearFlags

Flags that indicate how to handle exposed areas, and the direction of the shear wave. You can use a bit wise OR ( | ) to specify one flag from each group. Possible values are:

uDlgFlags

User interface flags for this dialog, which determine the layout and action of the dialog. Possible values are:

pfnHelpCallback

Ignored.

pHelpCallBackUserData

Ignored.

Usage

• LDialogImageEffect::GetWaveShearParams
• LDialogImageEffect::SetWaveShearParams