PictureEffectsRaw Xojo Plugin

ShapeDistortEffectRaw Class (console safe)

A class to do distort the shape of a image in a 4 corner polygon.



MPImageFilterRaw
   ShapeDistortEffectRaw

class ShapeDistortEffectRaw implements

IRawBitmapProcessor

Properties

AddAlphaChannel (console safe) If this property is set to true then alpha channel is added even if there was none in the source bitmap.
BackColor (console safe) Background color to fill to the sides of the distorted image.
HighQuality (console safe) If set to true then high quality interpolation is used (slower). If set to false then faster method is used which is good for preview for example.
PinnedSize (console safe) If set to true then the size of the destination image is same as size of the source image. corners stretched out of the image will get clipped off.
PolygonShape (console safe) A 4 point polygon that defines the pictures new shape. Note that if you got inward angles then you will sort of see under the image as if it was 3D object.
Canceled (Inherited) (console safe) If this one returns true then the effects execution was canceled by a Progress handler.
CPUCoreCount (Inherited) (console safe) Returns number of detected CPU cores on the running machine.
ErrorCode (Inherited) (console safe) Returns error code after applying the effect. This value is a Constant defined in the PictureEffectsRawError module.
MultiprocessingHint (Inherited) (console safe) Use this property to fine tune CPU usage for this algorithm. By default this property is set to zero (Automatic). This property accepts all constants that are defined in this class.
ProgressHandler (Inherited) (console safe) Use this property to use a progress class to get progress feedback from this function. This class must be a class that Implements the IProgressHandler Interface which is defined in this plugin.

Methods

Apply (console safe) Applies the effect on a RawBitmap image with parameters that have been set on the class instance.
Apply (console safe) Applies the effect on a RawBitmap image with parameters that have been set on the class instance, taking also the polygon as parameter.
MapPoint (console safe) Maps a point from a destination image of given size to location in the source image.

Constants

CPU_USE_MACHINE_CORE_COUNT = -1 (Inherited) Uses exactly the number of available CPU cores in the machine. (Available here means on-line CPU cores, some laptops can put CPU cores off line in low battery situations)
CPU_USE_AUTOMATIC = 0 (Inherited) Takes into account number of available CPU cores on the Machine and also tries to select the fastest way based on developer rating for each algorithm and picture size. (In simple algorithms then the fastest path is sometimes 2 or 3 CPU cores and not 4 CPU cores because of the overhead of managing multiple cores). In more complex algorithms then 3 or 4 cores are almost always faster than 2 cores.
CPU_USE_1_CORE = 1 (Inherited) Uses one CPU core.
CPU_USE_2_CORES = 2 (Inherited) Uses two CPU cores. This setting will also work on machines with less than two CPU cores, but it will be slower or best case same speed as using the correct setting for such machine.
CPU_USE_3_CORES = 3 (Inherited) Uses three CPU cores. This setting will also work on machines with less than three CPU cores, but it will be slower or best case same speed as using the correct setting for such machine.
CPU_USE_4_CORES = 4 (Inherited) Uses four CPU cores. This setting will also work on machines with less than four CPU cores, but it will be slower or best case same speed as using the correct setting for such machine.
CPU_USE_5_CORES = 5 (Inherited) Uses five CPU cores. This setting will also work on machines with less than four CPU cores, but it will be slower or best case same speed as using the correct setting for such machine.
CPU_USE_6_CORES = 6 (Inherited) Uses six CPU cores. This setting will also work on machines with less than four CPU cores, but it will be slower or best case same speed as using the correct setting for such machine.
CPU_USE_7_CORES = 7 (Inherited) Uses seven CPU cores. This setting will also work on machines with less than four CPU cores, but it will be slower or best case same speed as using the correct setting for such machine.
CPU_USE_8_CORES = 8 (Inherited) Uses eight CPU cores. This setting will also work on machines with less than four CPU cores, but it will be slower or best case same speed as using the correct setting for such machine.

Supported Platforms:

  • MacOS X Carbon
  • MacOS X Cocoa 32 bit
  • MacOS X Cocoa 64 bit
  • Windows 32 bit
  • Windows 64 bit
  • Linux 32 bit
  • Linux 64 bit
  • Linux ARM