axmol/core/ui/UIImageView.cpp

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

https://adxeproject.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/UIImageView.h"
#include "ui/UIScale9Sprite.h"
#include "ui/UIHelper.h"
#include "2d/CCSprite.h"

NS_CC_BEGIN

namespace ui
{

static const int IMAGE_RENDERER_Z = (-1);

IMPLEMENT_CLASS_GUI_INFO(ImageView)

ImageView::ImageView()
    : _scale9Enabled(false)
    , _prevIgnoreSize(true)
    , _capInsets(Rect::ZERO)
    , _imageRenderer(nullptr)
    , _imageTexType(TextureResType::LOCAL)
    , _imageTextureSize(_contentSize)
    , _imageRendererAdaptDirty(true)
    , _textureFile("")
{}

ImageView::~ImageView() {}

ImageView* ImageView::create(std::string_view imageFileName, TextureResType texType)
{
    ImageView* widget = new ImageView();
    if (widget->init(imageFileName, texType))
    {
        widget->autorelease();
        return widget;
    }
    CC_SAFE_DELETE(widget);
    return nullptr;
}

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

bool ImageView::init()
{
    bool ret = true;
    do
    {
        if (!Widget::init())
        {
            ret = false;
            break;
        }
        _imageTexType = TextureResType::LOCAL;
    } while (0);
    return ret;
}

bool ImageView::init(std::string_view imageFileName, TextureResType texType)
{
    bool bRet = true;
    do
    {
        if (!Widget::init())
        {
            bRet = false;
            break;
        }

        this->loadTexture(imageFileName, texType);
    } while (0);
    return bRet;
}

void ImageView::initRenderer()
{
    _imageRenderer = Scale9Sprite::create();
    _imageRenderer->setRenderingType(Scale9Sprite::RenderingType::SIMPLE);

    addProtectedChild(_imageRenderer, IMAGE_RENDERER_Z, -1);
}

void ImageView::loadTexture(std::string_view fileName, TextureResType texType)
{
    if (fileName.empty())
    {
        return;
    }
    _textureFile  = fileName;
    _imageTexType = texType;
    switch (_imageTexType)
    {
    case TextureResType::LOCAL:
        _imageRenderer->initWithFile(fileName);
        break;
    case TextureResType::PLIST:
        _imageRenderer->initWithSpriteFrameName(fileName);
        break;
    default:
        break;
    }
    // FIXME: https://github.com/cocos2d/cocos2d-x/issues/12249
    if (!_ignoreSize && _customSize.equals(Vec2::ZERO))
    {
        _customSize = _imageRenderer->getContentSize();
    }
    this->setupTexture();
}

void ImageView::loadTexture(SpriteFrame* spriteframe)
{
    _imageRenderer->initWithSpriteFrame(spriteframe);
    this->setupTexture();
}

void ImageView::setupTexture()
{
    _imageTextureSize = _imageRenderer->getContentSize();

    this->updateChildrenDisplayedRGBA();

    updateContentSizeWithTextureSize(_imageTextureSize);
    _imageRendererAdaptDirty = true;
}

void ImageView::setTextureRect(const Rect& rect)
{
    // This API should be refactor
    if (_scale9Enabled)
    {}
    else
    {
        auto sprite = _imageRenderer->getSprite();
        if (sprite)
        {
            sprite->setTextureRect(rect);
        }
        else
        {
            CCLOG("Warning!! you should load texture before set the texture's rect!");
        }
    }
}

void ImageView::setScale9Enabled(bool able)
{
    if (_scale9Enabled == able)
    {
        return;
    }

    _scale9Enabled = able;
    if (_scale9Enabled)
    {
        _imageRenderer->setRenderingType(Scale9Sprite::RenderingType::SLICE);
    }
    else
    {
        _imageRenderer->setRenderingType(Scale9Sprite::RenderingType::SIMPLE);
    }

    if (_scale9Enabled)
    {
        bool ignoreBefore = _ignoreSize;
        ignoreContentAdaptWithSize(false);
        _prevIgnoreSize = ignoreBefore;
    }
    else
    {
        ignoreContentAdaptWithSize(_prevIgnoreSize);
    }
    setCapInsets(_capInsets);
    _imageRendererAdaptDirty = true;
}

bool ImageView::isScale9Enabled() const
{
    return _scale9Enabled;
}

void ImageView::ignoreContentAdaptWithSize(bool ignore)
{
    if (!_scale9Enabled || (_scale9Enabled && !ignore))
    {
        Widget::ignoreContentAdaptWithSize(ignore);
        _prevIgnoreSize = ignore;
    }
}

void ImageView::setCapInsets(const Rect& capInsets)
{
    _capInsets = ui::Helper::restrictCapInsetRect(capInsets, _imageTextureSize);
    if (!_scale9Enabled)
    {
        return;
    }
    _imageRenderer->setCapInsets(_capInsets);
}

const Rect& ImageView::getCapInsets() const
{
    return _capInsets;
}

void ImageView::onSizeChanged()
{
    Widget::onSizeChanged();
    _imageRendererAdaptDirty = true;
}

void ImageView::adaptRenderers()
{
    if (_imageRendererAdaptDirty)
    {
        imageTextureScaleChangedWithSize();
        _imageRendererAdaptDirty = false;
    }
}

Vec2 ImageView::getVirtualRendererSize() const
{
    return _imageTextureSize;
}

Node* ImageView::getVirtualRenderer()
{
    return _imageRenderer;
}

void ImageView::imageTextureScaleChangedWithSize()
{
    _imageRenderer->setPreferredSize(_contentSize);

    _imageRenderer->setPosition(_contentSize.width / 2.0f, _contentSize.height / 2.0f);
}

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

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

void ImageView::copySpecialProperties(Widget* widget)
{
    ImageView* imageView = dynamic_cast<ImageView*>(widget);
    if (imageView)
    {
        _prevIgnoreSize = imageView->_prevIgnoreSize;
        setScale9Enabled(imageView->_scale9Enabled);
        auto imageSprite = imageView->_imageRenderer->getSprite();
        if (nullptr != imageSprite)
        {
            loadTexture(imageSprite->getSpriteFrame());
        }
        setCapInsets(imageView->_capInsets);
    }
}

ResourceData ImageView::getRenderFile()
{
    ResourceData rData;
    rData.type = (int)_imageTexType;
    rData.file = _textureFile;
    return rData;
}

void ImageView::setBlendFunc(const BlendFunc& blendFunc)
{
    _imageRenderer->setBlendFunc(blendFunc);
}

const BlendFunc& ImageView::getBlendFunc() const
{
    return _imageRenderer->getBlendFunc();
}

}  // namespace ui

NS_CC_END