
This file was automatically generated from comments in the C/C++ header file diguyInfoPopup.h. Do not edit this file directly; the changes will be lost. Please mail suggestions or corrections to diguy@bdi.com
Includes: declspec_diguy.h
class diguyInfoPopup
|
class BDI_DECLSPEC_diguy diguyInfoPopup { public: const char* get_name(); int show(float show_duration = -1.0f); int hide(); int is_showing(); int clear(); int append_file(const char* filename); int append_string(const char* string); };
function diguyInfoPopup::get_name |
Prototype:
Description:const char* get_name();
Returns the name of the info popup. This pointer will never be NULL.Callable From:
Returns:
- C++
- Script
name of the info popup
function diguyInfoPopup::show |
Prototype:
Description:int show(float show_duration = -1.0f);
This function shows the info popup.Arguments:
Callable From:
duration length of time in seconds to show to the info popup; the default argument of -1 will show the info popup indefinitely, until the hide() function is called
Returns:
- C++
- Script
- Decision Bead
0 on success, -1 on failure
function diguyInfoPopup::hide |
Prototype:
Description:int hide();
This function hides the info popup, if it is currently shown.Callable From:
Returns:
- C++
- Script
- Decision Bead
0 on success, -1 on failure
function diguyInfoPopup::is_showing |
Prototype:
Returns:int is_showing();
Returns 1 if the info popup is showing, 0 if not.Callable From:
- C++
- Script
- Decision Bead
function diguyInfoPopup::clear |
Prototype:
Description:int clear();
This function clears the contents of the info popup.Returns:
0 on success, -1 on failureCallable From:
- C++
- Script
function diguyInfoPopup::append_file |
Prototype:
Description:int append_file(const char* filename);
This function appends the contents of the file identified by filename to the info popup.Arguments:
Returns:
filename name of the file
0 on success, -1 on failureCallable From:
- C++
- Script
function diguyInfoPopup::append_string |
Prototype:
Description:int append_string(const char* string);
This function appends a string to the info popup.Arguments:
Returns:
string string to append
0 on success, -1 on failureCallable From:
- C++
- Script
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.