enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 3 Projects Releases Wiki Activity

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
This commit is contained in:
Srivardhan Hebbar 2015-07-20 13:25:27 +01:00 committed by Daniel Kolesa
parent 03fe4813e9
commit d3f01d8f9e
1 changed files with 79 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

198
src/lib/evas/canvas/evas_canvas3d_primitive.eo
View File

@ -6,165 +6,125 @@ class Evas.Canvas3D.Primitive (Evas.Canvas3D.Object, Evas.Common_Interface)
methods {
@property form {
set {
/*
*Set the form of the given primitive.
*
*Form defines which function will be chosen to set data to mesh
*on call of evas_canvas3d_mesh_primitive_set.
*
*Now avaliable next forms of primitives:
*-tabulated primitives: SQUARE and CUBE;
*-solids of revolution: CYLINDER, CONE, SPHERE and TORUS;
*-surfaces: SURFACE and TERRAIN.
*
*Default form is EVAS_CANVAS3D_MESH_PRIMITIVE_NONE
*
*@ingroup Evas_Canvas3D_Primitive
*/
[[Set the form of the given primitive.
Form defines which function will be chosen to set data to mesh
on call of evas_canvas3d_mesh_primitive_set.
Now avaliable next forms of primitives are tabulated primitives (SQUARE and CUBE),
solids of revolution (CYLINDER, CONE, SPHERE and TORUS) and surfaces (SURFACE and TERRAIN).
Default form is EVAS_CANVAS3D_MESH_PRIMITIVE_NONE.]]
}
get {
/*
*Get the form of the given primitive.
*@see evas_canvas3d_primitive_form_set()
*@return The form of primitive.
*@ingroup Evas_Canvas3D_Primitive
*/
[[Get the form of the given primitive.
See also @.form.set.]]
}
values {
form: Evas.Canvas3D.Mesh_Primitive; /*@ Form of primitive.*/
form: Evas.Canvas3D.Mesh_Primitive; [[Form of primitive.]]
}
}
@property mode {
set {
/*
*Set the mode of the given primitive.
*
*Mode defines which function will be chosen to set data to mesh
*on call of evas_canvas3d_mesh_primitive_set. It helps to choose
*alternative algorithm for primitive with given form
*(like cone without base or sphere textured in alternative way).
*
*Now avaliable next mods of primitives:
*-witout base (bases): supported for cylinder and cone;
*-with alternative UV: supported by sphere;
*
*Default form is EVAS_CANVAS3D_PRIMITIVE_MODE_DEFAULT
*
*@ingroup Evas_Canvas3D_Primitive
*/
[[Set the mode of the given primitive.
Mode defines which function will be chosen to set data to mesh
on call of evas_canvas3d_mesh_primitive_set. It helps to choose
alternative algorithm for primitive with given form
(like cone without base or sphere textured in alternative way).
Now avaliable next mods of primitives are
witout base (bases) (supported for cylinder and cone) and
with alternative UV (supported by sphere).
Default form is EVAS_CANVAS3D_PRIMITIVE_MODE_DEFAULT.]]
}
get {
/*
*Get the mode of the given primitive.
*@see evas_canvas3d_primitive_mode_set()
*@return The mode of primitive.
*@ingroup Evas_Canvas3D_Primitive
*/
[[Get the mode of the given primitive.
See also @.mode.set.]]
}
values {
mode: Evas.Canvas3D.Primitive_Mode; /*@ Mode of primitive.*/
mode: Evas.Canvas3D.Primitive_Mode; [[Mode of primitive.]]
}
}
@property ratio {
set {
/*
*Set the ratio of the given primitive.
*
*Now ratio uses only in torus as the ratio of the
*major radius and minor radius. For this usage
*Avaliable values is from 1.0 to infinity.
*If ratio for torus has a bad value,
*will be used 3.0 as ratio. Like ratio of usual doughnut.
*
*Default ratio is 3.0
*
*@ingroup Evas_Canvas3D_Primitive
*/
[[Set the ratio of the given primitive.
Now ratio uses only in torus as the ratio of the
major radius and minor radius. For this usage
Avaliable values is from 1.0 to infinity.
If ratio for torus has a bad value,
will be used 3.0 as ratio. Like ratio of usual doughnut.
Default ratio is 3.0.]]
}
get {
/*
*Get the ratio of the given primitive.
*@see evas_canvas3d_primitive_ratio_set()
*@return The ratio of primitive.
*@ingroup Evas_Canvas3D_Primitive
*/
[[Get the ratio of the given primitive.
See also @.ratio.set.]]
}
values {
ratio: Evas_Real; /*@ Ratio of primitive.*/
ratio: Evas_Real; [[Ratio of primitive.]]
}
}
@property precision {
set {
/*
*Set the precision of the given primitive.
*
*Precision uses in all non tabulated primitives and defines
*precision of created primitives.
*Avaliable values is from 3 to infinity.
*But if value will be more than 100, should be a warning
*about possibility of incorrect or slow work.
*
*Default ratio is 10
*
*@ingroup Evas_Canvas3D_Primitive
*/
[[Set the precision of the given primitive.
Precision uses in all non tabulated primitives and defines
precision of created primitives.
Avaliable values is from 3 to infinity.
But if value will be more than 100, should be a warning
about possibility of incorrect or slow work.
Default ratio is 10.]]
}
get {
/*
*Get the precision of the given primitive.
*@see evas_canvas3d_primitive_precision_set()
*@return The precision of primitive.
*@ingroup Evas_Canvas3D_Primitive
*/
[[Get the precision of the given primitive.
See also @.precision.set.]]
}
values {
precision: int; /*@ Precision of primitive.*/
precision: int; [[Precision of primitive.]]
}
}
@property surface {
set {
/*
*Set the surface of the given primitive.
*
*Surface uses only in surface primitive and defines
*equation of filling mesh data on call of
*evas_canvas3d_mesh_primitive_set.
*
*It gives possibility to create customers primitives like
*shell, heart, hyperbolic paraboloid etc. See _shell_func in
*examples/evas/evas-3d-visual-test.c or _perlin_terrain in
*modules/evas/primitives/surfaces/terrain.c as an example of usage.
*
*Default surface is NULL
*
*@ingroup Evas_Canvas3D_Primitive
*/
[[Set the surface of the given primitive.
Surface uses only in surface primitive and defines
equation of filling mesh data on call of
evas_canvas3d_mesh_primitive_set.
It gives possibility to create customers primitives like
shell, heart, hyperbolic paraboloid etc. See _shell_func in
examples/evas/evas-3d-visual-test.c or _perlin_terrain in
modules/evas/primitives/surfaces/terrain.c as an example of usage.
Default surface is $null]]
}
values {
surface: Evas.Canvas3D.Surface_Func *; /*@ Pointer to customers surface function.*/
surface: Evas.Canvas3D.Surface_Func *; [[Pointer to customers surface function.]]
}
}
@property tex_scale {
set {
/*
*Set the texture scale of the given primitive.
*
*Texture scale uses in all non tabulated primitives
*and defines scale of texture coords or primitives.
*
*It uses to create periodical textured meshes.
*
*Default tex_scale is {1.0, 1.0}
*
*@ingroup Evas_Canvas3D_Primitive
*/
[[Set the texture scale of the given primitive.
Texture scale uses in all non tabulated primitives
and defines scale of texture coords or primitives.
It uses to create periodical textured meshes.
Default tex_scale is {1.0, 1.0}]]
}
get {
/*
*Get the texture scale of the given primitive.
*@see evas_canvas3d_primitive_tex_scale_set()
*@ingroup Evas_Canvas3D_Primitive
*/
[[Get the texture scale of the given primitive.
See also @.tex_scale.set.]]
}
values {
tex_scale_x: Evas_Real;