Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Jan 27, 2016, 6:50:51 PM (8 years ago)
Author:
muemart
Message:

Fix loads of doxygen warnings and other documentation issues

File:
1 edited

Legend:

Unmodified
Added
Removed

  • code/trunk/src/modules/hover/HoverOrigin.h

    r11071 r11099  
    4141        The HoverOrigin implements the playing field @ref orxonox::Hover "Hover" takes place in and allows for many parameters of the minigame to be set.
    4242        The playing field resides in the x,z-plane, with the x-axis being the horizontal axis and the z-axis being the vertical axis.
    43        
    44         Various parameters can be set:
    45         - The <b>dimension</b> is a vector, that defines the width and height of the playing field. The default is <em>(200, 120)</em>.
    46         - The <b>balltemplate</b> is a template that is applied to the @ref orxonox::HoverPlatform "HoverPlatform", it can be used to attach different things to it, e.g. its @ref orxonox::Model "Model". See below for a usage example.
    47         - The <b>battemplate</b> is a template that is applied to the @ref orxonox::HoverPlatform "HoverFigure", it can be used to attach different things to it, e.g. its @ref orxonox::Model "Model". See below for a usage example.
    48         - The <b>ballspeed</b> is the speed with which the @ref orxonox::HoverPlatform "HoverPlatform" moves. The default is <em>100</em>.
    49         - The <b>ballaccfactor</b> is the acceleration factor for the @ref orxonox::HoverPlatform "HoverPlatform". The default is <em>1.0</em>.
    50         - The <b>batspeed</b> is the speed with which the @ref orxonox::HoverFigure "HoverFigures" move. The default is <em>60</em>.
    51         - The <b>batlength</b> is the length of the @ref orxonox::HoverFigure "HoverFigures" as the percentage of the height of the playing field. The default is <em>0.25</em>.
    52        
    53         An example in XML of the HoverOrigin would be:
    54        
    55         First the needed templates:
    56         The template for the @ref orxonox::HoverPlatform "HoverPlatform".
    57         @code
    58         <Template name="Hoverball">
    59           <HoverPlatform>
    60             <attached>
    61               <Model mesh="sphere.mesh" scale="2" />
    62               <ParticleSpawner name="hiteffect" position="0,0,0" source="Orxonox/sparks2" lifetime="0.01" autostart="0" mainstate="spawn" />
    63             </attached>
    64             <eventlisteners>
    65               <EventTarget target="hiteffect" />
    66             </eventlisteners>
    67           </HoverPlatform>
    68         </Template>
    69         @endcode
    70         As can be seen, a sphere is attached as the @ref orxonox::Model "Model" for the @ref orxonox::HoverPlatform "HoverPlatform", and also an @ref orxonox::EventListener "EventListener" that triggers a @ref orxonox::ParticleSpawner "ParticleSpawner", whenever the ball hits the boundaries is attached.
    71        
    72         Additionally the template for the @ref orxonox::HoverFigure "HoverFigure".
    73         @code
    74         <Template name="Hoverbatcameras" defaults="0">
    75           <HoverFigure>
    76             <camerapositions>
    77               <CameraPosition position="0,200,0" pitch="-90" absolute="true" />
    78             </camerapositions>
    79           </HoverFigure>
    80         </Template>
    81 
    82         <Template name="Hoverbat">
    83           <HoverFigure camerapositiontemplate=Hoverbatcameras>
    84             <attached>
    85               <Model position="0,0,3" mesh="cube.mesh" scale3D="14,2,2" />
    86             </attached>
    87           </HoverFigure>
    88         </Template>
    89         @endcode
    90         As can be seen, there are actually two templates. The first template is needed to set the camera for the @ref orxonox::HoverFigure "HoverFigure". The second template ist the actual template for the @ref orxonox::HoverFigure "HoverFigure", the template for the camera position is added and a @ref orxonox::Model "Model" for the @ref orxonox::HoverFigure "HoverFigure" is attached.
    91         propellerTemplate_
    92         Finally the HoverOrigin is created.
    93         @code
    94         <HoverOrigin name="Hovercenter" dimension="200,120" balltemplate="Hoverball" battemplate="Hoverbat" ballspeed="200" ballaccfactor="1.0" batspeed="130" batlength="0.25">
    95           <attached>
    96             <Model position="0,0,60" mesh="cube.mesh" scale3D="105,1,1" />
    97             <Model position="0,0,-60" mesh="cube.mesh" scale3D="105,1,1" />
    98           </attached>
    99         </HoverOrigin>
    100         @endcode
    101         All parameters are specified. And also two @ref orxonox::Model "Models" (for the upper and lower boundary) are attached.
    102        
    103         For a more elaborate example, have a look at the <code>Hover.oxw</code> level file.
     43        For an example, have a look at the <code>Hover.oxw</code> level file.
    10444
    10545    */
Note: See TracChangeset for help on using the changeset viewer.