Class PdnWavesEffect.Props
- Namespace
- PaintDotNet.Effects.Gpu
- Assembly
- PaintDotNet.Effects.Gpu.dll
public sealed class PdnWavesEffect.Props : PdnDistortionEffect.Props- Inheritance
-
PdnWavesEffect.Props
- Inherited Members
Properties
- Amplitude
The furthest distance that a pixel will be displaced, in pixels. This is an upper bound rather than an exact figure: a waveform steep enough to fold earlier than a sine is scaled down to match it, and so does not reach the full amplitude. Negative values invert the wave, which is equivalent to shifting the phase by 180 degrees.
The default value is 100. There is no fixed ceiling: callers scale this to the image, and half the minor axis of a large one runs past any bound worth naming.
- Angle
The direction that the wavefronts travel in, in degrees, measured counter-clockwise from east. This is only used by the linear patterns (Linear, LongitudinalLinear, and Crossed).
The range is [-180, +180] and the default value is 0.
- Bounds
The rectangle that FromEdges measures its distances from. This is normally the clipping region's bounds. Ignored by every other pattern.
The default value is an empty rectangle.
- Category
The category of the effect.
- Center
The origin of the wave pattern.
For the distance- and angle-based patterns this is the point that the wavefronts are arranged around. For the linear patterns it is the point at which the wave's phase is zero, so moving it slides them along their direction of travel.
The default value is (0, 0).
- Damping
The percentage of the wave's amplitude that is lost over each successive wavelength of distance from Center. At 50, for example, each ring of the wave is half as strong as the one before it. Zero disables damping.
The range is [0, 100] and the default value is 0.
- Description
The description of the effect.
- DisplayName
The name of the effect.
- Lobes
For Angular, the number of lobes arranged around Center. For Spiral, the number of turns the spiral makes. Ignored by every other pattern.
The range is [1, 64] and the default value is 6.
- Pattern
The arrangement of the wavefronts and the direction the image is displaced in. The default value is Linear.
- Phase
The phase offset of the wave, in degrees, where 360 degrees is one full wavelength.
The range is [-360, +360] and the default value is 0.
- WaveLength
The distance between adjacent wavefronts, in pixels. Callers will usually derive this from the size of the clipping region so that the effect looks consistent across image sizes.
Ignored by Angular, which takes its phase from an angle rather than from a distance and so has no wavefront spacing to set.
The range is [float.Epsilon, float.MaxValue] and the default value is 100.