diguyViewLightSettings Class Declaration

diguyViewLightSettings.h

DI-Guy API Version 5.1.26

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

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

function diguyViewLightSettings::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 diguyViewLightSettings::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 diguyViewLightSettings::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 diguyViewLightSettings::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 diguyViewLightSettings::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 diguyViewLightSettings::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 diguyViewLightSettings::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 diguyViewLightSettings::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 diguyViewLightSettings::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 diguyViewLightSettings::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

function diguyViewLightSettings::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.