diguyInfoPopup

Generated from diguyInfoPopup.h

DI-Guy API Version 12.5.1

This file was automatically generated from diguyInfoPopup.h. Do not edit this file directly; the changes will be lost.

Includes: declspec_diguy.h

Contents:

Alphabetical Index

Link against: libdiguy

class diguyInfoPopup

class BDI_DECLSPEC_diguy diguyInfoPopup
{
public:
    const char* get_name();
    int set_name(const char* 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:
const char* get_name();
Description:

Returns the name of the info popup. This pointer will never be NULL.
Returns:

name of the info popup
Callable From:

C++
Script

function diguyInfoPopup::set_name

Prototype:
int set_name(const char* name);
Description:

This function sets the name of this object.
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguyInfoPopup::show

Prototype:
int show(float show_duration = -1.0f);
Description:

This function shows the info popup.
Arguments:

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:

0 on success, -1 on failure
Callable From:

C++
Script
Decision Bead

function diguyInfoPopup::hide

Prototype:
int hide();
Description:

This function hides the info popup, if it is currently shown.
Returns:

0 on success, -1 on failure
Callable From:

C++
Script
Decision Bead

function diguyInfoPopup::is_showing

Prototype:
int is_showing();
Returns:

Returns 1 if the info popup is showing, 0 if not.
Callable From:

C++
Script
Decision Bead

function diguyInfoPopup::clear

Prototype:
int clear();
Description:

This function clears the contents of the info popup.
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguyInfoPopup::append_file

Prototype:
int append_file(const char* filename);
Description:

This function appends the contents of the file identified by filename to the info popup.
Arguments:

filename name of the file
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguyInfoPopup::append_string

Prototype:
int append_string(const char* string);
Description:

This function appends a string to the info popup.
Arguments:

string string to append
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

Alphabetical Index

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.