DI-Guy API, Main Header File

diguy_api.h

DI-Guy API Version 5.1.26

This file was automatically generated from comments in the C/C++ header file diguy_api.h. Do not edit this file directly; the changes will be lost. Please mail suggestions or corrections to diguy@bdi.com

Alphabetical Index

Includes: diguy_constants.h | declspec_diguy.h

The API is subject to change in future releases.

Link against: libdiguy

function diguy_set_cfg_file

Prototype:

diguy_set_cfg_file(const char* cfg_file);
Description:

This function sets the filename of the top-level configuration file that will be read by the DI-Guy software. The default is "diguy.cfg". This function must be called before diguy_initialize_[platform]().

It should rarely be necessary to use this function.

Callable From:

Arguments:

cfg_filefilename of desired configuration file
Returns:

0 on success, -1 on failure

C++ Example:

#include <diguy_graphics_ogl.h>

    diguy_set_cfg_file("custom.cfg");
    diguy_ogl_initialize(NULL);

function diguy_create_scenario

Prototype:

diguy_create_scenario();
Description:

This function allocates and returns an empty object of type diguyScenario. This is the top-level "container" of most DI-Guy types, and includes objects of type diguyCharacter, diguyViewCamera, diguySceneObject, and diguySignal.

Callable From:

Returns:

Pointer to object of type diguyScenario if successful; NULL if not.

Example:

    diguyScenario* sc = diguy_create_scenario();
    if (sc)
    {
        sc->load("my_scenario.dss");
    }

function diguy_destroy_scenario

Prototype:

diguy_destroy_scenario(diguyScenario* scenario);
Description:

This function destroys an object of type diguyScenario allocated by diguy_create_scenario().

Callable From:

Returns:

0 on success, -1 on failure

Example:

    diguyScenario* sc = diguy_create_scenario();
    // ...
    diguy_destroy_scenario(sc);

function diguy_deinitialize

Prototype:

diguy_deinitialize();
Description:

This function shuts down the DI-Guy software, removing all characters and cleaning up memory allocated by the library. No objects created by the DI-Guy software should be referenced after this call is made.

This function should only be called once per program execution.

Do not try to re-initialize the DI-Guy software after calling

this function.

Callable From:

Returns:

0 on success, -1 on failure

C++ Example:

    diguy_deinitialize();

Alphabetical Index


Copyright (C) 1992-2003

Boston Dynamics

ALL RIGHTS RESERVED.

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/515 Massachusetts Avenue/Cambridge MA 02139.