diguyVehicleNearCollision.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2014 VT MAK
 ** All rights reserved. 
 *********************************************************************/

/*********************************************************************
 **
 *t  diguyVehicleNearCollision
 **
 *b    Link against: libdiguy
 */

#ifndef __diguyVehicleNearCollision_H
#define __diguyVehicleNearCollision_H

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

#ifdef CPLUSPLUS_ONLY
#include <stdio.h> // for NULL
class diguyCharacter;
class diguyScenario;
class diguySceneObject;
#endif

#include <declspec_diguy.h>
#include <diguy_constants.h>


/****************************************************************************/
class BDI_DECLSPEC_diguy diguyVehicleNearCollision
{

public:

/*****************************************************************************/
        /*l
         *b  Returns:
         **
         **    speed of vehicle being approached in near collision, in m/s
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         **
         */
        float get_approached_vehicle_speed();

        /*l
         *b  Returns:
         **
         **    name of approached vehicle
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         **
         */
        const char* get_approached_vehicle_name();

        /*l
         *b  Returns:
         **
         **    speed of approaching vehicle, in m/s
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         **
         */
        float get_approaching_vehicle_speed();

        /*l
         *b  Returns:
         **
         **    name of approached vehicle
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         **
         */
        const char* get_approaching_vehicle_name();

        /*l
         *b  Description:
         **
         **    This function returns the suggested speed for the approaching
         **    vehicle, to make it less likely that it will collide with the
         **    approached vehicle.
         **
         *b  Returns:
         **
         **    suggested speed, in m/s
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         **
         */
        float get_approaching_vehicle_suggested_speed();

        /*l
         *b  Description:
         **
         **  XXX
         **
         *b  Returns:
         **
         **  Speed
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         **
         */
        float get_distance();

        /*l
         *b  Description:
         **
         **  XXX
         **
         *b  Returns:
         **
         **  Speed
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         **
         */
        float get_time_to_next_check();

        /*l
         *b  Description:
         **
         **  XXX
         **
         *b  Returns:
         **
         **  1, if the collision is valid. If 0, there is not
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         **
         */
        int get_active() {return m_is_active;}

#ifdef CPLUSPLUS_ONLY

private:

        diguyVehicleNearCollision();

        friend class bdiScenario;
        friend class bdiScenarioCharacter;
        friend class diguyCharacter;
        friend class bdiScenarioVehicleController;

        /*l
         **    A private constructor.
         */
        diguyVehicleNearCollision(diguyScenario* scenario,
                diguyCharacter* vehicle = NULL);

        /*
         *  Private data members.
         */
        diguyScenario*    m_scenario;
        diguyCharacter*   m_approached_vehicle;
        diguyCharacter*   m_approaching_vehicle;
        float                     m_distance;
        float                     m_suggested_approaching_speed;
        float                 m_time_to_next_check;
        int                               m_is_active;

#endif

};


#endif /* __diguyVehicleNearCollision_H */