axmol/core/ui/UIPageView.cpp

/****************************************************************************
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.

https://axmolengine.github.io/

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/

#include "ui/UIPageView.h"
#include "ui/UIPageViewIndicator.h"

NS_AX_BEGIN

namespace ui
{

IMPLEMENT_CLASS_GUI_INFO(PageView)

PageView::PageView()
    : _indicator(nullptr)
    , _indicatorPositionAsAnchorPoint(Vec2(0.5f, 0.1f))
    , _currentPageIndex(-1)
    , _childFocusCancelOffset(5.0f)
    , _eventCallback(nullptr)
    , _autoScrollStopEpsilon(0.001f)
    , _previousPageIndex(-1)
    , _isTouchBegin(false)
{}

PageView::~PageView() {}

PageView* PageView::create()
{
    PageView* widget = new PageView();
    if (widget->init())
    {
        widget->autorelease();
        return widget;
    }
    AX_SAFE_DELETE(widget);
    return nullptr;
}

bool PageView::init()
{
    if (ListView::init())
    {
        setDirection(Direction::HORIZONTAL);
        setMagneticType(MagneticType::CENTER);
        setScrollBarEnabled(false);
        return true;
    }
    return false;
}

void PageView::doLayout()
{
    if (!_innerContainerDoLayoutDirty)
    {
        return;
    }

    ListView::doLayout();
    if (_indicator != nullptr)
    {
        _currentPageIndex = getIndex(getCenterItemInCurrentView());
        _indicator->indicate(_currentPageIndex);
    }
    _innerContainerDoLayoutDirty = false;
}

void PageView::setDirection(PageView::Direction direction)
{
    ListView::setDirection(direction);
    if (direction == Direction::HORIZONTAL)
    {
        _indicatorPositionAsAnchorPoint = Vec2(0.5f, 0.1f);
    }
    else if (direction == Direction::VERTICAL)
    {
        _indicatorPositionAsAnchorPoint = Vec2(0.1f, 0.5f);
    }

    if (_indicator != nullptr)
    {
        _indicator->setDirection(direction);
        refreshIndicatorPosition();
    }
}

void PageView::addPage(Widget* page)
{
    pushBackCustomItem(page);
}

void PageView::insertPage(Widget* page, int idx)
{
    insertCustomItem(page, idx);
}

void PageView::removePage(Widget* page)
{
    removeItem(getIndex(page));
}

void PageView::removePageAtIndex(ssize_t index)
{
    removeItem(index);
}

void PageView::removeAllPages()
{
    removeAllItems();
}

ssize_t PageView::getCurrentPageIndex()
{
    // The _currentPageIndex is lazy calculated
    if (_innerContainerDoLayoutDirty)
    {
        _currentPageIndex = getIndex(getCenterItemInCurrentView());
    }
    return _currentPageIndex;
}

void PageView::setCurrentPageIndex(ssize_t index)
{
    jumpToItem(index, Vec2::ANCHOR_MIDDLE, Vec2::ANCHOR_MIDDLE);
}

void PageView::scrollToPage(ssize_t idx)
{
    scrollToItem(idx);
}

void PageView::scrollToPage(ssize_t idx, float time)
{
    scrollToItem(idx, time);
}

void PageView::scrollToItem(ssize_t itemIndex)
{
    if (_innerContainerDoLayoutDirty)
    {
        this->forceDoLayout();
    }
    ListView::scrollToItem(itemIndex, Vec2::ANCHOR_MIDDLE, Vec2::ANCHOR_MIDDLE);
}

void PageView::scrollToItem(ssize_t itemIndex, float time)
{
    if (_innerContainerDoLayoutDirty)
    {
        this->forceDoLayout();
    }
    ListView::scrollToItem(itemIndex, Vec2::ANCHOR_MIDDLE, Vec2::ANCHOR_MIDDLE, time >= 0 ? time : _scrollTime);
}

void PageView::setAutoScrollStopEpsilon(float epsilon)
{
    _autoScrollStopEpsilon = epsilon;
}

void PageView::moveInnerContainer(const Vec2& deltaMove, bool canStartBounceBack)
{
    ListView::moveInnerContainer(deltaMove, canStartBounceBack);
    _currentPageIndex = getIndex(getCenterItemInCurrentView());
    if (_indicator != nullptr)
    {
        _indicator->indicate(_currentPageIndex);
    }
}

void PageView::onItemListChanged()
{
    ListView::onItemListChanged();
    if (_indicator != nullptr)
    {
        _indicator->reset(_items.size());
    }
}

void PageView::onSizeChanged()
{
    ListView::onSizeChanged();
    refreshIndicatorPosition();
}

void PageView::refreshIndicatorPosition()
{
    if (_indicator != nullptr)
    {
        const Vec2& contentSize = getContentSize();
        float posX              = contentSize.width * _indicatorPositionAsAnchorPoint.x;
        float posY              = contentSize.height * _indicatorPositionAsAnchorPoint.y;
        _indicator->setPosition(Vec2(posX, posY));
    }
}

void PageView::handlePressLogic(Touch* touch)
{
    ListView::handlePressLogic(touch);
    if (!_isTouchBegin)
    {
        _currentPageIndex  = getIndex(getCenterItemInCurrentView());
        _previousPageIndex = _currentPageIndex;
        _isTouchBegin      = true;
    }
}

void PageView::handleReleaseLogic(Touch* touch)
{
    // Use `ScrollView` method in order to avoid `startMagneticScroll()` by `ListView`.
    ScrollView::handleReleaseLogic(touch);

    if (_items.empty())
    {
        return;
    }
    Vec2 touchMoveVelocity = flattenVectorByDirection(calculateTouchMoveVelocity());

    static const float INERTIA_THRESHOLD = 500;
    if (touchMoveVelocity.length() < INERTIA_THRESHOLD)
    {
        startMagneticScroll();
    }
    else
    {
        // Handle paging by inertia force.
        Widget* currentPage     = getItem(_currentPageIndex);
        Vec2 destination        = calculateItemDestination(Vec2::ANCHOR_MIDDLE, currentPage, Vec2::ANCHOR_MIDDLE);
        Vec2 deltaToCurrentpage = destination - getInnerContainerPosition();
        deltaToCurrentpage      = flattenVectorByDirection(deltaToCurrentpage);

        // If the direction of displacement to current page and the direction of touch are same, just start magnetic
        // scroll to the current page. Otherwise, move to the next page of touch direction.
        if (touchMoveVelocity.x * deltaToCurrentpage.x > 0 || touchMoveVelocity.y * deltaToCurrentpage.y > 0)
        {
            startMagneticScroll();
        }
        else
        {
            if (touchMoveVelocity.x < 0 || touchMoveVelocity.y > 0)
            {
                ++_currentPageIndex;
            }
            else
            {
                --_currentPageIndex;
            }
            _currentPageIndex = MIN(_currentPageIndex, _items.size() - 1);
            _currentPageIndex = MAX(_currentPageIndex, 0);
            scrollToItem(_currentPageIndex);
        }
    }
}

float PageView::getAutoScrollStopEpsilon() const
{
    return _autoScrollStopEpsilon;
}

void PageView::pageTurningEvent()
{
    this->retain();
    if (_eventCallback)
    {
        _eventCallback(this, EventType::TURNING);
    }
    if (_ccEventCallback)
    {
        _ccEventCallback(this, static_cast<int>(EventType::TURNING));
    }
    _isTouchBegin = false;
    this->release();
}

void PageView::addEventListener(const ccPageViewCallback& callback)
{
    _eventCallback                          = callback;
    ccScrollViewCallback scrollViewCallback = [=](Ref* /*ref*/, ScrollView::EventType type) -> void {
        if (type == ScrollView::EventType::AUTOSCROLL_ENDED && _previousPageIndex != _currentPageIndex)
        {
            pageTurningEvent();
        }
    };
    this->addEventListener(scrollViewCallback);
}

std::string PageView::getDescription() const
{
    return "PageView";
}

Widget* PageView::createCloneInstance()
{
    return PageView::create();
}

void PageView::copySpecialProperties(Widget* widget)
{
    PageView* pageView = dynamic_cast<PageView*>(widget);
    if (pageView)
    {
        ListView::copySpecialProperties(widget);
        _eventCallback                  = pageView->_eventCallback;
        _ccEventCallback                = pageView->_ccEventCallback;
        _currentPageIndex               = pageView->_currentPageIndex;
        _previousPageIndex              = pageView->_previousPageIndex;
        _childFocusCancelOffset         = pageView->_childFocusCancelOffset;
        _autoScrollStopEpsilon          = pageView->_autoScrollStopEpsilon;
        _indicatorPositionAsAnchorPoint = pageView->_indicatorPositionAsAnchorPoint;
        _isTouchBegin                   = pageView->_isTouchBegin;
    }
}

void PageView::setIndicatorEnabled(bool enabled)
{
    if (enabled == (_indicator != nullptr))
    {
        return;
    }

    if (!enabled)
    {
        removeProtectedChild(_indicator);
        _indicator = nullptr;
    }
    else
    {
        _indicator = PageViewIndicator::create();
        _indicator->setDirection(getDirection());
        addProtectedChild(_indicator, 10000);
        setIndicatorSelectedIndexColor(Color3B(100, 100, 255));
        refreshIndicatorPosition();
    }
}

void PageView::setIndicatorPositionAsAnchorPoint(const Vec2& positionAsAnchorPoint)
{
    _indicatorPositionAsAnchorPoint = positionAsAnchorPoint;
    refreshIndicatorPosition();
}

const Vec2& PageView::getIndicatorPositionAsAnchorPoint() const
{
    return _indicatorPositionAsAnchorPoint;
}

void PageView::setIndicatorPosition(const Vec2& position)
{
    if (_indicator != nullptr)
    {
        const Vec2& contentSize           = getContentSize();
        _indicatorPositionAsAnchorPoint.x = position.x / contentSize.width;
        _indicatorPositionAsAnchorPoint.y = position.y / contentSize.height;
        _indicator->setPosition(position);
    }
}

const Vec2& PageView::getIndicatorPosition() const
{
    AXASSERT(_indicator != nullptr, "");
    return _indicator->getPosition();
}

void PageView::setIndicatorSpaceBetweenIndexNodes(float spaceBetweenIndexNodes)
{
    if (_indicator != nullptr)
    {
        _indicator->setSpaceBetweenIndexNodes(spaceBetweenIndexNodes);
    }
}
float PageView::getIndicatorSpaceBetweenIndexNodes() const
{
    AXASSERT(_indicator != nullptr, "");
    return _indicator->getSpaceBetweenIndexNodes();
}

void PageView::setIndicatorSelectedIndexColor(const Color3B& color)
{
    if (_indicator != nullptr)
    {
        _indicator->setSelectedIndexColor(color);
    }
}

const Color3B& PageView::getIndicatorSelectedIndexColor() const
{
    AXASSERT(_indicator != nullptr, "");
    return _indicator->getSelectedIndexColor();
}

void PageView::setIndicatorIndexNodesColor(const Color3B& color)
{
    if (_indicator != nullptr)
    {
        _indicator->setIndexNodesColor(color);
    }
}

const Color3B& PageView::getIndicatorIndexNodesColor() const
{
    AXASSERT(_indicator != nullptr, "");
    return _indicator->getIndexNodesColor();
}

void PageView::setIndicatorSelectedIndexOpacity(uint8_t opacity)
{
    if (_indicator != nullptr)
    {
        _indicator->setSelectedIndexOpacity(opacity);
    }
}

uint8_t PageView::getIndicatorSelectedIndexOpacity() const
{
    AXASSERT(_indicator != nullptr, "");
    return _indicator->getSelectedIndexOpacity();
}

void PageView::setIndicatorIndexNodesOpacity(uint8_t opacity)
{
    if (_indicator != nullptr)
    {
        _indicator->setIndexNodesOpacity(opacity);
    }
}

uint8_t PageView::getIndicatorIndexNodesOpacity() const
{
    AXASSERT(_indicator != nullptr, "");
    return _indicator->getIndexNodesOpacity();
}

void PageView::setIndicatorIndexNodesScale(float indexNodesScale)
{
    if (_indicator != nullptr)
    {
        _indicator->setIndexNodesScale(indexNodesScale);
        _indicator->indicate(_currentPageIndex);
    }
}

float PageView::getIndicatorIndexNodesScale() const
{
    AXASSERT(_indicator != nullptr, "");
    return _indicator->getIndexNodesScale();
}

void PageView::setIndicatorIndexNodesTexture(std::string_view texName, Widget::TextureResType texType)
{
    if (_indicator != nullptr)
    {
        _indicator->setIndexNodesTexture(texName, texType);
        _indicator->indicate(_currentPageIndex);
    }
}

void PageView::remedyLayoutParameter(Widget* item)
{
    item->setContentSize(this->getContentSize());
    ListView::remedyLayoutParameter(item);
}

}  // namespace ui

NS_AX_END