diguyView Class Declaration

diguyView.h

DI-Guy API Version 5.1.26

This file was automatically generated from comments in the C/C++ header file diguyView.h. Do not edit this file directly; the changes will be lost. Please mail suggestions or corrections to diguy@bdi.com

Alphabetical Index

Includes: diguy_constants.h | declspec_diguy.h

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();
    enum {
        CALLBACK_ID_SHOW = 1,
        CALLBACK_ID_HIDE,
        CALLBACK_ID_WINDOW_TITLE_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);
#ifdef CPLUSPLUS_ONLY
    bdiScenarioView* get_scripted_object() {return m_scripted_object;}
};

function diguyView::get_name

Prototype:

const char* get_name();
Description:

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

Callable From:

Returns:

name of the view

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:

function diguyView::show

Prototype:

int show();
Description:

Shows the view.

Callable From:

Returns:

0 on success, -1 on failure

function diguyView::hide

Prototype:

int hide();
Description:

Hides the view.

Callable From:

Returns:

0 on success, -1 on failure

function diguyView::is_showing

Prototype:

int is_showing();
Returns:

Returns 1 if the view is showing, 0 if not.

Callable From:

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:

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_titlenew window title
Returns:

0 on success, -1 on failure

Callable From:

function diguyView::get_camera

Prototype:

diguyViewCamera* get_camera();
Description:

This function returns a pointer to the view camera.

Callable From:

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.

Callable From:

Returns:

pointer of type diguyViewFog; should never be NULL

function diguyView::get_light

Prototype:

diguyViewLight* get_light();
Description:

This function returns a pointer to the view light.

Callable From:

Arguments:

name name of light to be found
Returns:

pointer of type diguyViewLight; should never be NULL

enumeration

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

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

Usable From:

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_paramsstruct containing additional parameters needed by some callbacks
callback_user_datapointer 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 bead or script event.

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 bead or script event.

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

Callable From:

Returns:

0 on success, -1 on failure

function diguyView::remove_callback

Prototype:

int remove_callback(int callback_id,
		diguyViewCallback* callback);

function diguyView::remove_callback_with_user_data

Prototype:

int remove_callback_with_user_data(int callback_id,
		void* callback_user_data);

Experimental Functions

The following functions are experimental and may change or disappear with no warning.

function diguyView::add_callback_script

Prototype:

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

function diguyView::remove_callback_script

Prototype:

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

function diguyView::get_scripted_object

Prototype:

bdiScenarioView* get_scripted_object();

Alphabetical Index


Copyright (C) 1992-2003

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.