diguy_author.h

Go to the documentation of this file.

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

/*********************************************************************
 **
 *t  DI-Guy AI, Main Header File
 **
 *b    Link against: libdiguy
 */

#ifndef __diguy_author_H
#define __diguy_author_H

#include <diguy_constants.h>
#include <diguyAuthorInterface.h>

#include <declspec_diguy.h>

#ifdef __cplusplus
extern "C" {
#endif


/*****************************************************************************/
/*l
 *b  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.
 **
 *b  Arguments:
 **
 *a    create_func - pointer to function that creates a diguyAuthorInterface
 *a                  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.
 **
 *b  Callable From:
 **
 *-    - C++
 **
 *b  Returns:
 **
 **    0 on success, -1 on failure
 */
BDI_DECLSPEC_diguy
int diguy_author_initialize(diguyAuthorInterfaceCreateFunc* create_func);

/*l
 *b  Description:
 **
 **    This function returns whether or not DI-Guy Author functionality
 **    is enabled.
 **
 *b  Returns:
 **
 **    1 if DI-Guy Author enabled and initialized, 0 if not
 */
BDI_DECLSPEC_diguy
int diguy_author_get_author_enabled();

/*l
 *b  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.
 **
 *b  Returns:
 **
 **    pointer of type diguyAuthorInterface
 */
BDI_DECLSPEC_diguy
diguyAuthorInterface* diguy_author_get_author_interface();


#ifdef __cplusplus
}
#endif

#endif /* __diguy_author_H */