summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSrivardhan Hebbar <sri.hebbar@samsung.com>2015-07-20 13:25:27 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-07-20 13:25:27 +0100
commitd3f01d8f9e5a05754da532de9db196adf7441561 (patch)
treeca7f94d986940b9b02613272e5668ea6d712053b
parent03fe4813e95b919fe243c0c790b01955507af0de (diff)
evas canvas3d: Eolian doc conversion of canvas3d_primitive.
Summary: Signed-off-by: Srivardhan Hebbar <sri.hebbar@samsung.com> Reviewers: cedric, tasn, q66 Reviewed By: q66 Subscribers: cedric Differential Revision: https://phab.enlightenment.org/D2842
-rw-r--r--src/lib/evas/canvas/evas_canvas3d_primitive.eo198
1 files changed, 79 insertions, 119 deletions
diff --git a/src/lib/evas/canvas/evas_canvas3d_primitive.eo b/src/lib/evas/canvas/evas_canvas3d_primitive.eo
index fd281f1a0f..f56e2e7071 100644
--- a/src/lib/evas/canvas/evas_canvas3d_primitive.eo
+++ b/src/lib/evas/canvas/evas_canvas3d_primitive.eo
@@ -6,165 +6,125 @@ class Evas.Canvas3D.Primitive (Evas.Canvas3D.Object, Evas.Common_Interface)
6 methods { 6 methods {
7 @property form { 7 @property form {
8 set { 8 set {
9 /* 9 [[Set the form of the given primitive.
10 *Set the form of the given primitive. 10
11 * 11 Form defines which function will be chosen to set data to mesh
12 *Form defines which function will be chosen to set data to mesh 12 on call of evas_canvas3d_mesh_primitive_set.
13 *on call of evas_canvas3d_mesh_primitive_set. 13
14 * 14 Now avaliable next forms of primitives are tabulated primitives (SQUARE and CUBE),
15 *Now avaliable next forms of primitives: 15 solids of revolution (CYLINDER, CONE, SPHERE and TORUS) and surfaces (SURFACE and TERRAIN).
16 *-tabulated primitives: SQUARE and CUBE; 16
17 *-solids of revolution: CYLINDER, CONE, SPHERE and TORUS; 17 Default form is EVAS_CANVAS3D_MESH_PRIMITIVE_NONE.]]
18 *-surfaces: SURFACE and TERRAIN.
19 *
20 *Default form is EVAS_CANVAS3D_MESH_PRIMITIVE_NONE
21 *
22 *@ingroup Evas_Canvas3D_Primitive
23 */
24 } 18 }
25 get { 19 get {
26 /* 20 [[Get the form of the given primitive.
27 *Get the form of the given primitive. 21
28 *@see evas_canvas3d_primitive_form_set() 22 See also @.form.set.]]
29 *@return The form of primitive.
30 *@ingroup Evas_Canvas3D_Primitive
31 */
32 } 23 }
33 values { 24 values {
34 form: Evas.Canvas3D.Mesh_Primitive; /*@ Form of primitive.*/ 25 form: Evas.Canvas3D.Mesh_Primitive; [[Form of primitive.]]
35 } 26 }
36 } 27 }
37 @property mode { 28 @property mode {
38 set { 29 set {
39 /* 30 [[Set the mode of the given primitive.
40 *Set the mode of the given primitive. 31
41 * 32 Mode defines which function will be chosen to set data to mesh
42 *Mode defines which function will be chosen to set data to mesh 33 on call of evas_canvas3d_mesh_primitive_set. It helps to choose
43 *on call of evas_canvas3d_mesh_primitive_set. It helps to choose 34 alternative algorithm for primitive with given form
44 *alternative algorithm for primitive with given form 35 (like cone without base or sphere textured in alternative way).
45 *(like cone without base or sphere textured in alternative way). 36
46 * 37 Now avaliable next mods of primitives are
47 *Now avaliable next mods of primitives: 38 witout base (bases) (supported for cylinder and cone) and
48 *-witout base (bases): supported for cylinder and cone; 39 with alternative UV (supported by sphere).
49 *-with alternative UV: supported by sphere; 40
50 * 41 Default form is EVAS_CANVAS3D_PRIMITIVE_MODE_DEFAULT.]]
51 *Default form is EVAS_CANVAS3D_PRIMITIVE_MODE_DEFAULT
52 *
53 *@ingroup Evas_Canvas3D_Primitive
54 */
55 } 42 }
56 get { 43 get {
57 /* 44 [[Get the mode of the given primitive.
58 *Get the mode of the given primitive. 45
59 *@see evas_canvas3d_primitive_mode_set() 46 See also @.mode.set.]]
60 *@return The mode of primitive.
61 *@ingroup Evas_Canvas3D_Primitive
62 */
63 } 47 }
64 values { 48 values {
65 mode: Evas.Canvas3D.Primitive_Mode; /*@ Mode of primitive.*/ 49 mode: Evas.Canvas3D.Primitive_Mode; [[Mode of primitive.]]
66 } 50 }
67 } 51 }
68 @property ratio { 52 @property ratio {
69 set { 53 set {
70 /* 54 [[Set the ratio of the given primitive.
71 *Set the ratio of the given primitive. 55
72 * 56 Now ratio uses only in torus as the ratio of the
73 *Now ratio uses only in torus as the ratio of the 57 major radius and minor radius. For this usage
74 *major radius and minor radius. For this usage 58 Avaliable values is from 1.0 to infinity.
75 *Avaliable values is from 1.0 to infinity. 59 If ratio for torus has a bad value,
76 *If ratio for torus has a bad value, 60 will be used 3.0 as ratio. Like ratio of usual doughnut.
77 *will be used 3.0 as ratio. Like ratio of usual doughnut. 61
78 * 62 Default ratio is 3.0.]]
79 *Default ratio is 3.0
80 *
81 *@ingroup Evas_Canvas3D_Primitive
82 */
83 } 63 }
84 get { 64 get {
85 /* 65 [[Get the ratio of the given primitive.
86 *Get the ratio of the given primitive. 66
87 *@see evas_canvas3d_primitive_ratio_set() 67 See also @.ratio.set.]]
88 *@return The ratio of primitive.
89 *@ingroup Evas_Canvas3D_Primitive
90 */
91 } 68 }
92 values { 69 values {
93 ratio: Evas_Real; /*@ Ratio of primitive.*/ 70 ratio: Evas_Real; [[Ratio of primitive.]]
94 } 71 }
95 } 72 }
96 @property precision { 73 @property precision {
97 set { 74 set {
98 /* 75 [[Set the precision of the given primitive.
99 *Set the precision of the given primitive. 76
100 * 77 Precision uses in all non tabulated primitives and defines
101 *Precision uses in all non tabulated primitives and defines 78 precision of created primitives.
102 *precision of created primitives. 79 Avaliable values is from 3 to infinity.
103 *Avaliable values is from 3 to infinity. 80 But if value will be more than 100, should be a warning
104 *But if value will be more than 100, should be a warning 81 about possibility of incorrect or slow work.
105 *about possibility of incorrect or slow work. 82
106 * 83 Default ratio is 10.]]
107 *Default ratio is 10
108 *
109 *@ingroup Evas_Canvas3D_Primitive
110 */
111 } 84 }
112 get { 85 get {
113 /* 86 [[Get the precision of the given primitive.
114 *Get the precision of the given primitive. 87
115 *@see evas_canvas3d_primitive_precision_set() 88 See also @.precision.set.]]
116 *@return The precision of primitive.
117 *@ingroup Evas_Canvas3D_Primitive
118 */
119 } 89 }
120 values { 90 values {
121 precision: int; /*@ Precision of primitive.*/ 91 precision: int; [[Precision of primitive.]]
122 } 92 }
123 } 93 }
124 @property surface { 94 @property surface {
125 set { 95 set {
126 /* 96 [[Set the surface of the given primitive.
127 *Set the surface of the given primitive. 97
128 * 98 Surface uses only in surface primitive and defines
129 *Surface uses only in surface primitive and defines 99 equation of filling mesh data on call of
130 *equation of filling mesh data on call of 100 evas_canvas3d_mesh_primitive_set.
131 *evas_canvas3d_mesh_primitive_set. 101
132 * 102 It gives possibility to create customers primitives like
133 *It gives possibility to create customers primitives like 103 shell, heart, hyperbolic paraboloid etc. See _shell_func in
134 *shell, heart, hyperbolic paraboloid etc. See _shell_func in 104 examples/evas/evas-3d-visual-test.c or _perlin_terrain in
135 *examples/evas/evas-3d-visual-test.c or _perlin_terrain in 105 modules/evas/primitives/surfaces/terrain.c as an example of usage.
136 *modules/evas/primitives/surfaces/terrain.c as an example of usage. 106
137 * 107 Default surface is $null]]
138 *Default surface is NULL
139 *
140 *@ingroup Evas_Canvas3D_Primitive
141 */
142 } 108 }
143 values { 109 values {
144 surface: Evas.Canvas3D.Surface_Func *; /*@ Pointer to customers surface function.*/ 110 surface: Evas.Canvas3D.Surface_Func *; [[Pointer to customers surface function.]]
145 } 111 }
146 } 112 }
147 @property tex_scale { 113 @property tex_scale {
148 set { 114 set {
149 /* 115 [[Set the texture scale of the given primitive.
150 *Set the texture scale of the given primitive. 116
151 * 117 Texture scale uses in all non tabulated primitives
152 *Texture scale uses in all non tabulated primitives 118 and defines scale of texture coords or primitives.
153 *and defines scale of texture coords or primitives. 119
154 * 120 It uses to create periodical textured meshes.
155 *It uses to create periodical textured meshes. 121
156 * 122 Default tex_scale is {1.0, 1.0}]]
157 *Default tex_scale is {1.0, 1.0}
158 *
159 *@ingroup Evas_Canvas3D_Primitive
160 */
161 } 123 }
162 get { 124 get {
163 /* 125 [[Get the texture scale of the given primitive.
164 *Get the texture scale of the given primitive. 126
165 *@see evas_canvas3d_primitive_tex_scale_set() 127 See also @.tex_scale.set.]]
166 *@ingroup Evas_Canvas3D_Primitive
167 */
168 } 128 }
169 values { 129 values {
170 tex_scale_x: Evas_Real; 130 tex_scale_x: Evas_Real;