
This file was automatically generated from comments in the C/C++ header file diguyViewFog.h. Do not edit this file directly; the changes will be lost. Please mail suggestions or corrections to diguy@bdi.com
Includes: diguy_constants.h | declspec_diguy.h
class diguyViewFog
|
class BDI_DECLSPEC_diguy diguyViewFog { public: const char* get_name(); const char* get_type_name(); int load_settings(const char* settings_name); int load_settings(diguyViewFogSettings* settings); void set_density(float density); float get_density(); void set_start(float start); float get_start(); void set_end(float end); float get_end(); void set_color(float r, float g, float b, float a); void get_color(float* r, float* g, float* b, float* a); void set_fog_mode(int mode); int get_fog_mode(); enum { CALLBACK_ID_SETTINGS_CHANGED = 1 }; #ifdef CPLUSPLUS_ONLY int add_callback(int callback_id, diguyViewFogCallback* callback, void* callback_params = 0, void* callback_user_data = 0); int remove_callback(int callback_id, diguyViewFogCallback* 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); bdiFog* get_scripted_object() {return m_fog;} };
function diguyViewFog::get_name |
Prototype:
Description:const char* get_name();
Returns the name of the object. This pointer will never be NULL.C++, Perl
Returns:
name of the object
function diguyViewFog::get_type_name |
Prototype:
Description:const char* get_type_name();
Returns the type name of the object. This pointer will never be NULL.Returns:
type name of the objectCallable From:
- C++
- Script
function diguyViewFog::load_settings |
Prototype:
Description:int load_settings(const char* settings_name);
Loads the specified settings into this fog.C++, Perl
Returns:
0 on success, -1 on failure
function diguyViewFog::load_settings |
Prototype:
Description:int load_settings(diguyViewFogSettings* settings);
Loads the specified settings into this fog.C++, Perl
Returns:
0 on success, -1 on failure
function diguyViewFog::set_density |
Prototype:
Description:void set_density(float density);
This sets the density of the fog.Arguments:
C++, Perl
density distance of this fog; higher causes more opaque fog
function diguyViewFog::get_density |
Prototype:
Returns:float get_density();
density of fogC++, Perl
function diguyViewFog::set_start |
Prototype:
Description:void set_start(float start);
This sets the distance at which fog begins to affect the scene. Colors of objects before this distance will not be affected. Colors of objects after this distance will start to be modulated toward to fog color.Arguments:
C++, Perl
start distance to where fog starts, in meters
function diguyViewFog::get_start |
Prototype:
Returns:float get_start();
distance to where fog starts, in meters; see set_start()C++, Perl
function diguyViewFog::set_end |
Prototype:
Description:void set_end(float end);
This sets the distance at which the fog completely overrides the colors of objects in the scene.Arguments:
C++, Perl
end distance to where fog ends, in meters
function diguyViewFog::get_end |
Prototype:
Returns:float get_end();
distance to where fog ends, in meters; see set_end()C++, Perl
function diguyViewFog::set_color |
Prototype:
Description:void set_color(float r, float g, float b, float a);
This function sets the color of this fog.Arguments:
C++, Perl
r red component g blue component b green component a alpha component
function diguyViewFog::get_color |
Prototype:
Arguments:void get_color(float* r, float* g, float* b, float* a);
C++, Perl
r red component g blue component b green component a alpha component
function diguyViewFog::set_fog_mode |
Prototype:
void set_fog_mode(int mode);
function diguyViewFog::get_fog_mode |
Prototype:
int get_fog_mode();
enumeration |
Description:enum { CALLBACK_ID_SETTINGS_CHANGED = 1 };
This is an enumeration of the different callbacks that can be registered with add_callback() and add_callback_script().Usable From:
- C++
- Script
function diguyViewFog::add_callback |
Prototype:
Description:int add_callback(int callback_id, diguyViewFogCallback* callback, void* callback_params = 0, void* callback_user_data = 0);
This function adds a user callback.Arguments:
callback pointer to function with prototype diguyViewFogCallback (typedefed above) callback_id integer id of when this callback is to be called callback_params struct containing additional parameters needed by some callbacks; actual type depends on callback_id 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_SETTINGS_CHANGED
This callback will be called if the current settings of this fog 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 failureC++
Returns:
0 on success, -1 on failure
function diguyViewFog::remove_callback |
Prototype:
int remove_callback(int callback_id, diguyViewFogCallback* callback);
function diguyViewFog::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 diguyViewFog::add_callback_script |
Prototype:
int add_callback_script(int callback_id, const char* callback_script, const char* callback_script_type = NULL);
function diguyViewFog::remove_callback_script |
Prototype:
int remove_callback_script(int callback_id, const char* callback_script, const char* callback_script_type = NULL);
function diguyViewFog::get_scripted_object |
Prototype:
bdiFog* get_scripted_object();
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.