diguyViewLight.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 __diguyViewLight_H
#define __diguyViewLight_H

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

#ifdef CPLUSPLUS_ONLY
class bdiLight;
class diguyViewLight;
class diguyViewLightSettings;

#include <stdio.h> // for NULL definition
#include <diguy_constants.h>
#include <diguy_typedefs.h>

#endif


#include <declspec_diguy.h>

/****************************************************************************/
class BDI_DECLSPEC_diguy diguyViewLight
{

public:

/*****************************************************************************/
        /*l
         *b  Description:
         **
         **    Returns the name of the object.  This pointer will
         **    never be NULL.
         **
         *b  Returns:
         **
         **    name of the object
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_name();

        /*l
         *b  Description:
         **
         **    Returns the type name of the object.  This pointer will
         **    never be NULL.
         **
         *b  Returns:
         **
         **    type name of the object
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_type_name();

        /*l
         *b  Description:
         **
         **    This function sets the direction of this light.
         **
         *b  Arguments:
         **
         *a    x - x direction, in meters
         *a    y - y direction, in meters
         *a    z - z direction, in meters
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        void set_direction(float x, float y, float z);

        /*l
         *b  Description:
         **
         **    This function gets the direction of this light.
         **    Values are returned via the passed pointers.
         **
         *b  Arguments:
         **
         *a    x - x direction, in meters
         *a    y - y direction, in meters
         *a    z - z direction, in meters
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        void get_direction(float* x, float* y, float* z);

        /*l
         *b  Description:
         **
         **    This function sets the position of this light.
         **
         *b  Arguments:
         **
         *a    x - x position, in meters
         *a    y - y position, in meters
         *a    z - z position, in meters
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        void set_position(float x, float y, float z);

        /*l
         *b  Description:
         **
         **    This function gets the position of this light.
         **    Values are returned via the passed pointers.
         **
         *b  Arguments:
         **
         *a    x - x position, in meters
         *a    y - y position, in meters
         *a    z - z position, in meters
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        void get_position(float* x, float* y, float* z);

        /*l
         *b  Description:
         **
         **    This function sets the ambient color.
         **
         *b  Arguments:
         **
         *a    r - red component
         *a    g - blue component
         *a    b - green component
         *a    a - alpha component
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        void set_ambient_color(float r, float g, float b, float a);

        /*l
         *b  Description:
         **
         **    This function gets the ambient color of this light.
         **    Values are returned via the passed pointers.
         **
         *b  Arguments:
         **
         *a    r - red component
         *a    g - blue component
         *a    b - green component
         *a    a - alpha component
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        void get_ambient_color(float* r, float* g, float* b, float* a);

        /*l
         *b  Description:
         **
         **    This function sets the diffuse color.
         **
         *b  Arguments:
         **
         *a    r - red component
         *a    g - blue component
         *a    b - green component
         *a    a - alpha component
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        void set_diffuse_color(float r, float g, float b, float a);

        /*l
         *b  Description:
         **
         **    This function gets the diffuse color of this light.
         **    Values are returned via the passed pointers.
         **
         *b  Arguments:
         **
         *a    r - red component
         *a    g - blue component
         *a    b - green component
         *a    a - alpha component
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        void get_diffuse_color(float* r, float* g, float* b, float* a);

        /*l
         *b  Description:
         **
         **    This function sets the specular color.
         **
         *b  Arguments:
         **
         *a    r - red component
         *a    g - blue component
         *a    b - green component
         *a    a - alpha component
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        void set_specular_color(float r, float g, float b, float a);

        /*l
         *b  Description:
         **
         **    This function gets the specular color of this light.
         **    Values are returned via the passed pointers.
         **
         *b  Arguments:
         **
         *a    r - red component
         *a    g - blue component
         *a    b - green component
         *a    a - alpha component
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        void get_specular_color(float* r, float* g, float* b, float* a);


/*****************************************************************************/
        /*l
         *b  Description:
         **
         **    Loads the specified settings into this light.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int load_settings(const char* settings_name);

#ifdef CPLUSPLUS_ONLY

        /*l
         *b  Description:
         **
         **    Loads the specified settings into this light.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int load_settings(diguyViewLightSettings* settings);

#endif

        /*l
         *b  Description:
         **
         **    Applies the light to OpenGL state.  Currently DI-Guy only supports
         **    one light in it's default OpenGL implementation.
         **
         **    At least one light must be applied for advanced DI-Guy reference
         **    shaders to work.
         */
        void apply(int i = 0);


/*****************************************************************************/
        /*l
         *b  Description:
         **
         **    This is an enumeration of the different callbacks
         **    that can be registered with add_callback() and
         **    add_callback_script().
         **
         *b  Usable From:
         **
         *-    - C++
         *-    - Script
         */
        enum {
                CALLBACK_ID_SETTINGS_CHANGED = 1
        };

#ifdef CPLUSPLUS_ONLY

        /*l
         *b  Description:
         **
         **    This function adds a user callback.
         **
         *b  Arguments:
         **
         *a    callback        - pointer to function with prototype
         *a                      diguyViewLightCallback (typedefed above)
         *a    callback_id     - integer id of when this callback is to be called
         *a    callback_params - struct containing additional parameters
         *a                      needed by some callbacks; actual type depends
         *a                      on callback_id
         *a    callback_user_data - pointer for user's own use; DI-Guy will
         *a                         do nothing to the contents of this pointer
         *a                         beyond passing it back when the callback is
         *a                         invoked
         **
         **    callback_id should be one of the following values:
         **
         *i    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.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         */
        int add_callback(int callback_id,
                diguyViewLightCallback* callback,
                void* callback_params = 0,
                void* callback_user_data = 0);

        /*l
         *b  Description:
         **
         **    This function removes a user callback.  All callbacks matching
         **    the specified callback_id and callback function will be removed.
         **
         *b  Arguments:
         **
         *a    callback_id     - integer id of when this callback is to be called
         *a    callback        - pointer to function with prototype
         *a                      diguyViewLightCallback (typedefed above)
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         */
        int remove_callback(int callback_id,
                diguyViewLightCallback* callback);

        /*l
         *b  Description:
         **
         **    This function removes a user callback.  All callbacks matching
         **    the specified callback_id and callback_user_data pointer will
         **    be removed.
         **
         *b  Arguments:
         **
         *a    callback_id        - integer id of when this callback is to be called
         *a    callback_user_data - pointer for user's own use
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         */
        int remove_callback_with_user_data(int callback_id,
                void* callback_user_data);

#endif

        /*l
         *b  Description:
         **
         **    This function adds a user callback script.  Callback scripts can
         **    be removed with remove_callback_script().
         **
         *b  Arguments:
         **
         *a    callback_id          - integer id of the callback
         *a    callback_script      - script text of callback to be added
         *a    callback_script_type - the type of script contained in
         *a                           callback_script
         **
         **    If NULL is passed for callback_script_type, a default script type
         **    will be derived based on the default script interpreter of the
         **    scenario.
         **
         *i  lua specific:
         **
         **    When the script is called, the object for which it is being called
         **    will be in the callback_object global.
         **
         **    To pass NULL when calling from a lua script, use nil.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int add_callback_script(int callback_id,
                const char* callback_script,
                const char* callback_script_type = NULL);

        /*l
         *b  Description:
         **
         **    This function removes a user callback script previously added with
         **    add_callback_script().
         **
         *b  Arguments:
         **
         *a    callback_id          - integer id of the callback
         *a    callback_script      - script text of callback previously added
         *a    callback_script_type - the type of script contained in
         *a                           callback_script
         **
         **    If NULL is passed for callback_script, all callback
         **    scripts whose ids match callback_id and whose types match
         **    callback_script_type will be removed.
         **
         **    If NULL is passed for callback_script_type, a default script type
         **    will be derived based on the default script interpreter of the
         **    scenario.
         **
         *i  lua specific:
         **
         **    To pass NULL when calling from a lua script, use nil.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int remove_callback_script(int callback_id,
                const char* callback_script,
                const char* callback_script_type = NULL);


/****************************************************************************/
/****************************************************************************/
/****************************************************************************/
/****************************************************************************/
/****************************************************************************/
/****************************************************************************/

        void set_near_plane(float near_plane);

        float get_near_plane();

        void set_far_plane(float far_plane);

        float get_far_plane();

        /*l
         *b  Description:
         **
         **    Sets if a light will cast shadow; this will only work in DI-Guy
         **    Scenario.
         */
        void set_casts_shadows(int casts_shadows);

        /*l
         *b  Returns:
         **
         **    Returns if a light will cast shadow; this is limited to DI-Guy
         **    Scenario
         */
        int get_casts_shadows();
        
        int set_scene_objects_cast_shadows(int value);
        int get_scene_objects_cast_shadows();

        int set_brightness_multiplier(float multiplier);
        float get_brightness_multiplier();

        void set_shadow_volume_size(float volume);
        float get_shadow_volume_size();

        void set_shadow_offset_multiplier(float multiplier);
        float get_shadow_offset_multiplier();

        // SPOT LIGHT Functions, not used in DI-Guy  12
        void set_spotlight_angle(float angle);
        float get_spotlight_angle();
        void set_texture_name(const char* name);

        // unused
        void set_active(int active);
        int get_active();

        // runtime values
        int set_shadow_map_update_paused(int pause);
        int get_shadow_map_update_paused();

        int set_shadow_map_update_frequency(int frame_frequency);
        int get_shadow_map_update_frequency();


#ifdef CPLUSPLUS_ONLY

        bdiLight* get_scripted_object() {return m_light;}

private:

        /*
         *  Private constructor.
         */
        diguyViewLight(bdiLight* light);

        bdiLight* m_light;
        friend class bdiLight;

#endif

};

#endif /* __diguyViewLight_H */