addCone Method

  • Artigo

Adds a cone light to the Light filter effect object to cast a directional light on the page.

Syntax

object.filters.item(
    "DXImageTransform.Microsoft.Light").addCone(iX1, iY1, iZ1, iX2, iY2, iRed, iGreen, iBlue, iStrength, iSpread)

Parameters

iX1 Required. Integer that specifies the left coordinate of the light source.
iY1 Required. Integer that specifies the top coordinate of the light source.
iZ1 Required. Integer that specifies the z-axis level of the light source.
iX2 Required. Integer that specifies the left coordinate of the target light focus.
iY2 Required. Integer that specifies the top coordinate of the target light focus.
iRed Required. Integer that specifies the red value. The value can range from 0 (lowest saturation) to 255 (highest saturation).
iGreen Required. Integer that specifies the green value. The value can range from 0 (lowest saturation) to 255 (highest saturation).
iBlue Required. Integer that specifies the blue value. The value can range from 0 (lowest saturation) to 255 (highest saturation).
iStrength Required. Integer that specifies the intensity of the light filter. The value can range from 0 (lowest intensity) to 100 (highest intensity).
iSpread Required. Integer that specifies the angle, or spread, between the vertical position of the light source and the surface of the object. The angle can range from 0 to 90 degrees. Smaller angle values produce a smaller cone of light; larger values produce an oblique oval or circle of light.

Return Value

No return value.

Remarks

The cone light fades with distance from the target x,y position. The light displays a hard edge at the near edge of its focus and fades gradually as it reaches its distance threshold.

Applies To

Light