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

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

GTPD - Jungle Rumble - integrate into GTP SVN structure

Line 
1#ifndef NX_PHYSICS_NXPRISMATICJOINT
2#define NX_PHYSICS_NXPRISMATICJOINT
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#include "NxJoint.h"
16
17class NxPrismaticJointDesc;
18
19/**
20 \brief A prismatic joint permits relative translational movement between two bodies along
21 an axis, but no relative rotational movement.
22
23 \image html prismJoint.png
24
25 <h3>Creation</h3>
26
27 \include NxPrismaticJoint_Create.cpp
28
29 <h3>Visulizations:</h3>
30\li #NX_VISUALIZE_JOINT_LOCAL_AXES
31\li #NX_VISUALIZE_JOINT_WORLD_AXES
32\li #NX_VISUALIZE_JOINT_LIMITS
33\li #NX_VISUALIZE_JOINT_ERROR
34\li #NX_VISUALIZE_JOINT_FORCE
35\li #NX_VISUALIZE_JOINT_REDUCED
36
37 @see NxPrismaticJointDesc NxJoint NxScene.createJoint()
38*/
39class NxPrismaticJoint: public NxJoint
40        {
41        public:
42        /**
43        \brief Use this for changing a significant number of joint parameters at once.
44
45        Use the set() methods for changing only a single property at once.
46
47        \param[in] desc The descriptor used to set the state of the object.
48
49        <b>Platform:</b>
50        \li PC SW: Yes
51        \li PPU  : No
52        \li PS3  : Yes
53        \li XB360: Yes
54
55        @see saveToDesc NxPrismaticJointDesc
56        */
57        virtual void loadFromDesc(const NxPrismaticJointDesc& desc) = 0;
58
59        /**
60        \brief Writes all of the object's attributes to the desc struct 
61
62        \param[out] desc The descriptor used to retrieve the state of the object.
63
64        <b>Platform:</b>
65        \li PC SW: Yes
66        \li PPU  : No
67        \li PS3  : Yes
68        \li XB360: Yes
69
70        @see loadFromDesc NxPrismaticJointDesc
71        */
72        virtual void saveToDesc(NxPrismaticJointDesc& desc) = 0;
73        };
74
75/** @} */
76#endif
77
78
79//AGCOPYRIGHTBEGIN
80///////////////////////////////////////////////////////////////////////////
81// Copyright © 2005 AGEIA Technologies.
82// All rights reserved. www.ageia.com
83///////////////////////////////////////////////////////////////////////////
84//AGCOPYRIGHTEND
85
Note: See TracBrowser for help on using the repository browser.