diguyViewLight Class Declaration

diguyViewLight.h

DI-Guy API Version 5.1.26

This file was automatically generated from comments in the C/C++ header file diguyViewLight.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

class diguyViewLight

class BDI_DECLSPEC_diguy diguyViewLight
{
public:
    const char* get_name();
    const char* get_type_name();
    int load_settings(const char* settings_name);
    int load_settings(diguyViewLightSettings* settings);
    void set_direction(float x, float y, float z);
    void get_direction(float* x, float* y, float* z);
    void set_ambient_color(float r, float g, float b, float a);
    void get_ambient_color(float* r, float* g, float* b, float* a);
    void set_diffuse_color(float r, float g, float b, float a);
    void get_diffuse_color(float* r, float* g, float* b, float* a);
    void set_specular_color(float r, float g, float b, float a);
    void get_specular_color(float* r, float* g, float* b, float* a);
    enum {
        CALLBACK_ID_SETTINGS_CHANGED = 1
    };
#ifdef CPLUSPLUS_ONLY
    int add_callback(int callback_id,
        diguyViewLightCallback* callback,
        void* callback_params = 0,
        void* callback_user_data = 0);
    int remove_callback(int callback_id,
        diguyViewLightCallback* callback);
    int remove_callback_with_user_data(int callback_id,
        void* callback_user_data);
#endif
    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);
    bdiLight* get_scripted_object() {return m_light;}
};

function diguyViewLight::get_name

Prototype:

const char* get_name();
Description:

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

C++, Perl

Returns:

name of the object

function diguyViewLight::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 diguyViewLight::load_settings

Prototype:

int load_settings(const char* settings_name);
Description:

Loads the specified settings into this light.

C++, Perl

Returns:

0 on success, -1 on failure

function diguyViewLight::load_settings

Prototype:

int load_settings(diguyViewLightSettings* settings);
Description:

Loads the specified settings into this light.

C++, Perl

Returns:

0 on success, -1 on failure

function diguyViewLight::set_direction

Prototype:

void set_direction(float x, float y, float z);
Description:

This function sets the direction of this light.

Arguments:

xx direction, in meters
yy direction, in meters
zz direction, in meters

function diguyViewLight::get_direction

Prototype:

void get_direction(float* x, float* y, float* z);
Description:

This function gets the direction of this light.

Arguments:

xx direction, in meters
yy direction, in meters
zz direction, in meters

function diguyViewLight::set_ambient_color

Prototype:

void set_ambient_color(float r, float g, float b, float a);
Description:

This function sets the ambient color.

Arguments:

rred component
gblue component
bgreen component
aalpha component
C++, Perl

function diguyViewLight::get_ambient_color

Prototype:

void get_ambient_color(float* r, float* g, float* b, float* a);
Arguments:

rred component
gblue component
bgreen component
aalpha component
C++, Perl

function diguyViewLight::set_diffuse_color

Prototype:

void set_diffuse_color(float r, float g, float b, float a);
Description:

This function sets the diffuse color.

Arguments:

rred component
gblue component
bgreen component
aalpha component
C++, Perl

function diguyViewLight::get_diffuse_color

Prototype:

void get_diffuse_color(float* r, float* g, float* b, float* a);
Arguments:

rred component
gblue component
bgreen component
aalpha component
C++, Perl

function diguyViewLight::set_specular_color

Prototype:

void set_specular_color(float r, float g, float b, float a);
Description:

This function sets the specular color.

Arguments:

rred component
gblue component
bgreen component
aalpha component
C++, Perl

function diguyViewLight::get_specular_color

Prototype:

void get_specular_color(float* r, float* g, float* b, float* a);
Arguments:

rred component
gblue component
bgreen component
aalpha component
C++, Perl

enumeration

	enum {
		CALLBACK_ID_SETTINGS_CHANGED = 1
	};
Description:

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

Usable From:

function diguyViewLight::add_callback

Prototype:

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

This function adds a user callback.

Arguments:

callback pointer to function with prototype diguyViewLightCallback (typedefed above)
callback_id integer id of when this callback is to be called
callback_paramsstruct containing additional parameters needed by some callbacks; actual type depends on callback_id
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_SETTINGS_CHANGED

This callback will be called if the current settings of this light change

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

C++

Returns:

0 on success, -1 on failure

function diguyViewLight::remove_callback

Prototype:

int remove_callback(int callback_id,
		diguyViewLightCallback* callback);

function diguyViewLight::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 diguyViewLight::add_callback_script

Prototype:

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

function diguyViewLight::remove_callback_script

Prototype:

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

function diguyViewLight::get_scripted_object

Prototype:

bdiLight* 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.