Class VLFire.TVLFire

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: TVLCommonROIGenFilter

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 TVLCommonROIGenFilter 7 Properties 7.1 Published 8 Methods 8.1 Public 9 From TVLCommonROIFilter 10 Properties 10.1 Published 11 From TVLCommonFilter 12 Properties 12.1 Public 13 Methods 13.1 Public 14 Pins 15 From TSLBasicThreadedEnableFilter 16 Properties 16.1 Published 17 From TSLBasicThreadedFilter 18 Properties 18.1 Published

Syntax

Delphi:

type TVLFire = class( TVLCommonROIGenFilter )

C++ Builder:

class TVLFire : public TVLCommonROIGenFilter

Visual C++ (MFC):

class CTVLFire : public CTVLCommonROIGenFilter

C# (.NET):

public ref class TVLFire : Mitov.VideoLab.CommonROIGenFilter

Summary

Applies fire effect over the frames, or generates frames with fire.

Description

Use this component to apply fire effect over the frames, or generates frames with fire.

If the input pin of this component is not connected, the component will work as video generator.

Diagram:

Example:

Original Image:	Fire effect:

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 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 TVLCommonROIGenFilter

Properties

Published

• Generator

Methods

Public

• procedure Start()
• procedure Stop()

From TVLCommonROIFilter

Properties

Published

• WorkArea

From TVLCommonFilter

Properties

Public

• InputVideoFormat

Methods

Public

• procedure ProcessFrame(Image : IVLImageBuffer)
• procedure ProcessFrame(InImage : IVLImageBuffer; var OutImage : IVLImageBuffer)
• procedure ProcessBitmap(InBitmap : TBitmap; OutBitmap : TBitmap)

Pins

• OutputPin
• InputPin

From TSLBasicThreadedEnableFilter

Properties

Published

• Enabled

From TSLBasicThreadedFilter

Properties

Published

• Threading