In This Topic ▼

LBitmap::FreePlaneBend

Summary

Wraps the bitmap onto a 3D plane shaped by puCurve.

Syntax

#include "ltwrappr.h"

virtual L_INT LBitmap::FreePlaneBend(puCurve, uCurveSize, uScale, crFill, uFlags)

Parameters

L_INT * puCurve

Array of integers that represent surface shape values. Valid values for each element in the puCurve array range between -1000 and 1000. Positive values mean the curve is concave in and negative values mean the curve is concave out. The values in this array are divided internally by 1000.

L_UINT uCurveSize

Size of the puCurve array.

L_UINT uScale

Factor used to multiply the various amplitude values in the puCurve array. Each value in the puCurve array is multiplied by this factor. For example, if you want to double the size of the amplitude values, use a uScale value of 2; to triple the amplitudes values, use a uScale value of 3, etc. The top practical limit for this parameter is the width and height of pBitmap.

COLORREF 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.

L_UINT uFlags

Flags that indicate how to handle exposed areas and the plane along which to stretch the pixels. You can use a bit wise 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 plane in which the stretching is to occur:

Value	Meaning
FPB_HORZ	[0x0010] Stretch the pixels along the vertical plane.
FPB_VERT	[0x0020] Stretch the pixels along the horizontal plane.
FPB_VRHZ	[0x0030] Stretch the pixels along the horizontal and vertical plane.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

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.

For an example, click here

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.

Free Plane Bend Function - Before

Free Plane Bend Function - After

View additional platform support for this Free Plane Bend 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.

Platforms

Win32, x64.

Example

L_INT LBitmap__FreePlaneBendExample(LAnimationWindow *BitmapWindow)  
{ 
   L_INT nRet; 
   POINT  apUserPoint [4];  
   L_INT  pnCurve[13];  
 
   /* Apply the filter*/ 
   apUserPoint [0].x = 0;  
   apUserPoint [0].y = 0;  
   apUserPoint [1].x = 3;  
   apUserPoint [1].y = 10;  
   apUserPoint [2].x = 9;  
   apUserPoint [2].y = -10;  
   apUserPoint [3].x = 12;  
   apUserPoint [3].y = 0;  
    
   nRet =LAnimationWindow::GetCurvePoints(pnCurve, apUserPoint, 4, NULL, GUB_LINEAR); 
   if(nRet !=SUCCESS) 
      return nRet; 
    
   nRet =BitmapWindow->FreePlaneBend(pnCurve, 13,200, RGB(255,0,0), FILL_CLR | FPB_VERT); 
   if(nRet !=SUCCESS) 
      return nRet; 
 
   return SUCCESS; 
}