diguyViewFog.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2022 MAK Technologies, Inc.
 ** All rights reserved.
 *********************************************************************/

/*********************************************************************/
#ifndef __diguyViewFog_H
#define __diguyViewFog_H

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

#ifdef CPLUSPLUS_ONLY
class bdiFog;
class diguyViewFog;
class diguyViewFogSettings;

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

#endif


#include <declspec_diguy.h>

class BDI_DECLSPEC_diguy diguyViewFog
{

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 sets the density of the fog.
    **
    *b  Arguments:
    **
    *a    density - distance of this fog; higher causes more opaque fog
    */
   void set_density(float density);

   /*l
    *b  Returns:
    **
    **    density of fog
    */
   float get_density() const;

   /*l
    *b  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.
    **
    *b  Arguments:
    **
    *a    start - distance to where fog starts, in meters
    */
   void set_start(float start);

   /*l
    *b  Returns:
    **
    **    distance to where fog starts, in meters; see set_start()
    */
   float get_start() const;

   /*l
    *b  Description:
    **
    **    This sets the distance at which the fog completely overrides
    **    the colors of objects in the scene.
    **
    *b  Arguments:
    **
    *a    end - distance to where fog ends, in meters
    */
   void set_end(float end);

   /*l
    *b  Returns:
    **
    **    distance to where fog ends, in meters; see set_end()
    */
   float get_end() const;

   /*l
    *b  Description:
    **
    **    This function sets the color of this fog.
    **
    *b  Arguments:
    **
    *a    r, g, b, a - red, green, blue, and alpha components
    */
   void set_color(float r, float g, float b, float a);

   /*l
    *b  Description:
    **
    **    This function gets the color of this fog.
    **    Values are returned via the passed pointers.
    **
    *b  Arguments:
    **
    *a    r, g, b, a - red, green, blue, and alpha components
    */
   void get_color(float* r, float* g, float* b, float* a) const;

   /*l
    *b  Description:
    **
    **    This function sets the fog mode.
    **
    *b  Arguments:
    **
    *a    mode - new mode for fog calculations
    **
    *a    DIGUY_FOG_MODE_DISABLED   - fog is completely turned off
    *a    DIGUY_FOG_MODE_EXP        - per-vertex exponential
    *a    DIGUY_FOG_MODE_EXP2       - per-vertex exponential style 2
    *a    DIGUY_FOG_MODE_LINEAR     - per-vertex linear
    **
    *b  Returns:
    **
    **    0 on success, -1 on failure
    */
   void set_fog_mode(int mode);

   /*l
    *b  Returns:
    **
    **    the most recent setting made by set_fog_mode()
    */
   int get_fog_mode() const;

   void apply();

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

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



/*****************************************************************************/
   /*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                      diguyViewFogCallback (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 fog 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,
      diguyViewFogCallback* 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                      diguyViewFogCallback (typedefed above)
    **
    *b  Returns:
    **
    **    0 on success, -1 on failure
    **
    *b  Callable From:
    **
    *-    - C++
    */
   int remove_callback(int callback_id,
      diguyViewFogCallback* 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);

#ifdef CPLUSPLUS_ONLY

   bdiFog* get_scripted_object() {return m_fog;}

private:

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

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

   friend class bdiFog;

#endif

};

#endif /* __diguyViewFog_H */