diguyViewFogSettings.h

Go to the documentation of this file.

/*
 *  Copyright (C) 1992-2013 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 Software 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/78 Fourth Avenue/Waltham MA 02451.
 */



#ifndef __diguyViewFogSettings_H
#define __diguyViewFogSettings_H

#ifdef SWIG
%module diguyViewFogSettings
#else
#define CPLUSPLUS_ONLY
#endif

#ifdef CPLUSPLUS_ONLY
class bdiFog;
class diguyViewFogSettings;

#include <diguy_constants.h>

#endif


#include <declspec_diguy.h>

/*********************************************************************/
class BDI_DECLSPEC_diguy diguyViewFogSettings
{

public:

        /*l
         *b  Description:
         **
         **    The diguyViewLightSettings equivalent of
         **    diguyViewLight::get_name().
         */
        const char* get_name();

        /*l
         *b  Description:
         **
         **    The diguyViewLightSettings equivalent of
         **    diguyViewLight::get_type_name().
         */
        const char* get_type_name();

        /*l
         *b  Description:
         **
         **    The diguyViewLightSettings equivalent of
         **    diguyViewLight::set_density().
         */
        void set_density(float density);

        /*l
         *b  Description:
         **
         **    The diguyViewLightSettings equivalent of
         **    diguyViewLight::get_density().
         */
        float get_density();

        /*l
         *b  Description:
         **
         **    The diguyViewLightSettings equivalent of
         **    diguyViewLight::set_start().
         */
        void set_start(float start);

        /*l
         *b  Description:
         **
         **    The diguyViewLightSettings equivalent of
         **    diguyViewLight::get_start().
         */
        float get_start();

        /*l
         *b  Description:
         **
         **    The diguyViewLightSettings equivalent of
         **    diguyViewLight::set_end().
         */
        void set_end(float end);

        /*l
         *b  Description:
         **
         **    The diguyViewLightSettings equivalent of
         **    diguyViewLight::get_end().
         */
        float get_end();

        /*l
         *b  Description:
         **
         **    The diguyViewLightSettings equivalent of
         **    diguyViewLight::set_color().
         */
        void set_color(float r, float g, float b, float a);

        /*l
         *b  Description:
         **
         **    The diguyViewLightSettings equivalent of
         **    diguyViewLight::get_color().
         */
        void get_color(float* r, float* g, float* b, float* a);

        /*l
         *b  Description:
         **
         **    The diguyViewLightSettings equivalent of
         **    diguyViewLight::set_fog_mode().
         */
        void set_fog_mode(int mode);

        /*l
         *b  Description:
         **
         **    The diguyViewLightSettings equivalent of
         **    diguyViewLight::get_fog_mode().
         */
        int get_fog_mode();


#ifdef CPLUSPLUS_ONLY

        bdiFog* get_scripted_object() {return m_fog;}

private:

        /*l
         **  A private constructor.
         */
        diguyViewFogSettings(bdiFog* fog);

        /*l
         **  A pointer to internal data.
         */
        bdiFog* m_fog;

        friend class bdiFog;

#endif

};

#endif /* __diguyViewFogSettings_H */