ksearthshadow.h

Go to the documentation of this file.

/***************************************************************************
                    ksearthshadow.h  -  K Desktop Planetarium
                             -------------------
    begin                : Fri Aug 24 2018
    copyright            : (C) 2018 by Valentin Boettcher
    email                : [email protected] (do not hesitate to contact)
    matrix               : @[email protected]
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#pragma once

#include "ksplanetbase.h"

class KSSun;
class KSMoon;
class KSPlanet;

class KSEarthShadow : public KSPlanetBase
{
    public:
        KSEarthShadow(const KSMoon *moon, const KSSun *sun, const KSPlanet * earth);

        enum ECLIPSE_TYPE
        {
            PARTIAL, FULL_PENUMBRA, FULL_UMBRA, NONE
        };

        bool shouldUpdate();


        bool isInEclipse();

        ECLIPSE_TYPE getEclipseType();

        bool findGeocentricPosition(const KSNumbers *, const KSPlanetBase * Earth = nullptr) override;

        void updateCoords(const KSNumbers *num, bool includePlanets = true, const CachingDms *lat = nullptr,
                          const CachingDms *LST = nullptr, bool forceRecompute = false) override;

        void updateCoords();

        void calculateShadowRadius();

        double getUmbraAngSize() const
        {
            return m_umbra_ang;
        }

        double getPenumbraAngSize() const
        {
            return m_penumbra_ang;
        }

        double findAngularSize() final override
        {
            calculateShadowRadius();
            return m_penumbra_ang;
        }

        // Some Compatibility Nonsense
        void findMagnitude(const KSNumbers *) override {} // Empty
        bool loadData() override
        {
            return true;
        }
        void findPhase() override {}

    private:
        double m_umbra_ang { 0 }; // Radius!
        double m_penumbra_ang { 0 }; // Radius!

        const KSSun* m_sun { nullptr };
        const KSMoon* m_moon { nullptr };
        const KSPlanet* m_earth { nullptr };

        void findSun();
        void findMoon();
        void findEarth();
};