This documentation is for the old version. Go to the latest Graphics Mill docs

Wave Members

The Wave type exposes the following members.

Constructors

Name Description
Public method Wave Overloaded.

Creates and initializes Wave class instance.

Methods

Name Description
Public method {dtor}

Enables using delete operator in C++ applications. It is strongly not recommended to use it directly.

Public method Abort

Aborts current operation.

(Inherited from SyncHandler.)
Public method ApplyTransform Overloaded.

Transforms given bitmap.

Public method Continue

Resumes execution of the operation previously paused with Pause() method.

(Inherited from SyncHandler.)
Public method Dispose

Releases all resources used by this Wave.

(Overrides BitmapTransform.Dispose().)
Public method Equals (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method IsPixelFormatSupported

Verifies if bitmap with specified pixel format is supported by this transform.

(Inherited from BitmapTransform.)
Public method Lock

Locks the object.

(Inherited from SyncHandler.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Pause

Pauses execution of the current operation.

(Inherited from SyncHandler.)
Public method ToString (Inherited from Object.)
Public method Unlock

Unlocks the object previously locked with method Lock().

(Inherited from SyncHandler.)
Public method WaitForCompletion

Suspends the calling thread until the operation currently run is completed.

(Inherited from SyncHandler.)

Properties

Name Description
Public property BackgroundColor

Gets/sets background color for the distorted image.

Public property Completed

Returns value indicating if the operation is currently running.

(Inherited from SyncHandler.)
Public property EnlargeToFit

Gets/sets value that specifies whether to enlarge the image to fit entire distorted image (including wave peaks) or put it to the image of the same size (in this case wave peaks will be cut off).

Public property ExceptionThrowEnabled

Gets/sets value that specifies if to throw exception in synchronous mode.

(Inherited from SyncHandler.)
Public property HorizontalAmplitude

Gets/sets an amplitude for horizontal wave.

Public property HorizontalStartPhase

Gets/sets horizontal wave start phase (in degrees).

Public property HorizontalWavelength

Gets/sets length of the horizontal wave.

Public property InterpolationMode

Gets/sets interpolation algorithm used during wave transformation.

Public property Locked

Indicates if the object has been locked.

(Inherited from SyncHandler.)
Public property Priority

Gets/sets a priority for the auxilary thread.

(Inherited from SyncHandler.)
Public property SupportedPixelFormats

Returns an array of pixel formats that are supported by this transform.

(Inherited from BitmapTransform.)
Public property SynchronizationMode

Gets/sets synchronization mode for the object.

(Inherited from SyncHandler.)
Public property Timeout

Gets/sets value specifying maximum time for which object can be locked.

(Inherited from SyncHandler.)
Public property Unit

Gets/sets unit used to measure all the coordinates, sizes and other spatial values.

(Inherited from UnitConverterHandler.)
Public property VerticalAmplitude

Gets/sets an amplitude for vertical wave.

Public property VerticalStartPhase

Gets/sets vertical wave start phase (in degrees).

Public property VerticalWavelength

Gets/sets length of the vertical wave.

Public property WaveType

Gets/sets a form of the wave.

Events

Name Description
Public event Aborted

Fires when operation has been aborted.

(Inherited from SyncHandler.)
Public event Continued

Fires when operation has been resumed with Continue() method.

(Inherited from SyncHandler.)
Public event Paused

Fires when operation has been paused with Pause() method.

(Inherited from SyncHandler.)
Protected event Progress

Fires on the operation progress notifications.

(Inherited from SyncHandler.)
Public event Started

Fires after operation has been started.

(Inherited from SyncHandler.)
Public event Starting

Fires before operation is started.

(Inherited from SyncHandler.)
Public event Stopped

Fires after operation has been stopped.

(Inherited from SyncHandler.)
Public event Stopping

Fires before operation is stopped.

(Inherited from SyncHandler.)

See Also

Reference