source: GTP/trunk/App/Games/Jungle_Rumble/src/physic/physics/include/NxCylindricalJoint.h @ 1378

Revision 1378, 2.2 KB checked in by giegl, 18 years ago (diff)

GTPD - Jungle Rumble - integrate into GTP SVN structure

Line 
1#ifndef NX_PHYSICS_NXSLIDINGJOINT
2#define NX_PHYSICS_NXSLIDINGJOINT
3/*----------------------------------------------------------------------------*\
4|
5|                                               Public Interface to NovodeX Technology
6|
7|                                                            www.novodex.com
8|
9\*----------------------------------------------------------------------------*/
10/** \addtogroup physics
11  @{
12*/
13
14#include "Nxp.h"
15
16#include "NxJoint.h"
17class NxCylindricalJointDesc;
18
19/**
20\brief Cylindrical Joints permit relative translational movement between two bodies along
21 an axis, and also relative rotation along the axis.
22
23
24 \image html cylinderJoint.png
25
26 <h3>Creation</h3>
27
28 Example:
29
30 \include NxCylindricalJoint_Create.cpp
31
32<h3>Visulizations:</h3>
33\li #NX_VISUALIZE_JOINT_LOCAL_AXES
34\li #NX_VISUALIZE_JOINT_WORLD_AXES
35\li #NX_VISUALIZE_JOINT_LIMITS
36\li #NX_VISUALIZE_JOINT_ERROR
37\li #NX_VISUALIZE_JOINT_FORCE
38\li #NX_VISUALIZE_JOINT_REDUCED
39
40 @see NxCylindricalJointDesc NxJoint NxScene.createJoint()
41*/
42class NxCylindricalJoint : public NxJoint
43        {
44        public:
45        /**
46        \brief Use this for changing a significant number of joint parameters at once.
47
48        Use the set() methods for changing only a single property at once.
49
50        <b>Sleeping:</b> Does <b>NOT</b> wake the associated actor up automatically.
51
52        \param[in] desc The descriptor used to set the state of the object.
53
54        <b>Platform:</b>
55        \li PC SW: Yes
56        \li PPU  : No
57        \li PS3  : Yes
58        \li XB360: Yes
59
60        @see saveToDesc() NxCylindricalJointDesc
61        */
62        virtual void loadFromDesc(const NxCylindricalJointDesc& desc) = 0;
63
64        /**
65        \brief Writes all of the object's attributes to the desc struct
66
67        \param[out] desc The descriptor used to retrieve the state of the object.
68
69        <b>Platform:</b>
70        \li PC SW: Yes
71        \li PPU  : No
72        \li PS3  : Yes
73        \li XB360: Yes
74       
75        @see loadFromDesc() NxCylindricalJointDesc
76        */
77        virtual void saveToDesc(NxCylindricalJointDesc& desc) = 0;
78        };
79
80/** @} */
81#endif
82
83
84//AGCOPYRIGHTBEGIN
85///////////////////////////////////////////////////////////////////////////
86// Copyright © 2005 AGEIA Technologies.
87// All rights reserved. www.ageia.com
88///////////////////////////////////////////////////////////////////////////
89//AGCOPYRIGHTEND
90
Note: See TracBrowser for help on using the repository browser.