Files
pilotclient/src/blackmisc/simulation/interpolationrenderingsetup.h

292 lines
12 KiB
C++

/* Copyright (C) 2016
* swift Project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
* or distributed except according to the terms contained in the LICENSE file.
*/
//! \file
#ifndef BLACKMISC_SIMULATION_INTERPOLATIONRENDERINGSETUP_H
#define BLACKMISC_SIMULATION_INTERPOLATIONRENDERINGSETUP_H
#include "blackmisc/aviation/callsign.h"
#include "blackmisc/pq/length.h"
#include "blackmisc/pq/angle.h"
#include "blackmisc/blackmiscexport.h"
#include "blackmisc/propertyindexlist.h"
#include "blackmisc/valueobject.h"
#include <QString>
namespace BlackMisc
{
namespace Network { class CClient; }
namespace Simulation
{
//! Value object for interpolator and rendering base class
class BLACKMISC_EXPORT CInterpolationAndRenderingSetupBase
{
public:
//! Properties by index
enum ColumnIndex
{
IndexLogInterpolation = CPropertyIndex::GlobalIndexCInterpolatioRenderingSetup,
IndexSimulatorDebugMessages,
IndexForceFullInterpolation,
IndexSendGndFlagToSimulator,
IndexEnabledAircraftParts,
IndexInterpolatorMode,
IndexInterpolatorModeAsString,
IndexFixSceneryOffset,
IndexPitchOnGround
};
//! Interpolator type
enum InterpolatorMode
{
Spline,
Linear
};
//! Debugging messages for simulation
bool showSimulatorDebugMessages() const { return m_simulatorDebugMessages; }
//! Debugging messages for simulation
void setSimulatorDebuggingMessages(bool debug) { m_simulatorDebugMessages = debug; }
//! Log.interpolation
bool logInterpolation() const { return m_logInterpolation; }
//! Log.interpolation
bool setLogInterpolation(bool log);
//! Full interpolation (skip optimizations like checking if aircraft moves etc.)
bool isForcingFullInterpolation() const { return m_forceFullInterpolation; }
//! Force full interpolation
void setForceFullInterpolation(bool force) { m_forceFullInterpolation = force; }
//! Set enabled aircraft parts
bool setEnabledAircraftParts(bool enabled);
//! Mask enabled aircraft parts
bool maskEnabledAircraftParts(bool mask);
//! Aircraft parts enabled (still requires the other aircraft to send parts)
bool isAircraftPartsEnabled() const { return m_enabledAircraftParts; }
//! Send GND flag to simulator
bool isSendingGndFlagToSimulator() const { return m_sendGndToSim; }
//! Set sending GND flag to simulator
bool setSendingGndFlagToSimulator(bool sendFLag);
//! Fix scenery offset if it has been detected
bool isFixingSceneryOffset() const { return m_fixSceneryOffset; }
//! Enable fix scenery offset if it has been detected
void setFixingSceneryOffset(bool fix) { m_fixSceneryOffset = fix; }
//! Force a given pitch on ground
const PhysicalQuantities::CAngle &getPitchOnGround() const { return m_pitchOnGround; }
//! Force a given pitch on ground
bool setPitchOnGround(const PhysicalQuantities::CAngle &pitchOnGround);
//! Consolidate with a network client
void consolidateWithClient(const Network::CClient &client);
//! Interpolator mode
InterpolatorMode getInterpolatorMode() const { return static_cast<InterpolatorMode>(m_interpolatorMode); }
//! Interpolator mode
const QString &getInterpolatorModeAsString() const { return modeToString(this->getInterpolatorMode()); }
//! Set interpolator mode
bool setInterpolatorMode(InterpolatorMode mode);
//! Set interpolator mode
bool setInterpolatorMode(const QString &mode);
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const CPropertyIndex &index) const;
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CPropertyIndex &index, const CVariant &variant);
//! Interpolator mode as string
static const QString &modeToString(InterpolatorMode mode);
protected:
//! Constructor
CInterpolationAndRenderingSetupBase();
//! Can handle index?
static bool canHandleIndex(int index);
bool m_logInterpolation = false; //!< Debug messages in interpolator
bool m_simulatorDebugMessages = false; //!< Debug messages of simulator (aka plugin)
bool m_forceFullInterpolation = false; //!< always do a full interpolation, even if aircraft is not moving
bool m_enabledAircraftParts = true; //!< Enable aircraft parts
bool m_sendGndToSim = true; //!< Send the gnd.flag to simulator
bool m_fixSceneryOffset = false; //!< Fix. scenery offset
int m_interpolatorMode = static_cast<int>(Spline); //!< interpolator mode (spline, ...)
PhysicalQuantities::CAngle m_pitchOnGround = PhysicalQuantities::CAngle::null(); //!< pitch angle on ground
};
//! Value object for interpolator and rendering
class BLACKMISC_EXPORT CInterpolationAndRenderingSetupGlobal :
public CValueObject<CInterpolationAndRenderingSetupGlobal>,
public CInterpolationAndRenderingSetupBase
{
public:
//! Properties by index
enum ColumnIndex
{
IndexMaxRenderedAircraft = CInterpolationAndRenderingSetupBase::IndexFixSceneryOffset + 1,
IndexMaxRenderedDistance
};
//! Constructor.
CInterpolationAndRenderingSetupGlobal();
//! Considered as "all aircraft"
static int InfiniteAircraft();
//! Max.number of aircraft rendered
int getMaxRenderedAircraft() const;
//! Max.number of aircraft rendered
bool setMaxRenderedAircraft(int maxRenderedAircraft);
//! Max.distance for rendering
bool setMaxRenderedDistance(const PhysicalQuantities::CLength &distance);
//! Disable
void clearMaxRenderedDistance();
//! Rendering enabled (at all)?
bool isRenderingEnabled() const;
//! Rendering enabled, but restricted
bool isRenderingRestricted() const;
//! Max.distance for rendering
PhysicalQuantities::CLength getMaxRenderedDistance() const { return m_maxRenderedDistance; }
//! Restricted by distance?
bool isMaxDistanceRestricted() const;
//! Restricted by quantity?
bool isMaxAircraftRestricted() const;
//! Remove all render restrictions
void clearAllRenderingRestrictions();
//! Entirely disable rendering
void disableRendering();
//! Text describing the restrictions
QString getRenderRestrictionText() const;
//! Set all base values
void setBaseValues(const CInterpolationAndRenderingSetupBase &baseValues);
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const CPropertyIndex &index) const;
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CPropertyIndex &index, const CVariant &variant);
private:
int m_maxRenderedAircraft = InfiniteAircraft(); //!< max.rendered aircraft
PhysicalQuantities::CLength m_maxRenderedDistance { 0, nullptr }; //!< max.distance for rendering
BLACK_METACLASS(
CInterpolationAndRenderingSetupGlobal,
BLACK_METAMEMBER(logInterpolation),
BLACK_METAMEMBER(simulatorDebugMessages),
BLACK_METAMEMBER(forceFullInterpolation),
BLACK_METAMEMBER(sendGndToSim),
BLACK_METAMEMBER(enabledAircraftParts),
BLACK_METAMEMBER(fixSceneryOffset),
BLACK_METAMEMBER(interpolatorMode),
BLACK_METAMEMBER(pitchOnGround),
BLACK_METAMEMBER(maxRenderedAircraft),
BLACK_METAMEMBER(maxRenderedDistance)
);
};
//! Value object for interpolator and rendering per callsign
class BLACKMISC_EXPORT CInterpolationAndRenderingSetupPerCallsign :
public CValueObject<CInterpolationAndRenderingSetupPerCallsign>,
public CInterpolationAndRenderingSetupBase
{
public:
//! Properties by index
enum ColumnIndex
{
IndexCallsign = CInterpolationAndRenderingSetupGlobal::IndexMaxRenderedDistance + 1
};
//! Constructor
CInterpolationAndRenderingSetupPerCallsign();
//! Constructor from global setup
CInterpolationAndRenderingSetupPerCallsign(const Aviation::CCallsign &callsign, const CInterpolationAndRenderingSetupGlobal &globalSetup);
//! Properties unequal to global setup
CPropertyIndexList unequalToGlobal(const CInterpolationAndRenderingSetupGlobal &globalSetup) const;
//! Equal to global setup?
bool isEqualToGlobal(const CInterpolationAndRenderingSetupGlobal &globalSetup) const;
//! Get callsign
const Aviation::CCallsign &getCallsign() const { return m_callsign; }
//! Set callsign
void setCallsign(const Aviation::CCallsign &callsign) { m_callsign = callsign; }
//! NULL?
bool isNull() const { return m_callsign.isEmpty(); }
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const CPropertyIndex &index) const;
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CPropertyIndex &index, const CVariant &variant);
//! NULL object
static const CInterpolationAndRenderingSetupPerCallsign &null();
private:
Aviation::CCallsign m_callsign;
BLACK_METACLASS(
CInterpolationAndRenderingSetupPerCallsign,
BLACK_METAMEMBER(logInterpolation),
BLACK_METAMEMBER(simulatorDebugMessages),
BLACK_METAMEMBER(forceFullInterpolation),
BLACK_METAMEMBER(sendGndToSim),
BLACK_METAMEMBER(enabledAircraftParts),
BLACK_METAMEMBER(fixSceneryOffset),
BLACK_METAMEMBER(interpolatorMode),
BLACK_METAMEMBER(pitchOnGround)
);
};
} // namespace
} // namespace
Q_DECLARE_METATYPE(BlackMisc::Simulation::CInterpolationAndRenderingSetupPerCallsign)
Q_DECLARE_METATYPE(BlackMisc::Simulation::CInterpolationAndRenderingSetupGlobal)
Q_DECLARE_METATYPE(BlackMisc::Simulation::CInterpolationAndRenderingSetupBase::InterpolatorMode)
#endif // guard