Available in LEADTOOLS Imaging Pro, Vector, Document, and Medical Imaging toolkits. |
#include "ltwrappr.h"
L_INT LBitmap::ZigZag(uAmplitude, uAttenuation, uFrequency, nPhase, CenterPt, crFill, uFlags)
L_UINT uAmplitude; |
/* wave's magnitude */ |
L_UINT uAttenuation; |
/* amplitude decay rate */ |
L_UINT uFrequency; |
/* number of repeated waves */ |
L_INT nPhase; |
/* wave phase shift */ |
POINT CenterPt; |
/* effect center */ |
COLORREF crFill; |
/* color value */ |
L_UINT uFlags; |
/* flags */ |
Radially distorts the bitmap by creating waves that twist the image around a specified center.
Parameter |
Description |
|
uAmplitude |
Non-zero value that represents the magnitude of the wave (amount of displacement), if ZG_RAD is set in the uFlags parameter. The valid range is from 1 100. |
|
uAttenuation |
Attenuation value. The attenuation value indicates how rapidly the wave amplitude decays as the wave travels along the radial line. The valid range is from 0 - 1000. |
|
uFrequency |
Number of times the waves repeat along the radial line. |
|
nPhase |
Wave phase shift, in hundredths of degrees. The valid range is from 36000 to 36000 (The value in degrees is nPhase divided by 100). |
|
CenterPt |
POINT structure that contains the center of the zigzag wave. |
|
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. |
|
uFlags |
Flags that indicate how to handle exposed areas, and the wave radiation type. You can use a bitwise OR (|) to specify one flag from each group. The following are the flags that indicate how to handle exposed areas: |
|
|
Value |
Meaning |
|
FILL_CLR |
[0x0000] Fill any exposed areas with crFill. |
|
FILL_RPT |
[0x0001] Stretch the image edges to fill the exposed area. |
|
FILL_NOCHG |
[0x0002] Leave the exposed area as is, without changing it. |
|
The following are the flags that indicate the wave radiation type: |
|
|
Value |
Meaning |
|
ZG_RAD |
[0x0000] Create distortion waves around the CenterPt. |
|
ZG_POND |
[0x0010] Create distortion waves that resemble the ripples in a pond. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
To create other zigzag forms refer to LBitmap::Ripple, LBitmap::ZoomWave and LBitmap::RadWave.
If the bitmap has a region, the effect will be applied on the region only.
This function supports 12- and 16-bit grayscale and 48- and 64-bit color images. Support for 12- and 16-bit grayscale and 48- and 64-bit color images is available only in the Document/Medical toolkits.
To update a status bar or detect a user interrupt during execution of this function, refer to LBase::EnableStatusCallback.
This function does not support signed data images. It returns the error code ERROR_SIGNED_DATA_NOT_SUPPORTED if a signed data image is passed to this function.
This function does not support 32-bit grayscale images. It returns the error code ERROR_GRAY32_UNSUPPORTED if a 32-bit grayscale image is passed to this function.
Required DLLs and Libraries
LTIMGSFX For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
Win32, x64.
See Also
Example
Apply ZigZag waves from the center of the image
#define MAKE_IMAGE_PATH(pFileName) TEXT("C:\\Users\\Public\\Documents\\LEADTOOLS Images\\")pFileName L_INT LBitmap__ZigZagExample(LBitmapWindow m_LBitmapWnd) { L_INT nRet; POINT CenterPt; LBitmap LeadBitmap; CenterPt.x = m_LBitmapWnd.GetWidth()/2; CenterPt.y = m_LBitmapWnd.GetHeight()/2; nRet = LeadBitmap.Load(MAKE_IMAGE_PATH(TEXT("IMAGE1.CMP")), 0,ORDER_BGR); if(nRet != SUCCESS) return nRet; nRet = LeadBitmap.ZigZag(50, 1000, 10, 0, CenterPt, 0, FILL_RPT | ZG_POND); if(nRet != SUCCESS) return nRet; return SUCCESS; }