d_wipe_circle.hpp

#pragma once
#include <game/mLib/m_fader_base.hpp>
#include <game/bases/d_lytbase.hpp>
#include <nw4r/ut.h>
 
/// @brief A fader that animates a circle in/out.
/// @details Seen when entering a pipe, for example.
/// @ingroup bases
class dWipeCircle_c : public mFaderBase_c {
public:
 
    /// @brief The possible actions performed in ::calc.
    enum ACTION_e {
        OPEN_SETUP, ///< Prepare the fade-out transition.
        ANIME_END_CHECK, ///< Fade has begun, waiting for it to end.
        CLOSE_SETUP, ///< Prepare the fade-in transition.
        IDLE, ///< The fade has not been started.
        ACTION_COUNT = IDLE,
    };
 
    /// @brief The animations for this fader.
    enum ANIM_e {
        IN, ///< Fade-in animation.
        OUT, ///< Fade-out animation.
        ANIM_COUNT
    };
 
    /// @brief The animation names used for the fader.
    enum ANIM_NAME_e {
        inWindow,
        outWindow,
        ANIM_NAME_COUNT
    };
 
    /// @brief The window panes used for the fader.
    enum W_PANE_e {
        W_circle_00,
        W_COUNT
    };
 
    dWipeCircle_c(nw4r::ut::Color, mFaderBase_c::EStatus status); ///< @copydoc mFaderBase_c::mFaderBase_c
    ~dWipeCircle_c(); ///< @copydoc mFaderBase_c::~mFaderBase_c
 
    /// @brief Loads the resources and creates the layout for the fader.
    /// @return Whether the creation was successful.
    bool createLayout();
 
    /// @brief Sets the circle's center position.
    void CenterPosSet();
 
    /// @brief Prepares the fade-out transition.
    void OpenSetup();
 
    /// @brief Checks if the fade animation has finished yet.
    /// @details If the animation has finished, sets the status accordingly
    /// and switches back to the ::IDLE action.
    void AnimeEndCheck();
 
    /// @brief Prepares the fade-in transition.
    void CloseSetup();
 
    virtual int calc();
    virtual void draw();
    virtual void setStatus(mFaderBase_c::EStatus status); ///< @copydoc mFaderBase_c::setStatus
    virtual bool fadeIn();
    virtual bool fadeOut();
 
    static dWipeCircle_c *m_instance; ///< The instance of the fader.
 
private:
    LytBase_c mLyt; ///< The layout for the fader.
    nw4r::lyt::Pane *mpRootPane; ///< The root pane of the fader layout.
    nw4r::lyt::Window *mpWnd[W_COUNT]; ///< The window panes of the fader.
    mVec2_c mCenterPos; ///< The screen position of the circle's center point.
    ACTION_e mAction; ///< The action to be performed in ::calc.
    bool mIsCreated; ///< Whether the layout for the fader has been created.
 
    /// @brief Whether the circle's center point needs to be targeted at a specific position.
    /// @details If set to @p false, the circle is centered on the screen automatically.
    bool mHasTarget;
 
    /// @brief Whether ::mCenterPos should be used as the circle's center point.
    /// @details If set to @p false, the circle is centered on the current demo player.
    bool mUseCenterPos;
};