YiImageView.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_IMAGE_VIEW_H_
#define _YI_IMAGE_VIEW_H_

#include "asset/YiAssetTexture.h"
#include "network/YiAssetDownloadHelper.h"
#include "network/YiUrl.h"
#include "signal/YiSignal.h"
#include "utility/YiColor.h"
#include "view/YiSceneView.h"

class CYIImageLoader;
class CYILoadThreadManager;
class CYITextSceneNode;
class CYIUrl;

class CYIImageView : public CYISceneView
{
public:
    enum SCALE_MODE
    {
        SCALE_STRETCH = 0, 
        SCALE_FILL, 
        SCALE_FILL_WITH_OVERFLOW, 
        SCALE_FIT, 
        SCALE_ACTUAL_SIZE, 
        SCALE_ACTUAL_SIZE_WITH_OVERFLOW 
    };

    enum REPEAT_MODE
    {
        REPEAT_NONE, 
        REPEAT_TILE, 
        REPEAT_MIRROR, 
        REPEAT_CLAMP_TO_EDGE 
    };

    CYIImageView();
    virtual ~CYIImageView();

        virtual bool Init() override;

    void SetScaleMode(SCALE_MODE eScaleMode);
    
    SCALE_MODE GetScaleMode() const;

    void SetRepeatMode(REPEAT_MODE eRepeatMode);

    REPEAT_MODE GetRepeatMode() const;

    void SetMipmappingEnabled(bool bEnable);

    bool IsMipmappingEnabled() const;

    void SetImage(const std::shared_ptr<CYIAssetTextureBase> &pTexture);

    void SetImage(const CYIUrl &url);

    virtual void Reset() override;

    void SetOverlayTextColor(const CYIColor &color);

    void SetOverlayTextSize(const uint32_t &nFontSize);

    void SetOverlayTextFontID(const ssize_t &nFontID);

    void SetOverlayText(const CYIString &text);

    virtual void OnImageHasChanged();

    CYISceneNode *GetImageNode() const;

    void SetImageUrl(const CYIUrl &url);

    const CYIUrl &GetImageUrl() const;

    virtual void Measure(const MeasureSpec &widthSpec, const MeasureSpec &heightSpec, const MeasureSpec &depthSpec) override;

    virtual void ApplyMeasurements() override;

    CYISignal<> ImageAssigned;
    CYISignal<const CYIString &> ImageAssignmentFailed;

protected:
    float m_fImagePlaceholderWidth;
    float m_fImagePlaceholderHeight;
    float m_fImagePlaceholderAspectRatio;
    glm::vec3 m_imagePlaceholderAnchorPoint;

    CYISceneNode *m_pImageNode;

    CYITextSceneNode *m_pDefaultTextNode;
    CYIString m_sDefaultText;
    CYIColor m_DefaultTextColor;
    int32_t m_nDefaultFontSize;
    ssize_t m_nDefaultFontID;
    SCALE_MODE m_eScaleMode;
    REPEAT_MODE m_eRepeatMode;
    bool m_bUseMipmapping;
    CYIUrl m_ImageUrl;

    std::shared_ptr<CYIAssetTexture> m_pTextAsset;
    std::shared_ptr<CYIMesh> m_pImagePlaceholderMesh;
    std::shared_ptr<CYIMaterial> m_pImagePlaceholderMaterial;

private:
    enum class DisplayState;

    void AssetReady(const std::shared_ptr<CYIAsset> &pTex, const CYIUrl &url);
    void AssetDownloadFailed(CYIAssetDownloadHelper::FAILURE_TYPE eFailureType, const CYIUrl &url);
    void AssetDownloadCancelled(const CYIUrl &url);
    void OnImageDownloadFailed(const CYIString &rError);
    void ReconfigureSize(CYISceneNode *pNode);
    void Cleanup();
    std::shared_ptr<CYIMesh> ResizeImageNodeMesh(CYISceneNode *pNode, float fNewWidth, float fNewHeight) const;
    void PlayTransitionTimeline(DisplayState from, DisplayState to);
    void TransitionToState(DisplayState to);
    void ValidateRepeatMode();

    DisplayState m_eImageDisplayState;

    CYISceneNode *m_pSwapNode;
    CYIAbstractTimeline *m_pImageSwapTimeline;
    std::unique_ptr<CYIAbstractTimeline> m_pResetTimeline;
    CYIAbstractTimeline *m_pImagePlaceholderToSuccessTimeline;
    CYIAbstractTimeline *m_pImagePlaceholderToFailureTimeline;
    CYIAbstractTimeline *m_pImagePlaceholderFailureToSuccessTimeline;
    CYIAbstractTimeline *m_pImageFailureToSuccessTimeline;
    CYIAbstractTimeline *m_pImageSuccessToFailureTimeline;

    CYIAssetDownloadHelper m_imageDownloader;

    YI_TYPE_BASES(CYIImageView, CYISceneView)
};

#endif // _YI_IMAGE_VIEW_H_