Class VLFire.TVLFireLayer

Revision as of 00:06, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) ← Older edit

Revision as of 00:16, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) Newer edit →

---

Revision as of 00:16, 11 June 2013

This is a Beta Read Only version of this page. Please review and send recommendations to mitov@mitov.com. We will enable the editing as soon as we are happy with the overall Wiki site.

Package: VideoLabPkg

Unit: VLFire

Inherits: TVLDrawFilterLayer

Contents 1 Syntax 1.1 Delphi: 1.2 C++ Builder: 1.3 Visual C++ (MFC): 1.4 C# (.NET): 2 Summary 3 Description 4 Properties 4.1 Published 5 Methods 5.1 Public 6 From TVLDrawFilterLayer 7 Properties 7.1 Published 8 Methods 8.1 Public 9 From TLPDrawLayer 10 Properties 10.1 Published 11 Methods 11.1 Public 12 From TSLComponentItem 13 Properties 13.1 Public 14 Methods 14.1 Public

Syntax

Delphi:

type TVLFireLayer = class( TVLDrawFilterLayer )

C++ Builder:

class TVLFireLayer : public TVLDrawFilterLayer

Visual C++ (MFC):

class CTVLFireLayer : public CTVLDrawFilterLayer

C# (.NET):

public ref class TVLFireLayer : Mitov.VideoLab.DrawFilterLayer

Summary

Fire effect video layer.

Description

Add this layer to apply fire effect over the frames.

Example:

Original Image:	Fire effect over text layer:

Properties

Published

• FireColor - Specifies the color of the flames.
• Flammability - Specifies the flammability of the burning material.
• IncreaseStep - Specifies the speed of the intensity increase of the root of the fire.
• Smoothness - Specifies how discrete can the flames be.
• Decay - Specifies the fire decay.
• IgnitionPeriod - Specifies the frequency of fire ignitions.
• ReignitionPeriod - Specifies the frequency of reignition.
• Distribution - Specifies the fire distribution.
• MinFire - Specifies the minimal desired area covered by the fire.
• LeftOffset - Specifies the left offset from the corner of the frame.
• RightOffset - Specifies the right offset from the corner of the frame.
• Iterations - Specifies the number of fire iterations per video frame.
• Transparency - Specifies the fire transparency.
• CornerSmooth - Specifies how much the corners should be smoothed.
• Wind - Specifies the wind direction and strength.
• HeatLimit - Specifies the heat limit of the fire.
• Smooth - Specifies if and how the fire should be smoothed.

Methods

Public

• procedure DoSizeRate(AWidth : Integer; AHeight : Integer; AVideoFormat : TVLVideoFormat; AFrameDelay : Integer; AInterlaceFlags : Cardinal)
• function GetOperations() : TLPDrawLayerOperations
• procedure PourWater(ACountDrops : Cardinal; ADropSize : Cardinal) - Pours water drops over the fire.
• procedure PourWaterAt(APosition : Cardinal; ADropSize : Cardinal) - Pours water drop over the fire.
• procedure Spark(ACountSparks : Cardinal; ASparkSize : Cardinal) - Drops a random spark(s) over the flammable area.
• procedure SparkAt(APosition : Cardinal; ASparkSize : Cardinal) - Drops a spark over the flammable area.

From TVLDrawFilterLayer

Properties

Published

• AssociatedLayers

Methods

Public

• procedure DoSizeRate(AWidth : Integer; AHeight : Integer; AVideoFormat : TVLVideoFormat; AFrameDelay : Integer; AInterlaceFlags : Cardinal)
• procedure DoFilter(var OutValue : IVLImageBuffer)

From TLPDrawLayer

Properties

Published

• Visible

Methods

Public

• function GetHasEnable() : Boolean
• function GetCanDisable() : Boolean
• procedure DoLayerBegin(ACanvas : TLPCanvas; AWidth : Integer; AHeight : Integer; AXCoeff : Single; AYCoeff : Single)
• procedure DoLayerEnd()
• procedure DoLayerDraw(ACanvas : TLPCanvas; AWidth : Integer; AHeight : Integer; AXCoeff : Single; AYCoeff : Single; AContoursOnly : Boolean)
• procedure DoLayerMouseMove(AShift : TShiftState; AX : Integer; AY : Integer)
• procedure DoLayerMouseDown(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer)
• procedure DoLayerMouseUp(Button : TMouseButton; Shift : TShiftState; X : Integer; Y : Integer)
• procedure DoLayerMouseWheelDown(AShift : TShiftState; AX : Integer; AY : Integer)
• procedure DoLayerMouseWheelUp(AShift : TShiftState; AX : Integer; AY : Integer)
• procedure DoLayerMouseEnter()
• procedure DoLayerMouseLeave()
• function GetChachedData(ALink : TObject) : TObject
• procedure SetChachedData(ALink : TObject; AData : TObject)
• function GetOperations() : TLPDrawLayerOperations
• procedure AddLayerLink(ALink : TLPLayerCollectionItem)
• procedure RemoveLayerLink(ALink : TLPLayerCollectionItem)
• function GetName() : String
• function WriteLock() : IOWLockSection

From TSLComponentItem

Properties

Public

• Index
• ComponentList

Methods

Public

• function GetParentComponent() : TComponent
• function HasParent() : Boolean
• function GetOwnerList() : TSLComponentItems
• function GetHasEnable() : Boolean
• function GetCanDisable() : Boolean