1
0
Fork 0

Maintenance: AIShip

explicit ctor.
SPDX tags.
spelling.
This commit is contained in:
scttgs0 2023-05-21 20:09:21 -05:00
parent f57266bac8
commit 69854326e6
2 changed files with 189 additions and 197 deletions

View file

@ -1,21 +1,10 @@
// FGAIShip - FGAIBase-derived class creates an AI ship
//
// Written by David Culp, started October 2003.
// with major amendments and additions by Vivian Meazza, 2004 - 2007
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation; either version 2 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
/*
* SPDX-FileName: AIShip.cxx
* SPDX-FileComment: AIBase-derived class creates an AI ship
* SPDX-FileCopyrightText: Copyright (C) 2003 David P. Culp - davidculp2@comcast.net
* SPDX-FileContributor: with major amendments and additions by Vivian Meazza, 2004 - 2007
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#include <cmath>
@ -26,18 +15,17 @@
double fgIsFinite(double x) { return std::isfinite(x); }
#endif
#include <simgear/sg_inlines.h>
#include <simgear/math/sg_geodesy.hxx>
#include <simgear/timing/sg_time.hxx>
#include <simgear/math/sg_random.hxx>
#include <simgear/sg_inlines.h>
#include <simgear/timing/sg_time.hxx>
#include <simgear/scene/util/SGNodeMasks.hxx>
#include <Scenery/scenery.hxx>
#include <Main/globals.hxx>
#include <Scenery/scenery.hxx>
#include <simgear/scene/util/SGNodeMasks.hxx>
#include "AIShip.hxx"
using std::string;
FGAIShip::FGAIShip(object_type ot) : // allow HOT to be enabled
FGAIBase(ot, true),
@ -72,7 +60,8 @@ FGAIShip::FGAIShip(object_type ot) : // allow HOT to be enabled
invisible = false;
}
void FGAIShip::readFromScenario(SGPropertyNode* scFileNode) {
void FGAIShip::readFromScenario(SGPropertyNode* scFileNode)
{
if (!scFileNode)
return;
@ -100,7 +89,8 @@ void FGAIShip::readFromScenario(SGPropertyNode* scFileNode) {
}
}
bool FGAIShip::init(ModelSearchOrder searchOrder) {
bool FGAIShip::init(ModelSearchOrder searchOrder)
{
reinit();
return FGAIBase::init(searchOrder);
}
@ -131,7 +121,8 @@ void FGAIShip::reinit()
FGAIBase::reinit();
}
void FGAIShip::bind() {
void FGAIShip::bind()
{
FGAIBase::bind();
tie("surface-positions/rudder-pos-deg",
@ -205,10 +196,9 @@ void FGAIShip::bind() {
}
void FGAIShip::update(double dt) {
if (replay_time->getDoubleValue() <= 0)
void FGAIShip::update(double dt)
{
if (replay_time->getDoubleValue() <= 0) {
//SG_LOG(SG_AI, SG_ALERT, "updating Ship: " << _name <<hdg<<pitch<<roll);
// For computation of rotation speeds we just use finite differences here.
// That is perfectly valid since this thing is not driven by accelerations
@ -261,14 +251,13 @@ void FGAIShip::update(double dt) {
aip.setBodyAngularVelocity(dOrAngleAxis);
}
}
else
{
} else {
Transform();
}
}
void FGAIShip::Run(double dt) {
void FGAIShip::Run(double dt)
{
if (_fp_init)
ProcessFlightPlan(dt);
@ -281,7 +270,6 @@ void FGAIShip::Run(double dt) {
double speed_diff = tgt_speed - speed;
if (fabs(speed_diff) > 0.1) {
if (speed_diff > 0.0)
speed += _speed_constant * dt;
@ -296,7 +284,7 @@ void FGAIShip::Run(double dt) {
SG_CLAMP_RANGE(speed, -_limit * 0.75, _limit);
{
/* The rotation rotating from the earth centerd frame to the horizontal
/* The rotation rotating from the earth centered frame to the horizontal
local frame. */
SGQuatd hlOr = SGQuatd::fromLonLat(pos);
@ -305,7 +293,7 @@ void FGAIShip::Run(double dt) {
SGQuatd hlToBody = SGQuatd::fromYawPitchRollDeg(hdg, pitch, roll);
/* Compute the eyepoints orientation and position wrt the earth
centered frame - that is global coorinates. */
centered frame - that is global coordinates. */
SGQuatd ec2body = hlOr * hlToBody;
/* The cartesian position of the basic view coordinate. */
@ -334,7 +322,7 @@ void FGAIShip::Run(double dt) {
_rudder = -45;
// we assume that at slow speed ships will manoeuvre using engines/bow thruster
// we assume that at slow speed ships will manoeuver using engines/bow thruster
if (type == "ship" || type == "carrier" || type == "escort") { // TODO: fragile code... should this be an enum???
if (fabs(speed) <= 5)
_sp_turn_radius_ft = _fixed_turn_radius;
@ -344,7 +332,6 @@ void FGAIShip::Run(double dt) {
_sp_turn_radius_ft = 10 * pow((fabs(speed) - 15), 2) + turn_radius_ft;
}
} else {
if (fabs(speed) <= 40)
_sp_turn_radius_ft = _fixed_turn_radius;
else {
@ -434,7 +421,6 @@ void FGAIShip::Run(double dt) {
if (_rudder < -rudder_limit)
_rudder = -rudder_limit;
}
// do calculations for radar
@ -442,15 +428,18 @@ void FGAIShip::Run(double dt) {
}
} //end function
void FGAIShip::AccelTo(double speed) {
void FGAIShip::AccelTo(double speed)
{
tgt_speed = speed;
}
void FGAIShip::PitchTo(double angle) {
void FGAIShip::PitchTo(double angle)
{
tgt_pitch = angle;
}
void FGAIShip::RollTo(double angle) {
void FGAIShip::RollTo(double angle)
{
tgt_roll = angle;
}
@ -459,108 +448,130 @@ void FGAIShip::YawTo(double angle) {
}
#endif
void FGAIShip::ClimbTo(double altitude) {
void FGAIShip::ClimbTo(double altitude)
{
tgt_altitude_ft = altitude;
_setAltitude(altitude);
}
void FGAIShip::TurnTo(double heading) {
void FGAIShip::TurnTo(double heading)
{
tgt_heading = heading - _lead_angle + _tow_angle;
SG_NORMALIZE_RANGE(tgt_heading, 0.0, 360.0);
_hdg_lock = true;
}
double FGAIShip::sign(double x) {
double FGAIShip::sign(double x)
{
if (x < 0.0)
return -1.0;
else
return 1.0;
}
void FGAIShip::setStartTime(const string& st) {
void FGAIShip::setStartTime(const std::string& st)
{
_start_time = st;
}
void FGAIShip::setUntilTime(const string& ut) {
void FGAIShip::setUntilTime(const std::string& ut)
{
_until_time = ut;
props->setStringValue("waypoint/wait-until-time", _until_time.c_str());
}
void FGAIShip::setCurrName(const string& c) {
void FGAIShip::setCurrName(const std::string& c)
{
_curr_name = c;
props->setStringValue("waypoint/name-curr", _curr_name.c_str());
}
void FGAIShip::setNextName(const string& n) {
void FGAIShip::setNextName(const std::string& n)
{
_next_name = n;
props->setStringValue("waypoint/name-next", _next_name.c_str());
}
void FGAIShip::setPrevName(const string& p) {
void FGAIShip::setPrevName(const std::string& p)
{
_prev_name = p;
props->setStringValue("waypoint/name-prev", _prev_name.c_str());
}
void FGAIShip::setRepeat(bool r) {
void FGAIShip::setRepeat(bool r)
{
_repeat = r;
}
void FGAIShip::setRestart(bool r) {
void FGAIShip::setRestart(bool r)
{
_restart = r;
}
void FGAIShip::setMissed(bool m) {
void FGAIShip::setMissed(bool m)
{
_missed = m;
props->setBoolValue("waypoint/missed", _missed);
}
void FGAIShip::setRudder(float r) {
void FGAIShip::setRudder(float r)
{
_rudder = r;
}
void FGAIShip::setRoll(double rl) {
void FGAIShip::setRoll(double rl)
{
roll = rl;
}
void FGAIShip::setLeadAngleGain(double g) {
void FGAIShip::setLeadAngleGain(double g)
{
_lead_angle_gain = g;
}
void FGAIShip::setLeadAngleLimit(double l) {
void FGAIShip::setLeadAngleLimit(double l)
{
_lead_angle_limit = l;
}
void FGAIShip::setLeadAngleProp(double p) {
void FGAIShip::setLeadAngleProp(double p)
{
_proportion = p;
}
void FGAIShip::setRudderConstant(double rc) {
void FGAIShip::setRudderConstant(double rc)
{
_rudder_constant = rc;
}
void FGAIShip::setSpeedConstant(double sc) {
void FGAIShip::setSpeedConstant(double sc)
{
_speed_constant = sc;
}
void FGAIShip::setFixedTurnRadius(double ftr) {
void FGAIShip::setFixedTurnRadius(double ftr)
{
_fixed_turn_radius = ftr;
}
void FGAIShip::setRollFactor(double rf) {
void FGAIShip::setRollFactor(double rf)
{
_roll_factor = rf * -0.0083335;
}
void FGAIShip::setInitialTunnel(bool t) {
void FGAIShip::setInitialTunnel(bool t)
{
_initial_tunnel = t;
setTunnel(_initial_tunnel);
}
void FGAIShip::setTunnel(bool t) {
void FGAIShip::setTunnel(bool t)
{
_tunnel = t;
}
void FGAIShip::setWPNames() {
void FGAIShip::setWPNames()
{
if (prev != 0)
setPrevName(prev->getName());
else
@ -581,11 +592,10 @@ void FGAIShip::setWPNames() {
SG_LOG(SG_AI, SG_DEBUG, "AIShip: prev wp name " << prev->getName());
SG_LOG(SG_AI, SG_DEBUG, "AIShip: current wp name " << curr->getName());
SG_LOG(SG_AI, SG_DEBUG, "AIShip: next wp name " << next->getName());
}
double FGAIShip::getRange(double lat, double lon, double lat2, double lon2) const {
double FGAIShip::getRange(double lat, double lon, double lat2, double lon2) const
{
double course, distance, az2;
// calculate the bearing and range of the second pos from the first
@ -594,8 +604,8 @@ double FGAIShip::getRange(double lat, double lon, double lat2, double lon2) cons
return distance;
}
double FGAIShip::getCourse(double lat, double lon, double lat2, double lon2) const {
double FGAIShip::getCourse(double lat, double lon, double lat2, double lon2) const
{
double course, distance, recip;
// calculate the bearing and range of the second pos from the first
@ -609,8 +619,8 @@ double FGAIShip::getCourse(double lat, double lon, double lat2, double lon2) con
}
}
void FGAIShip::ProcessFlightPlan(double dt) {
void FGAIShip::ProcessFlightPlan(double dt)
{
if (dt < 0.00001) {
return;
}
@ -667,7 +677,6 @@ void FGAIShip::ProcessFlightPlan(double dt) {
setWPNames();
if ((_wp_range < (sp_turn_radius_nm * 1.25)) || _missed || (_waiting && !_new_waypoint)) {
if (_next_name == "TUNNEL") {
_tunnel = !_tunnel;
@ -676,8 +685,7 @@ void FGAIShip::ProcessFlightPlan(double dt) {
fp->IncrementWaypoint(false);
next = fp->getNextWaypoint();
if (next->getName() == "WAITUNTIL" || next->getName() == "WAIT"
|| next->getName() == "END" || next->getName() == "TUNNEL")
if (next->getName() == "WAITUNTIL" || next->getName() == "WAIT" || next->getName() == "END" || next->getName() == "TUNNEL")
return;
prev = curr;
@ -686,7 +694,6 @@ void FGAIShip::ProcessFlightPlan(double dt) {
next = fp->getNextWaypoint();
} else if (_next_name == "END" || fp->getNextWaypoint() == 0) {
if (_repeat) {
SG_LOG(SG_AI, SG_INFO, "AIShip: " << _name << " Flightplan repeating ");
fp->restart();
@ -713,7 +720,6 @@ void FGAIShip::ProcessFlightPlan(double dt) {
}
} else if (_next_name == "WAIT") {
if (_wait_count < next->getTime_sec()) {
SG_LOG(SG_AI, SG_DEBUG, "AIShip: " << _name << " waiting ");
setSpeed(0);
@ -723,15 +729,13 @@ void FGAIShip::ProcessFlightPlan(double dt) {
_lead_angle = 0;
return;
} else {
SG_LOG(SG_AI, SG_DEBUG, "AIShip: " << _name
<< " wait done: getting new waypoints ");
SG_LOG(SG_AI, SG_DEBUG, "AIShip: " << _name << " wait done: getting new waypoints ");
_waiting = false;
_wait_count = 0;
fp->IncrementWaypoint(false);
next = fp->getNextWaypoint();
if (next->getName() == "WAITUNTIL" || next->getName() == "WAIT"
|| next->getName() == "END" || next->getName() == "TUNNEL")
if (next->getName() == "WAITUNTIL" || next->getName() == "WAIT" || next->getName() == "END" || next->getName() == "TUNNEL")
return;
prev = curr;
@ -746,16 +750,13 @@ void FGAIShip::ProcessFlightPlan(double dt) {
_until_time = next->getTime();
setUntilTime(next->getTime());
if (until_time_sec > time_sec) {
SG_LOG(SG_AI, SG_INFO, "AIShip: " << _name << " "
<< curr->getName() << " waiting until: "
<< _until_time << " " << until_time_sec << " now " << time_sec );
SG_LOG(SG_AI, SG_INFO, "AIShip: " << _name << " " << curr->getName() << " waiting until: " << _until_time << " " << until_time_sec << " now " << time_sec);
setSpeed(0);
_lead_angle = 0;
_waiting = true;
return;
} else {
SG_LOG(SG_AI, SG_INFO, "AIShip: "
<< _name << " wait until done: getting new waypoints ");
SG_LOG(SG_AI, SG_INFO, "AIShip: " << _name << " wait until done: getting new waypoints ");
setUntilTime("");
fp->IncrementWaypoint(false);
@ -775,7 +776,7 @@ void FGAIShip::ProcessFlightPlan(double dt) {
}
} else {
//now reorganise the waypoints, so that next becomes current and so on
//now reorganize the waypoints, so that next becomes current and so on
SG_LOG(SG_AI, SG_DEBUG, "AIShip: " << _name << " getting new waypoints ");
fp->IncrementWaypoint(false);
prev = fp->getPreviousWaypoint(); //first waypoint
@ -814,8 +815,8 @@ void FGAIShip::ProcessFlightPlan(double dt) {
_dt_count = 0;
} // end Processing FlightPlan
bool FGAIShip::initFlightPlan() {
bool FGAIShip::initFlightPlan()
{
SG_LOG(SG_AI, SG_ALERT, "AIShip: " << _name << " initializing waypoints ");
bool init = false;
@ -894,8 +895,8 @@ bool FGAIShip::initFlightPlan() {
} // end of initialization
double FGAIShip::processTimeString(const string& theTime) {
double FGAIShip::processTimeString(const std::string& theTime)
{
int Hour;
int Minute;
int Second;
@ -907,35 +908,30 @@ double FGAIShip::processTimeString(const string& theTime) {
Second = atoi(theTime.substr(6, 8).c_str());
// offset by a day-sec to allow for starting a day earlier
double time_seconds = Hour * 3600
+ Minute * 60
+ Second;
double time_seconds = Hour * 3600 + Minute * 60 + Second;
return time_seconds;
}
double FGAIShip::getDaySeconds () {
double FGAIShip::getDaySeconds()
{
// Date and time
struct tm* t = globals->get_time_params()->getGmt();
double day_seconds = t->tm_hour * 3600
+ t->tm_min * 60
+ t->tm_sec;
double day_seconds = t->tm_hour * 3600 + t->tm_min * 60 + t->tm_sec;
return day_seconds;
}
bool FGAIShip::advanceFlightPlan (double start_sec, double day_sec) {
bool FGAIShip::advanceFlightPlan(double start_sec, double day_sec)
{
double elapsed_sec = start_sec;
double distance_nm = 0;
//cout << "advancing flight plan start_sec: " << start_sec << " " << day_sec << endl;
while (elapsed_sec < day_sec) {
if (next->getName() == "END" || fp->getNextWaypoint() == 0) {
if (_repeat) {
//cout << _name << ": " << "restarting flightplan" << endl;
fp->restart();
@ -959,8 +955,7 @@ bool FGAIShip::advanceFlightPlan (double start_sec, double day_sec) {
fp->IncrementWaypoint(false);
next = fp->getNextWaypoint();
if (next->getName() != "WAITUNTIL" && next->getName() != "WAIT"
&& next->getName() != "END") {
if (next->getName() != "WAITUNTIL" && next->getName() != "WAIT" && next->getName() != "END") {
prev = curr;
fp->IncrementWaypoint(false);
curr = fp->getCurrentWaypoint();
@ -1053,10 +1048,9 @@ bool FGAIShip::advanceFlightPlan (double start_sec, double day_sec) {
return true;
}
void FGAIShip::setWPPos() {
if (curr->getName() == "END" || curr->getName() == "WAIT"
|| curr->getName() == "WAITUNTIL" || curr->getName() == "TUNNEL"){
void FGAIShip::setWPPos()
{
if (curr->getName() == "END" || curr->getName() == "WAIT" || curr->getName() == "WAITUNTIL" || curr->getName() == "TUNNEL") {
//cout << curr->name << " returning" << endl;
return;
}
@ -1076,11 +1070,10 @@ void FGAIShip::setWPPos() {
}
curr->setAltitude(wppos.getElevationM());
}
void FGAIShip::setXTrackError() {
void FGAIShip::setXTrackError()
{
double course = getCourse(prev->getLatitude(), prev->getLongitude(),
curr->getLatitude(), curr->getLongitude());
double brg = getCourse(pos.getLatitudeDeg(), pos.getLongitudeDeg(),
@ -1098,5 +1091,4 @@ void FGAIShip::setXTrackError() {
_xtrack_error = xtrack_error_nm * 6076.1155;
SG_CLAMP_RANGE(_lead_angle, -limit, limit);
}

View file

@ -21,7 +21,7 @@ class FGAIManager;
class FGAIShip : public FGAIBase
{
public:
FGAIShip(object_type ot = object_type::otShip);
explicit FGAIShip(object_type ot = object_type::otShip);
virtual ~FGAIShip() = default;
std::string_view getTypeString(void) const override { return "ship"; }