Blog - Content Section Layout
Gna download area
Written by Administrator   

Links to the Cooki3d Gna! project: 

Gna cooki3d home  

Gna download area

Gna view cvs/snv

 

Last Updated ( Wednesday, 20 December 2006 )
 
News
Written by Administrator   

Mon Dec 8 00:44 CET 2006

Migration of the site from Mambo to Joomla. Now, the Cooki3d site is multilingual thanks to Joom!Fish component. All contributions to translate manualy the items are welcome! If you want become a translator in your favourite language, contact us.

Mon Dec 4 15:20 CET 2006

Project registration for Gna! has been approved. Now all users can make directly bug reports. Also the project developer team has been moved on  Gna. The cvs access will be activated and fed as soon as possible. Now if you have good C++ or/and Java or other interessant skills (web skills, testing role...), you can create a user on gna and participate in the cooki3d project.

Wed Nov 29 15:30 CET 2006

Important bugs with Nvidia Geforce4MX420, Geforce3Ti200,... have been corrected, these cards doesn't support fragment et vertex shader but now the render can be done without these effects, and avoid than the navigator crash in some particular conditions.

An additionnal note for linux users has been added. See Important notes on native library loading on this page

Mon Nov 20 11:44 CET 2006

A new system of security checks have been added. Now the security pass via a signed applet. That simplifies the access of the examples to the user and the security policy have not to be refresh...

Thu Nov 16 12:21 CET 2006

You can download the c++ source code part Cooki3dC++api2232 (GNU/GPL) if you have a user account.

Wed Nov 15 19:26 CET 2006

First release version 0.21-2232 (java framework [0.21] and c++ api) of Cooki3d is now available ! 

This version is more stable and robust, support several render surfaces in the same process i.e. several 3d applications in your web navigator !

So at the same time, in different tabbeb panes (firefox) or windows, or in the same html page you can have a collection of 3d viewer applications. 

   
Last Updated ( Saturday, 09 December 2006 )
 
Download Cooki3d C++ API GNU/GPL
Written by Administrator   

LICENCE GUIDELINES

 If you are unsure which license is appropriate for your use, please review this link

 

DOWNLOAD LINKS

Cooki3dC++api2232.zip

 

LICENCE GNU/GPL 

The Cooki3d api is Copyright (C) 2006 Bertrand Greslier

 You may use, distribute and copy the Cooki3d API under the terms of
 GNU General Public License version 2, which is displayed below.

-------------------------------------------------------------------------

            GNU GENERAL PUBLIC LICENSE
               Version 2, June 1991

 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
                       51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.

                Preamble

  The licenses for most software are designed to take away your
freedom to share and change it.  By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users.  This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it.  (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.)  You can apply it to
your programs, too.

  When we speak of free software, we are referring to freedom, not
price.  Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.

  To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.

  For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have.  You must make sure that they, too, receive or can get the
source code.  And you must show them these terms so they know their
rights.

  We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.

  Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software.  If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.

  Finally, any free program is threatened constantly by software
patents.  We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary.  To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.

  The precise terms and conditions for copying, distribution and
modification follow.

            GNU GENERAL PUBLIC LICENSE
   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

  0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License.  The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language.  (Hereinafter, translation is included without limitation in
the term "modification".)  Each licensee is addressed as "you".

Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope.  The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.

  1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.

You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.

  2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:

    a) You must cause the modified files to carry prominent notices
    stating that you changed the files and the date of any change.

    b) You must cause any work that you distribute or publish, that in
    whole or in part contains or is derived from the Program or any
    part thereof, to be licensed as a whole at no charge to all third
    parties under the terms of this License.

    c) If the modified program normally reads commands interactively
    when run, you must cause it, when started running for such
    interactive use in the most ordinary way, to print or display an
    announcement including an appropriate copyright notice and a
    notice that there is no warranty (or else, saying that you provide
    a warranty) and that users may redistribute the program under
    these conditions, and telling the user how to view a copy of this
    License.  (Exception: if the Program itself is interactive but
    does not normally print such an announcement, your work based on
    the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole.  If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works.  But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.

In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.

  3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:

    a) Accompany it with the complete corresponding machine-readable
    source code, which must be distributed under the terms of Sections
    1 and 2 above on a medium customarily used for software interchange; or,

    b) Accompany it with a written offer, valid for at least three
    years, to give any third party, for a charge no more than your
    cost of physically performing source distribution, a complete
    machine-readable copy of the corresponding source code, to be
    distributed under the terms of Sections 1 and 2 above on a medium
    customarily used for software interchange; or,

    c) Accompany it with the information you received as to the offer
    to distribute corresponding source code.  (This alternative is
    allowed only for noncommercial distribution and only if you
    received the program in object code or executable form with such
    an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for
making modifications to it.  For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable.  However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.

If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.

  4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License.  Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.

  5. You are not required to accept this License, since you have not
signed it.  However, nothing else grants you permission to modify or
distribute the Program or its derivative works.  These actions are
prohibited by law if you do not accept this License.  Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.

  6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions.  You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.

  7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License.  If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all.  For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.

It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices.  Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.

This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.

  8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded.  In such case, this License incorporates
the limitation as if written in the body of this License.

  9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time.  Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

Each version is given a distinguishing version number.  If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation.  If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.

  10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission.  For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this.  Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.

                NO WARRANTY

  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.

  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.

             END OF TERMS AND CONDITIONS

        How to Apply These Terms to Your New Programs

  If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.

  To do so, attach the following notices to the program.  It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

    <one line to give the program's name and a brief idea of what it does.>
    Copyright (C) <year>  <name of author>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA


Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:

    Gnomovision version 69, Copyright (C) year name of author
    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.

The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License.  Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary.  Here is a sample; alter the names:

  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
  `Gnomovision' (which makes passes at compilers) written by James Hacker.

  <signature of Ty Coon>, 1 April 1989
  Ty Coon, President of Vice

This General Public License does not permit incorporating your program into
proprietary programs.  If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library.  If this is what you want to do, use the GNU Library General
Public License instead of this License.

-------------------------------------------------------------------------

 

Last Updated ( Wednesday, 15 November 2006 )
 
C++ api documentation (last vers)
Written by Administrator   

The reference guide is generated by Doxygen from the source code.

  html C++ api documentation

Last Updated ( Wednesday, 15 November 2006 )
 
Framework fr docs
Written by Administrator   


I. Les éléments graphiques

I.1. Lire un fichier du format ive, osg, 3ds...
I.2. Afficher du texte
I.3. Créer un personnage (ou une entité) composé d'animations et de séquences 
I.4. Créer un personnage basé sur l'api cal3d

 

II. Les événements

II.1. Déclarer un événement clavier
II.2. Déclarer un événement souris
II.3. Déclarer un événement de collision

 

III. Les médias

III.1 Manipuler une animation interpolée contenu dans un fichier modèle
III.2 Manipuler une séquence d'images
III.3 Manipuler un son
III.4 Manipuler un son mp3
III.5 Manipuler une barre de temps "threadée" et ses commandes clefs 

 

IV. Les terrains

IV.1 Manipuler un terrain (un champs d'altitudes)
IV.2 Manipuler un terrain de collision (un champs d'altitude)

 

V. Divers

V.1 Gérer une caméra contenue dans un fichier modèle
V.2 Utiliser un noeud contenue dans un fichier modèle 
V.3 Créer un ligne directrice interpolée pour gérer un mouvement scénarisé
V.4 Déclarer un groupe de paramètres xml
V.5 Ajouter un chemin de recherche pour une 'font' ou une image
V.6 Ajouter un membre de classe dans un plugin 

 



I. Les éléments graphiques


   Les éléments graphiques seront ajoutés à la scène courante lors du chargement. Cela va créer une instance de la classe concernée ('cooki3d::File', 'cooki3d::Texte', 'cooki3d::Charater'...). Cette instance peut être directement accessible et manipulable par son nom si un plugin est associé au level déclaré. On pourra ainsi faire des manipulations dynamiques lors des événements ou encore implémenter des manipulations qui ne sont pas possibles depuis le framework.

   TIPS:
   > pour voir directement la définition de la classe dans votre éditeur, il suffit de cliquer sur l'entête du bloc ('file', 'texte', 'characterSeqAnim'...).

   NEXT VERSION:
   > la manipulation des instances directement via un langage de script choisi (tcl, lua)



I.1. Lire un fichier du format ive, osg, 3ds...


   ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                  sur le noeud <level> faire 'new File'

   CLASSE : 'cooki3d::File'
   Cette classe permet de manipuler un fichier 3d. On pourra modifier son placement dans l'espace, sa taille, la facon dont les chemins sont renommée de manière uniforme...
   Techniquement la noeud chargé devient fils d'un noeud osg::PositionAttitudeTranform (pour le placement et la taille) nommé par le 'nom du level'->'nom de l'instance'

   ATTRIBUTS xml/c++ :
   > le nom de l'instance ('nom')
   > le chemin du fichier à charger ('item')
   > la position ( 'x', 'y', 'altitude' )
   > la taille ('scale')
   > booléen déterminant si les chemins doivent être renommés de manière uniforme et unique ('pathUnicity')
   
   NOTE :
   Par defaut on est limité au format les plus courants pour reduire la taille des packages déployés (cf liste des plugins fournie) pour les autres formats, il faudra fournir les librairies 'dll' et 'so' avec la demo.
      
   NEXT VERSION:
    La prochaine version (>=0.22) supportera :
     > le téléchargement de packages additionnels qui pourront être utilisés par plusieurs démos. (comme par exemple les formats adittionnels non fournis par défaut ou encore    le support de QT4...)


I.2. Afficher du texte

   ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                  sur le noeud <level> faire 'new Texte'

   CLASSE : 'cooki3d::Texte'
   Cette classe permet de manipuler un objet osg::Text. On peut ainsi choisir la couleure, la taille, la "font" police de caractère, la position et le texte à afficher.

   ATTRIBUTS xml/c++ :
   > le nom de l'instance ('nom')
   > les composantes de la couleur ('colorR','colorG','colorB','colorA' )
   > la taille ('charaterSize')    
   > la font ('font')    
   > la position ('posX', 'posY', 'posZ')
   > le texte à afficher. ('texte')
   
   TIPS:
   > il faut souvent ajouter un chemin pour que la font soit trouvée
   Action dans le framework : sur le noeud <texte> ou <level> faire 'add filePath'     

   NOTE:
    Seule les textes projetés en 2D sont supportés.

   NEXT VERSION:
    La prochaine version (>=0.22) supportera :
     > une option pour autoriser le texte à ne pas être projecté en orthogonal
     
   

I.3. Créer un personnage (ou une entité) composé d'animations et de séquences


   ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                  sur le noeud <level> faire 'new CharacterSeqAnim'
   
   CLASSE : 'cooki3d::CharacterSeqAnim' (super classe 'cooki3d::Character')
   Cette classe permet de gérer un noeud personnage (ou une entité ayant des comportements). Ensuite il faut associer des animations et/ou des séquences au personnage. Celles-ci appartiennent généralement à des fichiers, il faut donc en déclarer au moins un et y faire référence.

   ATTRIBUTS xml/c++ :
   > le nom de l'instance ('nom')
   > un facteur d'attraction terrestre par rapport aux terrains envionnants ('attraction').
   > un position initialse X,Y,Z ('positionX','positionY','elevationZ')
   > un facteur en seconde de transition en ses animations ('blendTime')
   > une vitesse de déplacement lors des translations ('vitesseDeplacement')
   > une vitesse de rotation lors de rotations ('vitesseRotation')
   > un facteur de taille homogène ('scale')
   > le noeud de référence qui sera manipulé lors des déplacement... ('osgNodeName')
   
   TIPS:
   > partir d'un exemple donné et avancer pas à pas pour réussir à faire votre propre personnage

   NOTE:
    Pour utiliser la fonction allerA(...) qui permet de se déplacer sur un
    terrain, il faut déclarer une animation ou une sequence s'appellant
    {nom du perso}_walk
    
   NEXT VERSION:
   La prochaine version (>=0.22) permettrera de :
   > choisir les suffixes des animations courantes (actuellement en dur '_walk' pour le déplacement et '_idle' pour faire du surplace)
   

I.4. Créer un personnage basé sur l'api cal3d


   CLASSE : 'cooki3d::CharacterOsgCal' (super classe 'cooki3d::Character')
   Il s'agit d'utiliser un personnage basé sur des bones et un squelette.
   
   Cette fonctionnalité est désactivée. Elle nécessite le téléchargement
   de packages additionnels (api cal3d...) qui pourront être utilisés
   par plusieurs demos.

   La manipulation de ce personnage est strictement similaire à
   un CharacterSeqAnim.
   
   TIPS:
    

   NEXT VERSION:
   La prochaine version (>=0.22) supportera :
   > Activation de ce type/classe de personnage
   > permettrera de choisir les suffixes des animations courantes (actuellement en dur '_walk' pour le déplacement et '_idle' pour le surplace)

II. Les événements


   Un événement sera associé à un code qui recevra en paramètre une référence sur l'événement. Il nécéssite donc la création d'un bloc 'library' qui sera lié au level concerné. Le patron du code sera généré automatiquement si l'option 'autogen' reste cochée. Ainsi l'utilisateur a juste à ajouter le code spécifique à executer lors du déclenchement de l'événement.

   SUPER CLASSE : 'cooki3d::Event'

   NOTE:    
   > Il faut veillé à bien modifier uniquement les parties entre les balises prévus à cet effet, sinon les modifications seront perdues lors de la prochaine génération.

II.1. Déclarer un événement clavier

   ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                  sur le noeud <level> faire 'new EvtKey'

   CLASSE: 'cooki3d::EvtKey'
   
   ATTRIBUTS xml/c++ :
   > le nom de l'instance ('nom')
   > le type d'événement : touche poussée ou relevée ... ('evtType')
   > le symbole clavier de la touche ('keySymbol')
   > les touches modes complémentaires  : alt, ctrl... ('modKeyMask')
   > booléen déterminant si le code est auto-généré ('autogen')
   > le code associé à l'événement ('code')

   NOTE:
   Il est possible de centraliser le code associé à plusieurs touches
   en utilisant un bloc 'EvtKeyGroup' ayant alors des fils 'EvtKey'
   
   TIPS:
   

II.2. Déclarer un événement souris


   ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                  sur le noeud <level> faire 'new EvtMouse'

   CLASSE: 'cooki3d::EvtMouse'

   ATTRIBUTS xml/c++ :
   > le nom de l'instance ('nom')
   > le masque de sélection utilisé lors du lancé de rayon ('nodeMask')
   > le type d'événement : click de souris poussé, relevé, mouvement, glissé ('type')
   > booleen déterminant si le code est auto généré ('autogen')
   > le code associé à l'événement ('code')
   > les zones d'activation : fils de type 'osgNode'
   
   Il faut définir des noms de noeuds graphiques fils à cet événement souris. En faite il s'agit de zones 3D d'activation de l'événement. Ces zones sont définies par l'utilisateur par des chemins (nodePath) dans la scène menants à des noeuds décrivant des géométries (osg::Drawable). Ces chemins peuvent utiliser des carctères spéciaux :
   > Le caratère '*' représente n'importe quelle zone
   > '/level0->ParkColoriage/Scene Root/palette*' signifie tout ce qui commence
   par palette et qui a pour parent 'Scene Root' ayant lui même pour parent
   'level0->ParkColoriage'
   > '@' représente la zone vide

   TIPS:
   > pour grouper plusieurs événements souris sur un même code, il n'y a pas de classe 'EvtMouseGroup', néanmoins vous pouvez décocher l'option 'autogen' et utiliser un code déjà existant.

II.3. Déclarer un événement de collision


   ACTION dans le framework :
      sur le noeud <jeu> faire 'new Level'
      sur le noeud <level> faire 'new EvtBoundingShapeCollision'

   CLASSE : 'cooki3d::EvtBoundingShapeCollision'
   Un événement de collision est relié à deux 'BoundingShape' qui en principe peuvent entrer en collision. Il est donc nécéssaire de déclarer 2 blocs 'BoundingShape' (qui peuvent être partagés avec d'autre événements de collision).
   L'événement est mise à jour selon un nombre de frame fixé par l'utilisateur ('refreshPeriod') le minimum étant 1 (vérification à chaque frame).
   Lorsque l'événement est détecté, le code associé est executé, et ensuite un délais d'attente fixé par l'utilisateur ('standyDelay') démarre avant la reprise de la détection.

   ATTRIBUTS xml/c++ :
   > le nom de l'instance ('nom')
   > période de rafraichissement de l'événement en nombre de frames ('refreshPeriod')
   > un délais d'attente avant reprise de la détection ('standbyDelay')
   > première 'BoundingShape', boite englobant l'objet 1 ('collision1')
   > deuxième 'BoundingShape' ('collision2')
   > booleen déterminant si le code est auto généré ('autogen')
   > le code associé à l'événement ('code')
   

   TIPS:
   > pour grouper plusieurs événements de collision sur un même code, il n'y a pas de classe 'EvtCollisionGroup', néanmoins vous pouvez décocher l'option 'autogen' et utiliser un code déjà existant.
 

III. Les médias


 Un média peu s'apparenter à un lecteur mp3 avec un bouton pause, play, stop, avancer, reculer...
On a donc principalement les méthodes pause(), play(), stop(), setPostion( nbSecondes ) pour avancer ou reculer et setDuration( nbSecondes) pour redimensionner le flux si cela est possible ('cooki3d::Animation')

   SUPER CLASSE : 'cooki3d::MediaEvaluable'
   INTERFACE : 'cooki3d::Media'


III.1 Manipuler une animation interpolée contenu dans un fichier modèle


   ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                  sur le noeud <level> faire 'new Animation'

   CLASSE: 'cooki3d::Animation'
   Un objet de cette classe permet de manipuler comme un média une instance de 'osg::AnimationPath' contenu dans la scène. Cette classe 'osg' est un outil qui permet d'interpoler la position et la rotation instantannée d'un point en fonction d'une liste de points de contrôle et du temps.

   ATTRIBUTS xml/c++ :
   > le nom de l'instance ('nom')
   > booléen déterminant si l'instance doit prendre les valeurs du modèle automatiquement ou si il faut découper l'animation du modèle selon les trois paramètres 'debut', 'fin' et 'fps' de manière manuelle.
   > (en mode manuel) numéro de la première "image" (clef) de l'animation ('debut')
   > (en mode manuel) numéro de la dernière "image" (clef) de l'animation ('fin')
   > (en mode manuel) nombre d'images par secondes ('fps')
   > type de mouvement souhaité de l'animation ('mouv')
   > chemin du noeud osg contenant l'animation [osg::AnimationPath] ('nodeName')

   TIPS:
   > Il est possible de manipuler directement un groupe d'animations concernant plusieurs noeuds de facon centralisée et synchronisée. Il faut pour cela utiliser le bloc 'animationGroup'. Une animation groupée hérite des mêmes attibuts xml qu'une animation classique. A ceci près qu'elle peut avoir plusieurs noeuds d'animation. On pourra aussi utiliser la syntaxe 'debut_chemin_scene*' pour pouvoir décrire un ensemble de noeuds d'animation commencant par 'debut_chemin_scene'.


III.2 Manipuler une séquence d'images

      
   ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                  sur le noeud <level> faire 'new Sequence'

   CLASSE: 'cooki3d::Sequence'
   Un objet de cette classe permet de manipuler comme un média une instance de 'osg::Sequence' contenu dans la scène. Cette classe 'osg' est un outil qui permet dérouler une liste de frame précalculée en fonction du temps.

   ATTRIBUTS xml/c++ :
   > le nom de l'instance ('nom')
   > booléen déterminant si l'instance doit prendre les valeurs du modèle automatiquement ou si il faut découper l'animation du modèle selon les trois paramètres 'debut', 'fin' et 'fps' de manière manuelle.
   > (en mode manuel) numéro de la première "image" de la séquence ('debut')
   > (en mode manuel) numéro de la dernière "image" de la séquence ('fin')
   > (en mode manuel) nombre d'images par secondes ('fps')
   > type de mouvement souhaité de la séquence ('loopMode')
   > état de la séquence au démarrage de l'application ('sequenceMode')
   > chemin du noeud osg contenant la séquence [osg::Sequence] ('nodeName')

III.3 Manipuler un son


   ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                  sur le noeud <level> faire 'new Sound'

   CLASSE : 'cooki3d::Sound'
   Cette classe utilse la SDL pour lire et mixer les fichiers '.wav'. Elle peut être utlisée pour les petits son et bruitages.
   
   ATTRIBUTS xml/c++ :
   > le nom de l'instance ('nom')
   > le nom du fichier à chargé ('fic')
   > le volume du son ('pcVolume')
   > boolean déterminant si il faut lancer la lecture au démarrage ('playOnStart')

III.4 Manipuler un son mp3


   ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                  sur le noeud <level> faire 'new SoundMpeg'

   CLASSE : 'cooki3d::SoundMpeg' (SUPER CLASSE : 'cooki3d::Sound')
   Cette classe utilse la SDL et libsmpeg pour lire et mixer les fichiers '.mp3'. Elle peut être utlisé pour les gros fichiers.

   ATTRIBUTS xml/c++ :
   Les attributs sont hérités et similaires à la classe 'cooki3d::Sound'

           

III.5 Manipuler une barre de temps "threadée" et ses commandes clefs


   ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                  sur le noeud <level> faire 'new TimeBar'
                  sur le noeud <timeBar> faire 'new Command'...
   
   CLASSE : 'cooki3d::TimeBar' et 'cooki3d::Command'
   La barre de temps évolue parallèlement (Thread) au proccesus de l'application et execute les commandes paramétrés au fûr et à mesure du déroulement du temps. Une commande peut être une fonction ou une méthode C++.
   Ainsi une commande est associée à un code. Il nécéssite donc la création d'un bloc 'library' qui sera lié au level concerné. Le patron du code sera généré automatiquement si l'option 'autogen' reste cochée. Ainsi l'utilisateur a juste à ajouter le code spécifique qui doit être executer lors du déclenchement de la commande.
   
   ATTRIBUTS xml/c++ de 'cooki3d::TimeBar':
   > le nom de l'instance ('nom')
   > la taille de la barre de temps en secondes ('timeSize')
   > booléen indiquant s'il faut lire en boucle ('loop')
   > booléen déterminant si il faut lancer la lecture au démarrage ('playOnStart')

   ATTRIBUTS xml/c++ de 'cooki3d::Command':
   > le nom de l'instance ('nom')
   > l'instant ou la commande sera executée ('time')
   > booléen déterminant si le code est auto généré ('autogen')
   > le code associé à la commande ('code')

   TIPS:
   > pour grouper plusieurs commandes sur un même code, vous pouvez décocher l'option 'autogen' et utiliser un code déjà existant d'une autre commande.

   NEXT VERSION:
   La prochaine version (>=0.22) supportera :
   > la possibilité d'utiliser des commandes sous forme de script (tcl, lua...). Cela a déjà été réalisé dans le projet Zdm en tcl par un simple héritage sur la classe 'cooki3d::Command'.
   

IV. Les terrains


IV.1 Manipuler un terrain (un champs d'altitudes)


   ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                  sur le noeud <level> faire 'new SolGravitation'
   
   CLASSE : 'cooki3d::SolGravitation'
   Cette classe permet de charger (éventuellement de générer) et d'utiliser un champs d'altitude. Celle-ci est principalement utilisée par les classes héritant 'cooki3d::Character'. Il peut y avoir plusieurs champs d'altitudes chargés (instance de 'SolGravitation'), c'est la première altitude trouvée pour la position donnée qui sera prise.
   
   ATTRIBUTS xml/c++ de 'cooki3d::SolGravitation':
   > le nom de l'instance ('nom')
   > le fichier à partir duquel les altitudes sont calculées ('heightMapGeo')
   > booléen déterminant si le fichier terrain doit apparaitre dans la scène
   > mode de détection choisi. Il y a deux modes possibles 'MODE_HEIGHTMAP' où une 'HeightMap' (une champs d'altitudes) précalculée est utilisé ou bien le 'MODE_DYNAMIC' qui effectue un lancé de rayon vertical à chaque consultation ('altitudeDetection').
   > booléen déterminant si le champs d'altitudes doit apparaitre ('heightMapVisible')
   > position et taille de la 'heightmap' ('x', 'y', 'altitude', 'scale')
   
   NOTE:
   > Il faut bien veiller à ce que la position et taille de la 'heightmap' corresponde à celles du fichier modèle qui sera visible, sinon les altitudes renvoyées ne correspondront pas à la position demandée et risque même sortir de la map et provoquer une erreur.



IV.2 Manipuler un terrain de collision (un champs d'altitude)


   ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                  sur le noeud <level> faire 'new SolCollision'
 
   CLASSE : 'cooki3d::SolCollisions'
   Cette classe permet de gérer des détections de collision via un champs d'altitudes. Elle hérite de tous les attributs de 'cooki3d::SolGravitation'. Dans le fonctionnement une instance de 'SolCollision' sera couplée avec l'instance courante de 'SolGravitation'. Pour qu'une collision soit détectée il faut que la hauteur prise sur l'instance de 'SolCollision' soit différente de celle prise sur l'instance de 'SolGravitation'. La map  de 'SolCollision' représente en faite le terrain avec en plus les objets bloquants dispercé sur celui-ci.

   ATTRIBUTS xml/c++ de 'cooki3d::SolCollision':
   Strictement les mêmes que pour 'cooki3d::SolGravitation'

   NOTE:
   > Ce sont les instance de 'cooki3d::Character' qui vont utiliser et coupler les 'SolCollision' avec les 'SolGravitation'. Il faut donc bien veiller à l'homogénéité du décors qui sera visible (position et taille) avec la map de 'SolCollision' et de 'SolGraviation'.
                  

V. Divers


V.1 Gérer une caméra contenue dans un fichier modèle


    ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                   sur le noeud <level> faire 'new Camera'

    CLASSE : 'cooki3d::Camera'
    Il s'agit de gérer une caméra contenue dans un modèle (par exemple une vue définie par un infographiste dans 3dsmax). Le plugin d'exportation osgExp exporte/traduit une caméra en un objet osg::MatrixTransform. La classe 'Camera' va donc récupérer ce noeud et permettre à l'utilisateur de 'switcher' sur celle-ci.

    ATTRIBUTS xml/c++ de 'cooki3d::Camera':
    > le nom de l'instance ('nom')
    > le chemin du noeud dans le modèle ('node')


V.2 Utiliser un noeud contenue dans un fichier modèle


    ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                   sur le noeud <level> faire 'new Camera'
    
    CLASSE : 'cooki3d::OsgNodeReference'
    Un OsgNodeReference peu faire référence à n'importe quel type de noeud contenu dans le modèle. Cette référence est récupéré au moment du chargement pour l'utilisateur puisse ensuite accèder directement au noeud qu'il a paramétré (même méthode que pour 'cooki3d::Camera').

    ATTRIBUTS xml/c++ de 'cooki3d::OsgNodeReference':
    > le nom de l'instance ('nom')
    > le chemin du noeud dans le modèle ('nodeName')
    > booléen déterminant si l'utilisateur veut insérer un noeud de transformation intermédiare au dessus du noeud qu'il a choisi pour pouvoir le déplacer facilement ('insertTransform')
    > type de la transformation à insérer ('transformType')


V.3 Créer un ligne directrice interpolée pour gérer un mouvement scénarisé

    
    CLASSE 'cooki3d::GuideLine'
    Cette classe n'existe pas encore. Elle devra servir à pouvoir donner à un personnage un mouvement déjà préparé/précalculé dans un modèle pour qu'il execute une trajectoire automatiquement, trajectoire qui sera généralement associé à une action précise.

    TIPS:
    > On peut faire cela manuellement en créant des osg::AnimationPath puis, en les affectant à l'animation path courant du personnage.

    NEXT VERSION:
    La prochaine version (>=0.22) supportera :
    > Création et disponibilité de cette classe


V.4 Déclarer un groupe de paramètres xml


    ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                   sur le noeud <level> faire 'new GroupParam'
   
    CLASSE 'cooki3d::GroupParam'
    Cette classe permet de passer des paramètres à l'application sous forme xml. Elle est principalement utilisée pour réaliser des plugins pour le framework cooki3d.


V.5 Ajouter un chemin de recherche pour une 'font' ou une image


    ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                   sur le noeud <level> faire 'add filePath'

    CLASSE Aucune

V.6 Ajouter un membre de classe dans un plugin

   
    ACTION dans le framework : sur le noeud <jeu> faire 'new Level'
                      sur le noeud <level> faire 'add userMember'
                   
    CLASSE: Aucune
       
    Un membre/attribut de classe sera associé à la classe attachée au level (exemple pour level0 : CLevel0). Il nécéssite donc la création d'un bloc 'library' qui sera lié au level concerné. Le patron du code sera généré automatiquement. Ainsi l'utilisateur pourra utiliser un attibut de classe spécifique qu'il faudra qu'il initialise et utilise dans les zones prévues à cet effet.

Last Updated ( Thursday, 16 November 2006 )
 
<< Start < Prev 1 2 Next > End >>

Results 1 - 10 of 12
 
      
      
 
 
Main Menu
Home
Web Online Examples
Getting Started
Experiences
Cooki3d Licence
Download
Professional Services
Documentation
Blog
Links
Advanced Search
Administrator
 
 
Web Partners