Table of Contents

Class TwirlBlock

Namespace
VisioForge.Core.MediaBlocks.VideoProcessing
Assembly
VisioForge.Core.dll

Video twirl distortion effect block that creates spiral rotating warping patterns. This block applies twirl distortion to video content by rotating pixels around a center point with intensity that decreases based on distance from the center. Features configurable twist angle, center point positioning, and radius control for creating various spiral effects. Essential for creative video production, artistic transitions, hypnotic effects, and abstract visual transformations requiring spiral-based geometric distortion. Implements the VisioForge.Core.MediaBlocks.MediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class TwirlBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

Implements

Inherited Members

Extension Methods

Constructors

TwirlBlock(double)

Initializes a new instance of the VisioForge.Core.MediaBlocks.VideoProcessing.TwirlBlock class with the specified twirl angle.

public TwirlBlock(double angle = 3.14159)

Parameters

angle double

The maximum twirl angle in radians (default: π for half rotation).

Properties

Angle

Gets or sets the maximum twirl angle in radians. This determines the intensity of the spiral distortion at the center point, with the effect diminishing towards the edges.

public double Angle { get; set; }

Property Value

double

Input

Gets the input.

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets the inputs.

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the output.

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets the outputs.

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Type

Gets the type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Constructs and initializes the twirl filter and its associated GStreamer elements. This method creates the filter with the specified angle, establishes input and output pads, and prepares the block for applying spiral rotating warping patterns to video content.

public override bool Build()

Returns

bool

true if the filter was successfully built and configured; false if initialization failed.

CleanUp()

Releases all resources and performs cleanup operations for this twirl effect block. This method disposes of the GStreamer elements and resets the build state.

public void CleanUp()

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

GetCore()

Gets the core BaseElement wrapper that provides additional functionality around the GStreamer twirl filter element.

public BaseElement GetCore()

Returns

BaseElement

The BaseElement wrapper instance that encapsulates the GStreamer twirl filter.

GetElement()

Gets the underlying GStreamer element that performs the twirl distortion.

public Element GetElement()

Returns

Element

The GStreamer Element instance representing the twirl filter.

IsAvailable()

Determines whether this media block is available. Correct NuGet SDK redist should be included into your project.

public static bool IsAvailable()

Returns

bool

true if this media block is available; otherwise, false.

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Associates this twirl effect block with a pipeline and initializes its internal context. This method is called internally when the block is added to a pipeline.

void IMediaBlockInternals.SetContext(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The MediaBlocksPipeline instance that will manage this block.

See Also