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

#ifndef NX_PHYSICS_NXPOINTINPLANEJOINT
#define NX_PHYSICS_NXPOINTINPLANEJOINT
/*----------------------------------------------------------------------------*\
|
|                                               Public Interface to NovodeX Technology
|
|                                                            www.novodex.com
|
\*----------------------------------------------------------------------------*/
/** \addtogroup physics
  @{
*/

#include "Nxp.h"
#include "NxJoint.h"

class NxPointInPlaneJointDesc;

/**
 \brief A point in plane joint constrains a point on one body to only move inside
 a plane attached to another body.

 The starting point of the point is defined as the anchor point. The plane
 through this point is specified by its normal which is the joint axis vector.

 \image html pointInPlaneJoint.png

 <h3>Creation</h3>

 \include NxPointInPlaneJoint_Create.cpp

 <h3>Visulizations:</h3>
\li #NX_VISUALIZE_JOINT_LOCAL_AXES
\li #NX_VISUALIZE_JOINT_WORLD_AXES
\li #NX_VISUALIZE_JOINT_LIMITS
\li #NX_VISUALIZE_JOINT_ERROR
\li #NX_VISUALIZE_JOINT_FORCE
\li #NX_VISUALIZE_JOINT_REDUCED

 @see NxPointInPlaneJointDesc NxJoint NxScene.createJoint
*/
class NxPointInPlaneJoint : public NxJoint
        {
        public:
        /**
        \brief Use this for changing a significant number of joint parameters at once.

        Use the set() methods for changing only a single property at once.

        \param[in] desc The descriptor used to set the state of the object.

        <b>Platform:</b>
        \li PC SW: Yes
        \li PPU  : No
        \li PS3  : Yes
        \li XB360: Yes

        @see saveToDesc NxPointInPlaneJointDesc
        */
        virtual void loadFromDesc(const NxPointInPlaneJointDesc& desc) = 0;

        /**
        \brief Writes all of the object's attributes to the desc struct  .

        \param[out] desc The descriptor used to retrieve the state of the object.

        <b>Platform:</b>
        \li PC SW: Yes
        \li PPU  : No
        \li PS3  : Yes
        \li XB360: Yes

        @see loadFromDesc NxPointInPlaneJointDesc
        */
        virtual void saveToDesc(NxPointInPlaneJointDesc& desc) = 0;
        };

/** @} */
#endif


//AGCOPYRIGHTBEGIN
///////////////////////////////////////////////////////////////////////////
// Copyright © 2005 AGEIA Technologies.
// All rights reserved. www.ageia.com
///////////////////////////////////////////////////////////////////////////
//AGCOPYRIGHTEND