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

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

#include "Nxp.h"

#include "NxJoint.h"
class NxPointOnLineJointDesc;

/**
 \brief A point on line joint constrains a point on one body to only move along
 a line attached to another body.

 The starting point of the joint is defined as the anchor point. The line
 through this point is specified by its direction (axis) vector.

 \image html pointOnLineJoint.png

 <h3>Creation</h3>

 \include NxPointOnLineJoint_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 NxPointOnLineJointDesc NxScene.createJoint() NxJoint
*/
class NxPointOnLineJoint: 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() NxPointOnLineJointDesc
        */
        virtual void loadFromDesc(const NxPointOnLineJointDesc& 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() NxPointOnLineJointDesc
        */
        virtual void saveToDesc(NxPointOnLineJointDesc& desc) = 0;
        };

/** @} */
#endif


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