C++ SDK Reference  12.5
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
diguy_module_script_lua.h
Go to the documentation of this file.
1 
2 /*
3  * Copyright (C) 1992-2013 Boston Dynamics
4  * ALL RIGHTS RESERVED.
5  *
6  * These coded instructions, statements, and computer programs
7  * contain unpublished proprietary information of Boston Dynamics
8  * and are protected by Copyright Laws of the United States.
9  * They may not be used, duplicated, or disclosed in any form, in
10  * whole or in part, without the prior written consent from Boston
11  * Dynamics.
12  *
13  * RESTRICTED RIGHTS LEGEND
14  * Use, duplication, or disclosure by the government is subject
15  * to restrictions as set forth in FAR 52.227.19(c)(2) or
16  * subparagraph (c)(1)(ii) of the Rights in Technical Data and
17  * Computer Software clause at DFARS 252.227-7013 and/or in
18  * similar or successor clauses in the FAR, or the DOD or NASA
19  * FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the
20  * Commercial Computer Software--Restricted Rights at 48 CFR
21  * 52.227-19, as applicable. Unpublished-rights reserved under
22  * the Copyright Laws of the United States.
23  * Contractor/Manufacturer is:
24  * Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.
25  */
26 
27 /*********************************************************************
28  **
29  *t DI-Guy API, Lua Script Module
30  **
31  *b Link against: libdiguy_module_script_lua
32  */
33 
34 #ifndef __diguy_module_script_lua_H
35 #define __diguy_module_script_lua_H
36 
37 extern "C" {
38 
39 #include <declspec_diguy.h>
40 
41 /*****************************************************************************
42  **
43  *2 Functions
44  **
45  */
46 
47 /*l
48  *b Description:
49  **
50  ** This function tells DI-Guy that it should use the Lua
51  ** interpreter for interpreting scripts. It should be called
52  ** along with the other diguy_*_initialize() calls, after the
53  ** primary graphics initialization is made.
54  **
55  *b Returns:
56  **
57  ** 0 on success, -1 on failure
58  **
59  *b Example:
60  **
61  *e diguy_ogl_initialize(NULL);
62  *e diguy_script_lua_initialize();
63  */
64 BDI_DECLSPEC_diguy
65 int diguy_script_lua_initialize();
66 
67 
68 /*l
69  *b Description:
70  **
71  ** This function tells DI-Guy that it should shut down the Lua
72  ** interpreter for interpreting scripts. It should be called
73  ** along with the other diguy_*_deinitialize() calls, before
74  ** the primary diguy_deinitialize() call.
75  **
76  *b Returns:
77  **
78  ** 0 on success, -1 on failure
79  **
80  *b Example:
81  **
82  *e diguy_script_lua_deinitialize();
83  *e diguy_deinitialize();
84  */
85 BDI_DECLSPEC_diguy
86 int diguy_script_lua_deinitialize();
87 
88 } /* end extern "C" */
89 
90 #endif /* __diguy_module_script_lua_H */
91 
92 
93 /*
94  * Copyright (C) 1992-2013 Boston Dynamics
95  * ALL RIGHTS RESERVED.
96  *
97  * These coded instructions, statements, and computer programs
98  * contain unpublished proprietary information of Boston Dynamics
99  * and are protected by Copyright Laws of the United States.
100  * They may not be used, duplicated, or disclosed in any form, in
101  * whole or in part, without the prior written consent from Boston
102  * Dynamics.
103  *
104  * RESTRICTED RIGHTS LEGEND
105  * Use, duplication, or disclosure by the government is subject
106  * to restrictions as set forth in FAR 52.227.19(c)(2) or
107  * subparagraph (c)(1)(ii) of the Rights in Technical Data and
108  * Computer Software clause at DFARS 252.227-7013 and/or in
109  * similar or successor clauses in the FAR, or the DOD or NASA
110  * FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the
111  * Commercial Computer Software--Restricted Rights at 48 CFR
112  * 52.227-19, as applicable. Unpublished-rights reserved under
113  * the Copyright Laws of the United States.
114  * Contractor/Manufacturer is:
115  * Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.
116  */
117