summaryrefslogtreecommitdiff
path: root/legacy/ephysics/doc
diff options
context:
space:
mode:
authorRicardo de Almeida Gonzaga <ricardo@profusion.mobi>2012-09-14 22:02:12 +0000
committerBruno Dilly <bdilly@profusion.mobi>2012-09-14 22:02:12 +0000
commitead58d536e7b1cf0982b753ad18ca44e7b854809 (patch)
treee4b8eab98505c8e0ba65e484ba3afc4907e92ab5 /legacy/ephysics/doc
parent886d35fc6dad932425602f281c1138fee160c8f5 (diff)
ephysics: add a new example doc: Bouncing Text -
test_bouncing_text.c Patch by: Ricardo de Almeida Gonzaga <ricardo@profusion.mobi> SVN revision: 76692
Diffstat (limited to 'legacy/ephysics/doc')
-rw-r--r--legacy/ephysics/doc/examples.dox73
1 files changed, 73 insertions, 0 deletions
diff --git a/legacy/ephysics/doc/examples.dox b/legacy/ephysics/doc/examples.dox
index 10f63b92b2..70cf74a3dc 100644
--- a/legacy/ephysics/doc/examples.dox
+++ b/legacy/ephysics/doc/examples.dox
@@ -4,6 +4,7 @@
4 * Here is a page with examples. 4 * Here is a page with examples.
5 * 5 *
6 * @li @ref tutorial_ephysics_bouncing_ball 6 * @li @ref tutorial_ephysics_bouncing_ball
7 * @li @ref tutorial_ephysics_bouncing_text
7 * @li @ref tutorial_ephysics_delete_body 8 * @li @ref tutorial_ephysics_delete_body
8 * @li @ref tutorial_ephysics_constraint 9 * @li @ref tutorial_ephysics_constraint
9 */ 10 */
@@ -206,6 +207,78 @@
206 * 207 *
207 * @example ephysics_logo.c 208 * @example ephysics_logo.c
208 */ 209 */
210
211/**
212 * @page tutorial_ephysics_bouncing_text EPhysics - Bouncing Text
213 *
214 * The purpose of this example is to demonstrate the EPhysics_Body binding to
215 * a text (Evas_Object)
216 *
217 * For this example we'll have an EPhysics_World and one basic EPhysics_Body.
218 *
219 * The basic concepts like - initializing an EPhysics_World, render geometry,
220 * physics limiting boundaries, were already covered in
221 * @ref tutorial_ephysics_bouncing_ball
222 *
223 * @section add-text Creating the text
224 * @dontinclude test_bouncing_text.c
225 *
226 * Create a basic evas_object_text.
227 *
228 * @skipline Evas_Object *text;
229 *
230 * @skip text =
231 * @until text);
232 *
233 * @section add-textbody Creating the body
234 *
235 * Create a simple EPhysics_Body.
236 *
237 * Note that we use ephysics_body_geometry_set() to define its size because
238 * the evas_object has a different size that we want to represent physically.
239 * The text may have accent or letters like j and g.
240 *
241 * @skipline text_body =
242 * @skip ephysics_body_geometry_set(text_body
243 * @until 0.1);
244 *
245 * @section text-binding Binding
246 * @dontinclude test_bouncing_text.c
247 *
248 * After create the body and the text, now we need to bind them.
249 *
250 * We set the last parameter as EINA_FALSE because in this example we don't
251 * want to set the physics body position to match evas object position.
252 *
253 * @skipline ephysics_body_evas_object_set
254 *
255 * Here we finish the example. The full source code can be found at
256 * @ref test_bouncing_text_c.
257 *
258 */
259
260 /**
261 * @page test_bouncing_text_c test_bouncing_text.c
262 *
263 * @section ephysics-test-h ephysics_test.h
264 * @include ephysics_test.h
265 *
266 * @section test-bouncing_text-c test_bouncing_text.c
267 * @dontinclude test.c
268 *
269 * @skip test_clean
270 * @until }
271 *
272 * @skip test_data_new
273 * @until }
274 *
275 * @skip test_win_add
276 * @until }
277 *
278 * @include test_bouncing_text.c
279 *
280 * @example test_bouncing_text.c
281 */
209 282
210/** 283/**
211 * @page tutorial_ephysics_delete_body EPhysics - Delete Body 284 * @page tutorial_ephysics_delete_body EPhysics - Delete Body