diguyViewLight.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2024 MAK Technologies, Inc.
 * All rights reserved.
 ****************************************************************************/

/*********************************************************************/
#pragma once

#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>

/****************************************************************************/
struct BDI_DECLSPEC_diguy diguyLightRenderDesc
{
   diguyLightRenderDesc() : m_radius(1.0f), m_spot_angle(0.0f), m_spot_exponent(1.0f), m_falloff_r(.1f), m_falloff_rsq(.1f)
   {
   }
   double m_position[4];
   float m_radius;
   float m_direction[4];
   float m_diffuse[3];
   float m_ambient[3];
   float m_specular[3];
   float m_falloff_r;
   float m_falloff_rsq;
   float m_spot_angle;
   float m_spot_exponent;

};

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
    */
   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
    */
   const char* get_type_name();

   /*l
    *b  Description:
    **
    **    This function sets the direction of this light.
    **
    *b  Arguments:
    **
    *a    x,y,z - x,y,z direction, in meters
    */
   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,y,z - x,y,z direction, in meters
    */
   void get_direction(float* x, float* y, float* z);

   /*l
    *b  Description:
    **
    **    This function sets the position of this light.
    **
    *b  Arguments:
    **
    *a    x,y,z - x,y,z position, in meters
    */
   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,y,z - x,y,z position, in meters
    */
   void get_position(float* x, float* y, float* z);

   /*l
    *b  Description:
    **
    **    This function sets the ambient color.
    **
    *b  Arguments:
    **
    *a    r,g,b,a - red, green, blue, alpha components
    */
   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,g,b,a - red, green, blue, alpha components
    */
   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,g,b,a - red, green, blue, alpha components
    */
   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,g,b,a - red, green, blue, alpha components
    */
   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,g,b,a - red, green, blue, alpha components
    */
   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,g,b,a - red, green, blue, alpha components
    */
   void get_specular_color(float* r, float* g, float* b, float* a);

   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_spot_exponent(float exponent);
   float get_spot_exponent();

   void set_falloff_const(float falloff_const);
   float get_falloff_const();

   void set_falloff_rsq(float falloff_rsq);
   float get_falloff_rsq();


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

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

   /*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 );


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

   /*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, bool clear_shadow_map = false );

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

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

   void set_spotlight_angle( float angle );
   float get_spotlight_angle();

   void bind_shadow_map( int shadow_map_size );
   void clear_shadow_map();
   void unbind_shadow_map();


   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();

   // unused
   void set_near_plane(float near_plane);
   float get_near_plane();

   void set_far_plane(float far_plane);
   float get_far_plane();

#ifdef CPLUSPLUS_ONLY

   bdiLight* get_scripted_object() {return m_light;}

private:

   diguyViewLight( bdiLight* light );

private:

   bdiLight* m_light;
   friend class bdiLight;

#endif

};