diguy_module_sim_physx.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2015 VT MAK
 ** All rights reserved. 
 *********************************************************************/

/*********************************************************************
 **
 *t  DI-Guy API, PhysX Simulation Module
 */

#ifndef __diguy_module_sim_physx_H
#define __diguy_module_sim_physx_H

extern "C" {

#include <declspec_diguy.h>


/*****************************************************************************
 **
 *2  Init Structure
 **
 **
 */

typedef struct diguyModuleSimPhysXInit
{
        diguyModuleSimPhysXInit::diguyModuleSimPhysXInit()
                :
                physx_px_physics(NULL),
                physx_px_scene(NULL),
                ground_plane_z(0.0f),
                enable_vrd_connection(0)
                {}

        /*l
         *b  Description:
         **
         **    An optional pointer to an physx::PxPhysics object, if the module should
         **    use an already existing PhysX session.  If NULL DI-Guy will create
         **    a new session.
         */
        void* physx_px_physics;

        /*l
         *b  Description:
         **
         **    An optional pointer to an physx::PxScene object, if the module should use
         **    an already existing PhysX scene.  If NULL DI-Guy will create a new
         **    scene.
         */
        void* physx_px_scene;

        /*l
         *b  Description:
         **
         **    The initial altitude of a ground plane.  If this value is set to
         **    -10000.0 or lower no ground plane will be enabled.
         */
        float ground_plane_z;

        /*l
         *b  Description:
         **
         **    Set to 1 to enable a connection to the PhysX VRD debugger.
         */
        int enable_vrd_connection;

} diguyModuleSimPhysXInit;


/*****************************************************************************
 **
 *2  Functions
 **
 */

/*l
 *b  Description:
 **
 **    This function tells DI-Guy that it should use the PhysX simulation
 **    library for doing physics simulations on selected characters.
 **
 **    This function must be called after the main DI-Guy initialize call
 **    (e.g., diguy_ogl_initialize()), and before any scenario is created.
 **
 **    The PhysX system software must be installed on any computer that will
 **    use this module.  The directory 3rdparty/physx under the DI-Guy
 **    install directory has system software installed.  Be sure to read the
 **    README.TXT file!
 **
 **    See the "Physics Module Functions" section in the diguyApp
 **    documentation for functions that affect the simulation system.
 **
 *b  Returns:
 **
 **    0 on success, -1 on failure
 **
 *b  Example:
 **
 *e    diguy_ogl_initialize(NULL);
 *e
 *e    diguyModuleSimPhysXInit init;
 *e    init.ground_plane_z = 2.0f;
 *e    diguy_sim_physx_initialize(&init);
 *e
 *e    diguyScenario* scenario = diguy_create_scenario();
 */
BDI_DECLSPEC_diguy
int diguy_sim_physx_initialize(diguyModuleSimPhysXInit* init);

/*l
 *b  Description:
 **
 **    This function tells DI-Guy to shut down the PhysX simulation library
 **    module.
 **
 *b  Returns:
 **
 **    0 on success, -1 on failure
 **
 */
BDI_DECLSPEC_diguy
int diguy_sim_physx_deinitialize();


} /* end extern "C" */

#endif /* __diguy_module_sim_physx_H */


/*********************************************************************
 ** Copyright (c) 1992-2015 VT MAK
 ** All rights reserved. 
 *********************************************************************/