summaryrefslogtreecommitdiff
path: root/pages/develop/api/efl/gfx/map.txt
blob: 33c117c452722a8e01c0df45597703114d2e03bb (plain)
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
~~Title: Efl.Gfx.Map~~
====== Efl.Gfx.Map (mixin) ======

===== Description =====

%%Texture UV mapping for all objects (rotation, perspective, 3d, ...).%%

%%Evas allows different transformations to be applied to all kinds of objects. These are applied by means of UV mapping.%%

%%With UV mapping, one maps points in the source object to a 3D space positioning at target. This allows rotation, perspective, scale and lots of other effects, depending on the map that is used.%%

%%Each map point may carry a multiplier color. If properly calculated, these can do shading effects on the object, producing 3D effects.%%

%%At the moment of writing, maps can only have 4 points (no more, no less).%%

//Since 1.20//

{{page>:develop:api-include:efl:gfx:map:description&nouser&nolink&nodate}}

===== Inheritance =====

 => [[:develop:api:efl:interface|Efl.Interface]] //(interface)//
++++ Inheritance graph |

<graphviz>
digraph hierarchy {
    bgcolor = "transparent"
    size = "6"
    rankdir = "TB"

    node [shape = "box"]
    edge [color = "gray35"]

    efl_gfx_map [fillcolor = "deepskyblue4", label = "Efl.Gfx.Map", color = "deepskyblue", fontcolor = "white", style = "filled"]
    efl_interface [fillcolor = "gray15", label = "Efl.Interface", color = "cornflowerblue", fontcolor = "white", style = "filled"]
    efl_object [fillcolor = "gray15", label = "Efl.Object", color = "gray15", fontcolor = "white", style = "filled"]

    efl_gfx_map -> efl_interface
    efl_gfx_map -> efl_object
}
</graphviz>

++++

++++ Full hierarchy |

  * [[:develop:api:efl:interface|Efl.Interface]] //(interface)//
  * [[:develop:api:efl:object|Efl.Object]] //(class)//


++++
===== Members =====

**[[:develop:api:efl:gfx:map:method:constructor|constructor]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\
> %%Call the object's constructor.%%
<code c>
Efl_Object *efl_constructor(Eo *obj);
</code>
\\
**[[:develop:api:efl:gfx:map:method:destructor|destructor]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\
> %%Call the object's destructor.%%
<code c>
void efl_destructor(Eo *obj);
</code>
\\
**[[:develop:api:efl:gfx:map:method:lightning_3d_absolute|lightning_3d_absolute]]**\\
> %%Apply a lightning effect on the object.%%
<code c>
void efl_gfx_map_lightning_3d_absolute(Eo *obj, double lx, double ly, double lz, int lr, int lg, int lb, int ar, int ag, int ab);
</code>
\\
**[[:develop:api:efl:gfx:map:method:lightning_3d|lightning_3d]]**\\
> %%Apply a lightning effect on the object.%%
<code c>
void efl_gfx_map_lightning_3d(Eo *obj, const Efl_Gfx *pivot, double lx, double ly, double lz, int lr, int lg, int lb, int ar, int ag, int ab);
</code>
\\
**[[:develop:api:efl:gfx:map:method:map_has|map_has]]**\\
> %%Read-only property indicating whether an object is mapped.%%
<code c>
Eina_Bool efl_gfx_map_has(Eo *obj);
</code>
\\
**[[:develop:api:efl:gfx:map:method:map_reset|map_reset]]**\\
> %%Resets the map transformation to its default state.%%
<code c>
void efl_gfx_map_reset(Eo *obj);
</code>
\\
**[[:develop:api:efl:gfx:map:method:perspective_3d_absolute|perspective_3d_absolute]]**\\
> %%Apply a perspective transform to the map%%
<code c>
void efl_gfx_map_perspective_3d_absolute(Eo *obj, double px, double py, double z0, double foc);
</code>
\\
**[[:develop:api:efl:gfx:map:method:perspective_3d|perspective_3d]]**\\
> %%Apply a perspective transform to the map%%
<code c>
void efl_gfx_map_perspective_3d(Eo *obj, const Efl_Gfx *pivot, double px, double py, double z0, double foc);
</code>
\\
**[[:develop:api:efl:gfx:map:method:rotate_3d_absolute|rotate_3d_absolute]]**\\
> %%Rotate the object around 3 axes in 3D, using absolute coordinates.%%
<code c>
void efl_gfx_map_rotate_3d_absolute(Eo *obj, double dx, double dy, double dz, double cx, double cy, double cz);
</code>
\\
**[[:develop:api:efl:gfx:map:method:rotate_3d|rotate_3d]]**\\
> %%Rotate the object around 3 axes in 3D.%%
<code c>
void efl_gfx_map_rotate_3d(Eo *obj, double dx, double dy, double dz, const Efl_Gfx *pivot, double cx, double cy, double cz);
</code>
\\
**[[:develop:api:efl:gfx:map:method:rotate_absolute|rotate_absolute]]**\\
> %%Apply a rotation to the object, using absolute coordinates.%%
<code c>
void efl_gfx_map_rotate_absolute(Eo *obj, double degrees, double cx, double cy);
</code>
\\
**[[:develop:api:efl:gfx:map:method:rotate_quat_absolute|rotate_quat_absolute]]**\\
> %%Rotate the object in 3D using a unit quaternion, using absolute coordinates.%%
<code c>
void efl_gfx_map_rotate_quat_absolute(Eo *obj, double qx, double qy, double qz, double qw, double cx, double cy, double cz);
</code>
\\
**[[:develop:api:efl:gfx:map:method:rotate_quat|rotate_quat]]**\\
> %%Rotate the object in 3D using a unit quaternion.%%
<code c>
void efl_gfx_map_rotate_quat(Eo *obj, double qx, double qy, double qz, double qw, const Efl_Gfx *pivot, double cx, double cy, double cz);
</code>
\\
**[[:develop:api:efl:gfx:map:method:rotate|rotate]]**\\
> %%Apply a rotation to the object.%%
<code c>
void efl_gfx_map_rotate(Eo *obj, double degrees, const Efl_Gfx *pivot, double cx, double cy);
</code>
\\
**[[:develop:api:efl:gfx:map:method:translate|translate]]**\\
> %%Apply a translation to the object using map.%%
<code c>
void efl_gfx_map_translate(Eo *obj, double dx, double dy, double dz);
</code>
\\
**[[:develop:api:efl:gfx:map:method:zoom_absolute|zoom_absolute]]**\\
> %%Apply a zoom to the object, using absolute coordinates.%%
<code c>
void efl_gfx_map_zoom_absolute(Eo *obj, double zoomx, double zoomy, double cx, double cy);
</code>
\\
**[[:develop:api:efl:gfx:map:method:zoom|zoom]]**\\
> %%Apply a zoom to the object.%%
<code c>
void efl_gfx_map_zoom(Eo *obj, double zoomx, double zoomy, const Efl_Gfx *pivot, double cx, double cy);
</code>
\\
**[[:develop:api:efl:gfx:map:property:map_alpha|map_alpha]]** //**(get, set)**//\\
> %%Alpha flag for map rendering.%%
<code c>
Eina_Bool efl_gfx_map_alpha_get(const Eo *obj);
void efl_gfx_map_alpha_set(Eo *obj, Eina_Bool alpha);
</code>
\\
**[[:develop:api:efl:gfx:map:property:map_clockwise|map_clockwise]]** //**(get)**//\\
> %%Clockwise state of a map (read-only).%%
<code c>
Eina_Bool efl_gfx_map_clockwise_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:gfx:map:property:map_color|map_color]]** //**(get, set)**//\\
> %%Color of a vertex in the map.%%
<code c>
void efl_gfx_map_color_get(const Eo *obj, int idx, int *r, int *g, int *b, int *a);
void efl_gfx_map_color_set(Eo *obj, int idx, int r, int g, int b, int a);
</code>
\\
**[[:develop:api:efl:gfx:map:property:map_coord_absolute|map_coord_absolute]]** //**(get, set)**//\\
> %%A point's absolute coordinate on the canvas.%%
<code c>
void efl_gfx_map_coord_absolute_get(const Eo *obj, int idx, double *x, double *y, double *z);
void efl_gfx_map_coord_absolute_set(Eo *obj, int idx, double x, double y, double z);
</code>
\\
**[[:develop:api:efl:gfx:map:property:map_point_count|map_point_count]]** //**(get, set)**//\\
> %%Number of points of a map.%%
<code c>
int efl_gfx_map_point_count_get(const Eo *obj);
void efl_gfx_map_point_count_set(Eo *obj, int count);
</code>
\\
**[[:develop:api:efl:gfx:map:property:map_smooth|map_smooth]]** //**(get, set)**//\\
> %%Smoothing state for map rendering.%%
<code c>
Eina_Bool efl_gfx_map_smooth_get(const Eo *obj);
void efl_gfx_map_smooth_set(Eo *obj, Eina_Bool smooth);
</code>
\\
**[[:develop:api:efl:gfx:map:property:map_uv|map_uv]]** //**(get, set)**//\\
> %%Map point's U and V texture source point.%%
<code c>
void efl_gfx_map_uv_get(const Eo *obj, int idx, double *u, double *v);
void efl_gfx_map_uv_set(Eo *obj, int idx, double u, double v);
</code>
\\

==== Inherited ====

[[:develop:api:efl:object|Efl.Object]]\\
> **[[:develop:api:efl:object:method:children_iterator_new|children_iterator_new]]**, **[[:develop:api:efl:object:method:composite_attach|composite_attach]]**, **[[:develop:api:efl:object:method:composite_detach|composite_detach]]**, **[[:develop:api:efl:object:method:composite_part_is|composite_part_is]]**, **[[:develop:api:efl:object:method:debug_name_override|debug_name_override]]**, **[[:develop:api:efl:object:method:del|del]]**, **[[:develop:api:efl:object:method:event_callback_forwarder_add|event_callback_forwarder_add]]**, **[[:develop:api:efl:object:method:event_callback_forwarder_del|event_callback_forwarder_del]]**, **[[:develop:api:efl:object:method:event_callback_stop|event_callback_stop]]**, **[[:develop:api:efl:object:method:event_freeze|event_freeze]]**, **[[:develop:api:efl:object:method:event_global_freeze|event_global_freeze]]**, **[[:develop:api:efl:object:method:event_global_thaw|event_global_thaw]]**, **[[:develop:api:efl:object:method:event_thaw|event_thaw]]**, **[[:develop:api:efl:object:method:finalize|finalize]]**, **[[:develop:api:efl:object:method:name_find|name_find]]**, **[[:develop:api:efl:object:method:provider_find|provider_find]]**, **[[:develop:api:efl:object:property:allow_parent_unref|allow_parent_unref]]** //**(get, set)**//, **[[:develop:api:efl:object:property:comment|comment]]** //**(get, set)**//, **[[:develop:api:efl:object:property:event_freeze_count|event_freeze_count]]** //**(get)**//, **[[:develop:api:efl:object:property:event_global_freeze_count|event_global_freeze_count]]** //**(get)**//, **[[:develop:api:efl:object:property:finalized|finalized]]** //**(get)**//, **[[:develop:api:efl:object:property:name|name]]** //**(get, set)**//, **[[:develop:api:efl:object:property:parent|parent]]** //**(get, set)**//
===== Events =====

==== Inherited ====

[[:develop:api:efl:object|Efl.Object]]\\
> **[[:develop:api:efl:object:event:callback_add|callback,add]]**, **[[:develop:api:efl:object:event:callback_del|callback,del]]**, **[[:develop:api:efl:object:event:del|del]]**