File: fe_lights.rst

package info (click to toggle)
svgwrite 1.4.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 2,304 kB
  • sloc: python: 12,524; makefile: 116; sh: 5
file content (128 lines) | stat: -rw-r--r-- 4,489 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
.. _feDistantLight:

feDistantLight Filter Element
=============================

The light source **feDistantLight** is a child element of the filter primitives
:ref:`feDiffuseLighting <feDiffuseLighting>` or :ref:`feSpecularLighting <feDiffuseLighting>`,
create and add this object with the method :meth:`feDistantLight`
of the filter primitives **feDiffuseLighting** or **feSpecularLighting**.

.. seealso:: http://www.w3.org/TR/SVG11/filters.html#feDistantLightElement

SVG Attributes
--------------

* **azimuth** -- `<number>`

    Direction angle for the light source on the XY plane (clockwise), in degrees.

    Default is ``'0'``

* **elevation** -- `<number>`

    Direction angle for the light source on the YZ plane, in degrees.

    Default is ``'0'``

.. _fePointLight:

fePointLight Filter Element
===========================

The light source **fePointLight** is a child element of the filter primitives
:ref:`feDiffuseLighting <feDiffuseLighting>` or :ref:`feSpecularLighting <feDiffuseLighting>`,
create and add this object with the method :meth:`fePointLight`
of the filter primitives **feDiffuseLighting** or **feSpecularLighting**.

The light source **feDistantLight** is a child element of the filter primitives
**feDiffuseLighting** or **feSpecularLighting**.

.. seealso:: http://www.w3.org/TR/SVG11/filters.html#fePointLightElement

SVG Attributes
--------------

* **x** -- `<number>` -- **source** parameter

    X location for the light source in the coordinate system established by
    attribute **primitiveUnits** on the **filter** element.

    Default is ``'0'``

* **y** -- `<number>` -- **source** parameter
    Y location for the light source in the coordinate system established by
    attribute **primitiveUnits** on the **filter** element.

    Default is ``'0'``

* **z** -- `<number>`-- **source** parameter

    Z location for the light source in the coordinate system established by
    attribute **primitiveUnits** on the ‘filter’ element, assuming that, in the
    initial coordinate system, the positive Z-axis comes out towards the person
    viewing the content and assuming that one unit along the Z-axis equals one
    unit in X and Y.

    Default is ``'0'``


.. _feSpotLight:

feSpotLight Filter Element
==========================

The light source **feSpotLight** is a child element of the filter primitives
:ref:`feDiffuseLighting <feDiffuseLighting>` or :ref:`feSpecularLighting <feDiffuseLighting>`,
create and add this object with the method :meth:`feSpotLight`
of the filter primitives **feDiffuseLighting** or **feSpecularLighting**.

.. seealso:: http://www.w3.org/TR/SVG11/filters.html#feSpotLightElement

SVG Attributes
--------------

* **x**, **y**, **z** -- see :ref:`fePointLight`

* **pointsAtX** -- `<number>` -- **target** parameter

    X location in the coordinate system established by attribute
    **primitiveUnits** on the **filter** element of the point at which the
    light source is pointing.

    Default is ``'0'``

* **pointsAtY** -- `<number>` -- **target** parameter

    Y location in the coordinate system established by attribute
    **primitiveUnits** on the **filter** element of the point at which the
    light source is pointing.

    Default is ``'0'``

* **pointsAtZ** -- `<number>` -- **target** parameter

    Z location in the coordinate system established by attribute
    **primitiveUnits** on the **filter** element of the point at which the light
    source is pointing, assuming that, in the initial coordinate system, the
    positive Z-axis comes out towards the person viewing the content and
    assuming that one unit along the Z-axis equals one unit in X and Y.

    Default is ``'0'``

* **specularExponent** -- `<number>`

    Exponent value controlling the focus for the light source.

    Default is ``'1'``

* **limitingConeAngle** -- `<number>`

    A limiting cone which restricts the region where the light is projected. No
    light is projected outside the cone. **limitingConeAngle** represents the
    angle in degrees between the spot light axis (i.e. the axis between the
    light source and the point to which it is pointing at) and the spot light
    cone. User agents should apply a smoothing technique such as anti-aliasing
    at the boundary of the cone.

    If no value is specified, then no limiting cone will be applied.