diguyViewFogSettings Class Declaration

diguyViewFogSettings.h

DI-Guy API Version 5.1.26

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

class BDI_DECLSPEC_diguy diguyViewFogSettings
{
public:
    const char* get_name();
    const char* get_type_name();
    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();
    bdiFog* get_scripted_object() {return m_fog;}
};

function diguyViewFogSettings::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 diguyViewFogSettings::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 diguyViewFogSettings::set_density

Prototype:

void set_density(float density);
Description:

This sets the density of the fog.

Arguments:

densitydistance of this fog; higher causes more opaque fog
C++, Perl

function diguyViewFogSettings::get_density

Prototype:

float get_density();
Returns:

density of fog

C++, Perl

function diguyViewFogSettings::set_start

Prototype:

void set_start(float start);
Description:

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:

startdistance to where fog starts, in meters
C++, Perl

function diguyViewFogSettings::get_start

Prototype:

float get_start();
Returns:

distance to where fog starts, in meters; see set_start()

C++, Perl

function diguyViewFogSettings::set_end

Prototype:

void set_end(float end);
Description:

This sets the distance at which the fog completely overrides the colors of objects in the scene.

Arguments:

enddistance to where fog ends, in meters
C++, Perl

function diguyViewFogSettings::get_end

Prototype:

float get_end();
Returns:

distance to where fog ends, in meters; see set_end()

C++, Perl

function diguyViewFogSettings::set_color

Prototype:

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

This function sets the color this fog.

Arguments:

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

function diguyViewFogSettings::get_color

Prototype:

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

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

function diguyViewFogSettings::set_fog_mode

Prototype:

void set_fog_mode(int mode);

function diguyViewFogSettings::get_fog_mode

Prototype:

int get_fog_mode();

function diguyViewFogSettings::get_scripted_object

Prototype:

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