PxConstraintDesc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2015, NVIDIA CORPORATION.  All rights reserved.
 *
 * NVIDIA CORPORATION and its licensors retain all intellectual property
 * and proprietary rights in and to this software, related documentation
 * and any modifications thereto.  Any use, reproduction, disclosure or
 * distribution of this software and related documentation without an express
 * license agreement from NVIDIA CORPORATION is strictly prohibited.
 */
// Copyright (c) 2004-2008 AGEIA Technologies, Inc. All rights reserved.
// Copyright (c) 2001-2004 NovodeX AG. All rights reserved.  


#ifndef PX_PHYSICS_NX_CONSTRAINTDESC
#define PX_PHYSICS_NX_CONSTRAINTDESC

#include "PxPhysXConfig.h"
#include "foundation/PxFlags.h"
#include "foundation/PxMath.h"
#include "foundation/PxVec3.h"
#include "common/PxBase.h"

#ifndef PX_DOXYGEN
namespace physx { namespace debugger { namespace comm {
#endif
    class PvdDataStream;
#ifndef PX_DOXYGEN
}}}
#endif

#ifndef PX_DOXYGEN
namespace physx
{
#endif

class PxConstraintConnector;
class PxRigidActor;
class PxScene;
class PxConstraintConnector;
class PxRenderBuffer;
class PxDeletionListener;


struct Px1DConstraintFlag
{
    enum Type
    {
        eSPRING                     = 1<<0,     
        eACCELERATION_SPRING        = 1<<1,     
        eRESTITUTION                = 1<<2,     
        eKEEPBIAS                   = 1<<3,     
        eOUTPUT_FORCE               = 1<<4,     
        eHAS_DRIVE_LIMIT            = 1<<5      
    };
};

typedef PxFlags<Px1DConstraintFlag::Type, PxU16> Px1DConstraintFlags;
PX_FLAGS_OPERATORS(Px1DConstraintFlag::Type, PxU16)


struct PxConstraintSolveHint
{
    enum Enum
    {
        eNONE               =   0,          
        eACCELERATION1      =   256,        
        eSLERP_SPRING       =   258,        
        eACCELERATION2      =   512,        
        eACCELERATION3      =   768,        
        eEQUALITY           =   1024,       
        eINEQUALITY         =   1025        
    };
};

PX_ALIGN_PREFIX(16)
struct Px1DConstraint
{
    PxVec3              linear0;                
    PxReal              geometricError;         
    PxVec3              angular0;               
    PxReal              velocityTarget;         

    PxVec3              linear1;                
    PxReal              minImpulse;             
    PxVec3              angular1;               
    PxReal              maxImpulse;             

    union
    {
        struct SpringModifiers
        {
            PxReal      stiffness;              
            PxReal      damping;                
        } spring;
        struct RestitutionModifiers
        {
            PxReal      restitution;            
            PxReal      velocityThreshold;      
        } bounce;
    } mods;

    PxReal              forInternalUse;         //< for internal use only
    PxU16               flags;                  
    PxU16               solveHint;              
} 
PX_ALIGN_SUFFIX(16);


struct PxConstraintVisualizationFlag
{
    enum Enum
    {
        eLOCAL_FRAMES   = 1,    
        eLIMITS         = 2     
    };
};

struct PxConstraintInvMassScale
{
//= ATTENTION! =====================================================================================
// Changing the data layout of this class breaks the binary serialization format.  See comments for 
// PX_BINARY_SERIAL_VERSION.  If a modification is required, please adjust the getBinaryMetaData 
// function.  If the modification is made on a custom branch, please change PX_BINARY_SERIAL_VERSION
// accordingly.
//==================================================================================================

    PxReal linear0;     
    PxReal angular0;    
    PxReal linear1;     
    PxReal angular1;    
};

typedef PxU32 (*PxConstraintSolverPrep)(Px1DConstraint* constraints,
                                        PxVec3& bodyAWorldOffset,
                                        PxU32 maxConstraints,
                                        PxConstraintInvMassScale& invMassScale,
                                        const void* constantBlock,
                                        const PxTransform& bodyAToWorld,
                                        const PxTransform& bodyBToWorld);

typedef void (*PxConstraintProject)(const void* constantBlock,
                                    PxTransform& bodyAToWorld,
                                    PxTransform& bodyBToWorld,
                                    bool projectToA);

class PxConstraintVisualizer
{
protected:
    virtual ~PxConstraintVisualizer(){}
public:
    virtual void visualizeJointFrames( const PxTransform& parent, const PxTransform& child ) = 0;

    virtual void visualizeLinearLimit( const PxTransform& t0, const PxTransform& t1, PxReal value, bool active ) = 0;

    virtual void visualizeAngularLimit( const PxTransform& t0, PxReal lower, PxReal upper, bool active) = 0;

    virtual void visualizeLimitCone( const PxTransform& t, PxReal ySwing, PxReal zSwing, bool active) = 0;

    virtual void visualizeDoubleCone( const PxTransform& t, PxReal angle, bool active) = 0;
};

typedef void (*PxConstraintVisualize)( PxConstraintVisualizer& visualizer,
                                      const void* constantBlock,
                                      const PxTransform& body0Transform,
                                      const PxTransform& body1Transform,
                                      PxU32 flags );


struct PxPvdUpdateType
{
    enum Enum
    {
        CREATE_INSTANCE,
        RELEASE_INSTANCE,
        UPDATE_ALL_PROPERTIES,
        UPDATE_SIM_PROPERTIES
    };
};

class PxConstraintConnector
{
public:
    virtual void*           prepareData()                                                   = 0;

    virtual bool            updatePvdProperties(physx::debugger::comm::PvdDataStream& pvdConnection,
                                                const PxConstraint* c,
                                                PxPvdUpdateType::Enum updateType) const     = 0;

    virtual void            onConstraintRelease()                                           = 0;

    virtual void            onComShift(PxU32 actor)                                         = 0;

    virtual void            onOriginShift(const PxVec3& shift)                              = 0;

    virtual void*           getExternalReference(PxU32& typeID)                             = 0;


    virtual PxBase* getSerializable()                                               = 0;


    virtual ~PxConstraintConnector() {}
};

#ifndef PX_DOXYGEN
} // namespace physx
#endif

#endif