DI-Guy AI, Main Header File

Generated from diguy_author.h

DI-Guy API Version 12.5.1

This file was automatically generated from diguy_author.h. Do not edit this file directly; the changes will be lost.
Includes: diguy_constants.h | diguyAuthorInterface.h | declspec_diguy.h

Contents:

Alphabetical Index

Link against: libdiguy

Initialization Functions

function diguy_author_initialize

Prototype:

int diguy_author_initialize(diguyAuthorInterfaceCreateFunc* create_func);
Description:

This function enables DI-Guy Author. It should be called after the main DI-Guy initialize call.

Note that DI-Guy Author will deinitialize automatically when DI-Guy shuts down.

Arguments:

create_funcpointer to function that creates a diguyAuthorInterface subclass object
DI-Guy Author relies on receiving input from the Host IG that is integrating DI-Guy Author functionality. To do this, the diguyAuthorInterface class needs to be subclassed, with the proper virtual functions overridden.

DI-Guy uses this indirect approach to creating objects instead of just setting the object directly to avoid potential memory model problems on some platforms, that can result in difficult to debug problems.

Callable From:

Returns:

0 on success, -1 on failure

function diguy_author_get_author_enabled

Prototype:

int diguy_author_get_author_enabled();
Description:

This function returns whether or not DI-Guy Author functionality is enabled.

Returns:

1 if DI-Guy Author enabled and initialized, 0 if not

function diguy_author_get_author_interface

Prototype:

diguyAuthorInterface* diguy_author_get_author_interface();
Description:

This function returns a pointer to a diguyAuthorInterface object. Member functions in this object can be used to communicate input, e.g. mouse clicks or key presses, to DI-Guy so it can create and edit DI-Guy characters and objects in the Host IG.

Returns:

pointer of type diguyAuthorInterface

Alphabetical Index



Copyright (C) 1992-2012 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/78 Fourth Avenue/Waltham MA 02451.