DI-Guy API, PhysX Simulation Module

Generated from diguy_module_sim_physx.h

DI-Guy API Version 12.5.1

This file was automatically generated from diguy_module_sim_physx.h. Do not edit this file directly; the changes will be lost.

Includes: declspec_diguy.h

Contents:

Alphabetical Index

Init Structure

struct diguyModuleSimPhysXInit

typedef struct diguyModuleSimPhysXInit
{
    diguyModuleSimPhysXInit::diguyModuleSimPhysXInit()
        :
        physx_px_physics(NULL),
        physx_px_scene(NULL),
        ground_plane_z(0.0f),
        enable_vrd_connection(0)
        {}
    void* physx_px_physics;
    void* physx_px_scene;
    float ground_plane_z;
    int enable_vrd_connection;
} diguyModuleSimPhysXInit;

variable diguyModuleSimPhysXInit::physx_px_physics

void* physx_px_physics;
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.

variable diguyModuleSimPhysXInit::physx_px_scene

void* physx_px_scene;
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.

variable diguyModuleSimPhysXInit::ground_plane_z

float ground_plane_z;
Description:

The initial altitude of a ground plane. If this value is set to -10000.0 or lower no ground plane will be enabled.

variable diguyModuleSimPhysXInit::enable_vrd_connection

int enable_vrd_connection;
Description:

Set to 1 to enable a connection to the PhysX VRD debugger.

Functions

function diguy_sim_physx_initialize

Prototype:
int diguy_sim_physx_initialize(diguyModuleSimPhysXInit* init);
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.
Returns:

0 on success, -1 on failure
Example:
diguy_ogl_initialize(NULL);

diguyModuleSimPhysXInit init;
init.ground_plane_z = 2.0f;
diguy_sim_physx_initialize(&init);

diguyScenario* scenario = diguy_create_scenario();

function diguy_sim_physx_deinitialize

Prototype:
int diguy_sim_physx_deinitialize();
Description:

This function tells DI-Guy to shut down the PhysX simulation library module.
Returns:

0 on success, -1 on failure

Alphabetical Index

These coded instructions, statements, and computer programs contain unpublished proprietary information of Boston Dynamics and are protected by Copyright Laws of the United States. They may not be used, duplicated, or disclosed in any form, in whole or in part, without the prior written consent from Boston Dynamics.

RESTRICTED RIGHTS LEGEND

Use, duplication, or disclosure by the government is subject to restrictions as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Sofware clause at DFARS 252.227-7013 and/or in similar or successor clauses in the FAR, or the DOD or NASA FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the Commercial Computer Software--Restricted Rights at 48 CFR 52.227-19, as applicable. Unpublished-rights reserved under the Copyright Laws of the United States.

Contractor/Manufacturer is:

Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.