[Opal-commits] web todo.txt,NONE,1.1 documentation.html,1.2,1.3 index.html,1.3,1.4
Status: Inactive
Brought to you by:
tylerstreeter
|
From: tylerstreeter <tyl...@us...> - 2005-03-01 05:06:45
|
Update of /cvsroot/opal/web In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv21943 Modified Files: documentation.html index.html Added Files: todo.txt Log Message: added ragdoll sample xml file to documentation Index: documentation.html =================================================================== RCS file: /cvsroot/opal/web/documentation.html,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** documentation.html 25 Feb 2005 23:07:09 -0000 1.2 --- documentation.html 1 Mar 2005 05:06:34 -0000 1.3 *************** *** 25,44 **** <o:Author>Tyler Streeter</o:Author> <o:LastAuthor>Tyler Streeter</o:LastAuthor> ! <o:Revision>85</o:Revision> ! <o:TotalTime>94</o:TotalTime> <o:Created>2004-06-05T15:20:00Z</o:Created> ! <o:LastSaved>2005-02-25T23:06:00Z</o:LastSaved> <o:Pages>1</o:Pages> ! <o:Words>226</o:Words> ! <o:Characters>1291</o:Characters> <o:Company>none</o:Company> ! <o:Lines>10</o:Lines> <o:Paragraphs>3</o:Paragraphs> ! <o:CharactersWithSpaces>1514</o:CharactersWithSpaces> <o:Version>10.6714</o:Version> </o:DocumentProperties> </xml><![endif]--><!--[if gte mso 9]><xml> <w:WordDocument> ! <w:Zoom>BestFit</w:Zoom> <w:BrowserLevel>MicrosoftInternetExplorer4</w:BrowserLevel> </w:WordDocument> --- 25,44 ---- <o:Author>Tyler Streeter</o:Author> <o:LastAuthor>Tyler Streeter</o:LastAuthor> ! <o:Revision>87</o:Revision> ! <o:TotalTime>95</o:TotalTime> <o:Created>2004-06-05T15:20:00Z</o:Created> ! <o:LastSaved>2005-03-01T05:05:00Z</o:LastSaved> <o:Pages>1</o:Pages> ! <o:Words>239</o:Words> ! <o:Characters>1367</o:Characters> <o:Company>none</o:Company> ! <o:Lines>11</o:Lines> <o:Paragraphs>3</o:Paragraphs> ! <o:CharactersWithSpaces>1603</o:CharactersWithSpaces> <o:Version>10.6714</o:Version> </o:DocumentProperties> </xml><![endif]--><!--[if gte mso 9]><xml> <w:WordDocument> ! <w:Zoom>90</w:Zoom> <w:BrowserLevel>MicrosoftInternetExplorer4</w:BrowserLevel> </w:WordDocument> *************** *** 99,103 **** </style> <![endif]--><!--[if gte mso 9]><xml> ! <o:shapedefaults v:ext="edit" spidmax="45058"> <o:colormenu v:ext="edit" fillcolor="white"/> </o:shapedefaults></xml><![endif]--><!--[if gte mso 9]><xml> --- 99,103 ---- </style> <![endif]--><!--[if gte mso 9]><xml> ! <o:shapedefaults v:ext="edit" spidmax="46082"> <o:colormenu v:ext="edit" fillcolor="white"/> </o:shapedefaults></xml><![endif]--><!--[if gte mso 9]><xml> *************** *** 205,208 **** --- 205,212 ---- <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><a + href="files/ragdoll.xml">Ragdoll OPAL XML</a>: file containing a ragdoll + blueprint.<o:p></o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><o:p> </o:p></span></p> + <p class=MsoNormal><span style='font-family:"Book Antiqua";color:black'><a href="api/index.html">API Documentation</a>: a detailed description of everything in OPAL.</span><span style='font-family:"Book Antiqua";mso-bidi-font-family: --- NEW FILE: todo.txt --- For Version 0.3.0 ================= * add a faq to docs page/manual - Q: which physics engines will be supported in the future? - A: The focus is on cross-platform, Open Source physics engines. Currently there are not a lot of options available besides ODE, but if other fully-featured engines of this type come along, OPAL will be ready to integrate them. * post api notes For Version 0.4.0 ================= Website Contents ================ * change log somewhere? * contact - add bios? Preliminary Manual Notes ======================== * Describe 5 primary objects, using diagrams. - Simulator: object factory; handles collision detection and physics simulation - Solid: physical objects; contains various shapes used for collision detection; can be static or dynamic; in a visual 3D application, Solids are usually the objects to render - Joint: connects two Solids and constrains their relative motion - Motor: applies forces/torques to Solids or Joints to achieve some desired effect - Sensor: acquires data from a simulation * Describe secondary objects: - Shapes - Materials - Blueprints * Other miscellaneous objects: described elsewhere - Force - RaycastResult - ProximityResult - CollisionEvent The main objects in OPAL are: simulators, solids, joints, and motors. Create a simulator, have the simulator create solids for you, add shapes to the solids, and add forces to the solids. Solids can take an initial matrix transform. Shapes added to a solid can take a matrix transform as an offset from the solid's center. A solid can return its transform matrix for drawing purposes (if a solid has multiple shapes, be sure to save their offset matrices for drawing later). Solids can be static, meaning that they don't move around in the simulation. Objects - classes - Simulator - Solid - Joint - Motor - Sensor - Blueprint - Data objects - SolidData - ShapeData (many different sub-types) - Shape type - JointData - MotorData (many different sub-types) - SensorData (many different sub-types) - Blueprint: contains lots of Data objects - other structs - Material - RayHit - collision event - Force - Joint axis - Joint limit Document ======== * specific object type properties - memory management: user managed vs. OPAL managed - initially enabled or disabled - user-created classes - ContactSensor - JointBreakSensor - custom Motors * Most objects can be created in two ways - create the object (automatically uses default values); change specific parameters - setup a Data object and pass it into the object's init function - some objects (e.g. Joints) must have init called before using them * Shapes can be added to solids in two ways - add a ShapeBP to a SolidBP, then create the Solid - create a Solid, then add a shape by passing it a ShapeBP * custom motors cannot be saved to/loaded from an XML file * for derived classes (custom motors, event handlers), put OPAL_CALL in front of public function names * most objects are created and destroyed by the Simulator, but some are user-managed - examples of user-managed: - most structs - custom motors - event handlers * all angles are in degrees * be aware of floating point accuracy issues - use the same precision for OPAL reals and ODE dReals * two ways to create objects 1.) have the simulator create the object with default settings, then set its parameters manually Solid* s = sim->createSolid(); s->setStatic(true); s->setTransform(Matrix44r()); 2.) have the simulator create the object by passing in a blueprint Index: index.html =================================================================== RCS file: /cvsroot/opal/web/index.html,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** index.html 26 Feb 2005 03:27:48 -0000 1.3 --- index.html 1 Mar 2005 05:06:34 -0000 1.4 *************** *** 25,39 **** <o:Author>Tyler Streeter</o:Author> <o:LastAuthor>Tyler Streeter</o:LastAuthor> ! <o:Revision>92</o:Revision> <o:TotalTime>185</o:TotalTime> <o:Created>2004-06-05T15:20:00Z</o:Created> ! <o:LastSaved>2005-02-26T03:27:00Z</o:LastSaved> <o:Pages>1</o:Pages> ! <o:Words>348</o:Words> ! <o:Characters>1990</o:Characters> <o:Company>none</o:Company> [...977 lines suppressed...] color:black'><span style='mso-list:Ignore'>o<span style='font:7.0pt "Times New Roman"'> --- 682,686 ---- mso-bidi-font-family:Arial;color:black'>Velocity sensors<o:p></o:p></span></p> <p class=MsoNormal style='margin-left:68.3pt;text-indent:-.25in;mso-list: ! l6 level3 lfo8;tab-stops:list 68.3pt 1.5in'><![if !supportLists]><span style='font-family:"Courier New";mso-fareast-font-family:"Courier New"; color:black'><span style='mso-list:Ignore'>o<span style='font:7.0pt "Times New Roman"'> *************** *** 688,692 **** mso-bidi-font-family:Arial;color:black'>Acceleration sensors<o:p></o:p></span></p> <p class=MsoNormal style='margin-left:68.3pt;text-indent:-.25in;mso-list: ! l8 level3 lfo8;tab-stops:list 68.3pt 1.5in'><![if !supportLists]><span style='font-family:"Courier New";mso-fareast-font-family:"Courier New"; color:black'><span style='mso-list:Ignore'>o<span style='font:7.0pt "Times New Roman"'> --- 688,692 ---- mso-bidi-font-family:Arial;color:black'>Acceleration sensors<o:p></o:p></span></p> <p class=MsoNormal style='margin-left:68.3pt;text-indent:-.25in;mso-list: ! l6 level3 lfo8;tab-stops:list 68.3pt 1.5in'><![if !supportLists]><span style='font-family:"Courier New";mso-fareast-font-family:"Courier New"; color:black'><span style='mso-list:Ignore'>o<span style='font:7.0pt "Times New Roman"'> |