PictureEffectsRaw Xojo Plugin

PageCurlRaw Class (console safe)

A class to do Page Curl effect on RawBitmap images.

This page curl implementation is relatively low quality and has little potential for improvement but was brought back from the older PictureEffects plugin by popular demand.

Supports:
  • 8 bit per channel bitmaps

  • RGB color spaces


    • This class supports using threading and Async operation but only supports one CPU core at a time.

    MPImageFilterRaw
       PageCurlRaw

    class PageCurlRaw implements

    IRawBitmapProcessor

    IRawBitmapProcessorAsync

    Properties

    AsyncCompleted (Inherited) (console safe) Returns true if asynchronous execution has completed, else false.
    AsyncResult (Inherited) (console safe) Returns the result bitmap of asynchronous execution.
    AutomaticCurlBackShading (console safe) Set this property too false to enable manual setting for the CurlBackShadingLightness.
    BackColor (console safe) Use this property to set the background color of the curl.
    BackgroundBitmap (console safe) Use this property to make alternate image then the source replace the area where the image has been curled away.
    CPUCoreCount (Inherited) (console safe) Returns number of detected CPU cores on the running machine.
    Canceled (Inherited) (console safe) If this one returns true then the effects execution was canceled by a Progress handler.
    CornerNumber (console safe) Sets or gets the corner number to apply the curl too.
    CurlBackShadingLightness (console safe) Sets or gets the lightness of the back shading for the curl.
    CurlColor (console safe) Use this property to set the color of the curl.
    ErrorCode (Inherited) (console safe) Returns error code after applying the effect. This value is a Constant defined in the PictureEffectsRawError module.
    ForceThreads (Inherited) (console safe) Forces use of thread when set to true even when using only one CPU core.
    Horizontal (console safe) This property is used to make the curl horizontal.
    Mask (console safe) Sets mask for the operation if masking is wanted.
    MaximumCPUCores (Inherited) (console safe) Read only property where each effect can report maximum CPU cores it supports.
    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.
    Opacity (console safe) Defines the opacity value of the curl.
    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.
    Selection (console safe) Defines the curl area.
    UseOriginalBackground (console safe) Use this property to make the same image as the source replace the area where the image has been curled away.

    Methods

    Apply (console safe) Applies the effect on a RawBitmap image with parameters that have been set on the class instance.
    ApplyAsync (console safe) Applies the effect asynchronously on a RawBitmap image with parameters that have been set on the class instance.
    Cancel (Inherited) (console safe) Cancels processing and waits for threads to come to full stop when in asynchronous execution.

    Constants

    CPU_USE_MACHINE_CORE_COUNT = -1 (Inherited)
    CPU_USE_AUTOMATIC = 0 (Inherited)
    CPU_USE_1_CORE = 1 (Inherited)
    CPU_USE_2_CORES = 2 (Inherited)
    CPU_USE_3_CORES = 3 (Inherited)
    CPU_USE_4_CORES = 4 (Inherited)
    CPU_USE_5_CORES = 5 (Inherited)
    CPU_USE_6_CORES = 6 (Inherited)
    CPU_USE_7_CORES = 7 (Inherited)
    CPU_USE_8_CORES = 8 (Inherited)

    Supported Platforms:

  • macOS Intel 64 bit
  • macOS Apple Silicon
  • Windows 32 bit
  • Windows 64 bit
  • Windows ARM 64 bit
  • Linux 32 bit
  • Linux 64 bit
  • Linux ARM 32 bit
  • Linux ARM 64 bit
  • iOS