diguyView

Generated from diguyView.h

DI-Guy API Version 12.5.1

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

Includes: diguy_constants.h | diguy_typedefs.h | declspec_diguy.h

Contents:

Alphabetical Index

Link against: libdiguy

class diguyView

class BDI_DECLSPEC_diguy diguyView
{
public:
    const char* get_name();
    const char* get_type_name();
    int show();
    int hide();
    int is_showing();
    const char* get_window_title();
    int set_window_title(const char* window_title);
    diguyViewCamera* get_camera();
    diguyViewFog* get_fog();
    diguyViewLight* get_light(int number = 0);
    int set_width(int width);
    int get_width();
    int set_height(int height);
    int get_height();
    int set_x(int x);
    int get_x();
    int set_y(int y);
    int get_y();
    enum {
        CALLBACK_ID_SHOW = 1,
        CALLBACK_ID_HIDE,
        CALLBACK_ID_WINDOW_TITLE_CHANGED,
        CALLBACK_ID_WINDOW_GEOMETRY_CHANGED
    };
#ifdef CPLUSPLUS_ONLY
    int add_callback(int callback_id,
        diguyViewCallback* callback,
        void* callback_params = 0,
        void* callback_user_data = 0);
    int remove_callback(int callback_id,
        diguyViewCallback* callback);
    int remove_callback_with_user_data(int callback_id,
        void* callback_user_data);
    int add_callback_script(int callback_id,
        const char* callback_script,
        const char* callback_script_type = NULL);
    int remove_callback_script(int callback_id,
        const char* callback_script,
        const char* callback_script_type = NULL);

function diguyView::get_name

Prototype:
const char* get_name();
Description:

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

name of the view
Callable From:

C++
Script

function diguyView::get_type_name

Prototype:
const char* get_type_name();
Description:

Returns the type name of the object. This pointer will never be NULL.
Returns:

type name of the object
Callable From:

C++
Script

function diguyView::show

Prototype:
int show();
Description:

Shows the view.
Returns:

0 on success, -1 on failure
Callable From:

C++
Script
Decision Bead

function diguyView::hide

Prototype:
int hide();
Description:

Hides the view.
Returns:

0 on success, -1 on failure
Callable From:

C++
Script
Decision Bead

function diguyView::is_showing

Prototype:
int is_showing();
Returns:

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

C++
Script
Decision Bead

function diguyView::get_window_title

Prototype:
const char* get_window_title();
Description:

Returns the window title of the view. This pointer will never be NULL.
Returns:

window title of the view
Callable From:

C++
Script

function diguyView::set_window_title

Prototype:
int set_window_title(const char* window_title);
Description:

This function sets the window title of the view.
Arguments:

window_title new window title
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguyView::get_camera

Prototype:
diguyViewCamera* get_camera();
Description:

This function returns a pointer to the view camera.
Callable From:

C++
Script
Returns:

pointer of type diguyViewCamera; should never be NULL

function diguyView::get_fog

Prototype:
diguyViewFog* get_fog();
Description:

This function returns a pointer to the view fog.
Returns:

pointer of type diguyViewFog; should never be NULL
Callable From:

C++
Script

function diguyView::get_light

Prototype:
diguyViewLight* get_light(int number = 0);
Description:

This function returns a pointer to the view lights.
Arguments:

number number of light to be found
Returns:

pointer of type diguyViewLight; can be NULL if light at specified index doesn't exist
Callable From:

C++
Script

Size and Position Functions

function diguyView::set_width

Prototype:
int set_width(int width);
Description:

Sets the width of the view, in pixels.
Arguments:

width new width of view, in pixels
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguyView::get_width

Prototype:
int get_width();
Returns:

width in pixels of the view
Callable From:

C++
Script

function diguyView::set_height

Prototype:
int set_height(int height);
Description:

Sets the height of the view, in pixels. Increasing height value moves the view window bottom edge lower.
Arguments:

width new height of view, in pixels
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguyView::get_height

Prototype:
int get_height();
Returns:

height in pixels of the view
Callable From:

C++
Script

function diguyView::set_x

Prototype:
int set_x(int x);
Description:

Sets the current x position of the view window relative to the left-hand edge of the screen.
Arguments:

x new x coordinate of view
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguyView::get_x

Prototype:
int get_x();
Returns:

current x coordinate of the view window; see set_x()
Callable From:

C++
Script

function diguyView::set_y

Prototype:
int set_y(int y);
Description:

Sets the current y position of the view window relative to the upper edge of the screen. Increasing y moves the view window lower.
Arguments:

y new y coordinate of view
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguyView::get_y

Prototype:
int get_y();
Returns:

current y coordinate of the view window; see set_y()
Callable From:

C++
Script

Callback Functions

enumeration

	enum {
		CALLBACK_ID_SHOW = 1,
		CALLBACK_ID_HIDE,
		CALLBACK_ID_WINDOW_TITLE_CHANGED,
		CALLBACK_ID_WINDOW_GEOMETRY_CHANGED
	};
Description:

This is an enumeration of the different callbacks that can be registered with add_callback() and add_callback_script().
Usable From:

C++
Script

function diguyView::add_callback

Prototype:
int add_callback(int callback_id,
    diguyViewCallback* callback,
    void* callback_params = 0,
    void* callback_user_data = 0);
Description:

This function adds a user callback.
Arguments:

callback pointer to function with prototype diguyViewCallback (typedefed above)
callback_id integer id of when this callback is to be called
callback_params not currently used; pass NULL
callback_user_data pointer for user's own use; DI-Guy will do nothing to the contents of this pointer beyond passing it back when the callback is invoked

callback_id should be one of the following values:
CALLBACK_ID_SHOW

This callback will be called whenever the view is to be shown, whether due to a call to the diguyView::show() function above or due to the result of a decision or script.

There are no parameters for this callback.
CALLBACK_ID_HIDE

This callback will be called whenever the view is to be hidden, whether due to a call to the diguyView::hide() function above or due to the result of a decision or script.

There are no parameters for this callback.
CALLBACK_ID_WINDOW_TITLE_CHANGED

This callback will be called whenever the view's window title has been changed.

There are no parameters for this callback.
Callback Return Values:

Callbacks return a value of type diguyCallbackReturn, which will be DIGUY_CALLBACK_STOP or DIGUY_CALLBACK_CONTINUE. If the callback returns DIGUY_CALLBACK_STOP, the default handler of the function will not be called; the callback is asserting that it has done everything necessary for the function call. If the callback returns DIGUY_CALLBACK_CONTINUE, the default handler for the function will be called after the callback.
Returns:

0 on success, -1 on failure
Returns:

0 on success, -1 on failure
Callable From:

C++

function diguyView::remove_callback

Prototype:
int remove_callback(int callback_id,
    diguyViewCallback* callback);
Description:

This function removes a user callback. All callbacks matching the specified callback_id and callback function will be removed.
Arguments:

callback_id integer id of when this callback is to be called
callback pointer to function with prototype diguyCharacterCallback (typedefed above)
Returns:

0 on success, -1 on failure

function diguyView::remove_callback_with_user_data

Prototype:
int remove_callback_with_user_data(int callback_id,
    void* callback_user_data);
Description:

This function removes a user callback. All callbacks matching the specified callback_id and callback_user_data pointer will be removed.
Arguments:

callback_id integer id of when this callback is to be called
callback_user_data pointer for user's own use
Returns:

0 on success, -1 on failure

function diguyView::add_callback_script

Prototype:
int add_callback_script(int callback_id,
    const char* callback_script,
    const char* callback_script_type = NULL);
Description:

This function adds a user callback script. Callback scripts can be removed with remove_callback_script().

See diguyCharacter::add_callback_script() for an example of use.
Arguments:

callback_id integer id of the callback
callback_script script text of callback to be added
callback_script_type the type of script contained in callback_script

If NULL is passed for callback_script_type, a default script type will be derived based on the default script interpreter of the scenario.
Lua specific:

When the script is called, the object for which it is being called will be in the callback_object global.

To pass NULL when calling from a lua script, use nil.
Returns:

0 on success, -1 on failure
Callable From:

C++
Script

function diguyView::remove_callback_script

Prototype:
int remove_callback_script(int callback_id,
    const char* callback_script,
    const char* callback_script_type = NULL);
Description:

This function removes a user callback script previously added with add_callback_script().

See diguyCharacter::remove_callback_script() for an example of use.
Arguments:

callback_id integer id of the callback
callback_script script text of callback previously added
callback_script_type the type of script contained in callback_script

If NULL is passed for callback_script, all callback scripts whose ids match callback_id and whose types match callback_script_type will be removed.

If NULL is passed for callback_script_type, a default script type will be derived based on the default script interpreter of the scenario.
Lua specific:

To pass NULL when calling from a lua script, use nil.
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.

`callback`	pointer to function with prototype diguyViewCallback (typedefed above)
`callback_id`	integer id of when this callback is to be called
`callback_params`	not currently used; pass NULL
`callback_user_data`	pointer for user's own use; DI-Guy will do nothing to the contents of this pointer beyond passing it back when the callback is invoked

`callback_id`	integer id of the callback
`callback_script`	script text of callback to be added
`callback_script_type`	the type of script contained in callback_script