YiViewTemplate.h

Go to the documentation of this file.

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

#include "animation/YiMarkerData.h"
#include "animation/YiTimeline.h"
#include "asset/YiAssetTimelineSource.h"
#include "binding/YiScriptableRTTIObject.h"
#include "framework/YiPredef.h"
#include "import/YiPropertiesSource.h"
#include "utility/YiString.h"
#include "scenetree/YiSceneManager.h"

class CYIAssetViewTemplate;
class CYIColor;
class CYISceneView;



class CYIViewTemplate : public IYIPropertiesSource, public CYIScriptableRTTIObject
{
    friend class CYISceneView;

public:
    static const uint32_t DEFAULT_TIMELINE_INDEX;

    class Source
    {
    public:
        enum TYPE
        {
            TYPE_COMPOSITION, 
            TYPE_IMAGE, 
            TYPE_SOLID, 
            TYPE_NULL, 
            TYPE_IMAGE_NPATCH, 
            TYPE_MASK, 
            TYPE_NONE, 
            TYPE_SPRITE, 
            TYPE_ADJUSTMENT, 
            TYPE_FONT 
        };

        Source();

        const CYIString &GetName() const;
        void SetName(const CYIString &name);
        TYPE GetSourceType() const;
        void SetSourceType(TYPE eSourceType);

    private:
        CYIString m_name;
        TYPE m_sourceType;
    };

    virtual ~CYIViewTemplate() {}

    static std::shared_ptr<CYIAssetViewTemplate> GetViewTemplate(const CYIString &viewTemplateName);

    static glm::vec2 GetViewTemplateSize(const CYIString &viewTemplateName);

    std::unique_ptr<CYISceneView> BuildView(CYISceneManager *pSceneManager, const std::shared_ptr<CYIAssetViewTemplate> &pAssetViewTemplate);

    virtual void SetTimelineSource(uint32_t uTimelineHandle, std::shared_ptr<CYIAssetTimelineSource> pTimelineSource) = 0;

    virtual std::shared_ptr<CYIAssetTimelineSource> GetTimelineSource(uint32_t uTimelineHandle) = 0;

    virtual std::unique_ptr<CYITimeline> BuildTimeline(CYISceneNode *pRootNode) = 0;

    virtual std::unique_ptr<CYITimeline> BuildTimeline(CYISceneNode *pRootNode, const CYIString &markerName) = 0;

    virtual std::unique_ptr<CYITimeline> BuildTimeline(CYISceneNode *pRootNode, CYIMarkerData::MARKER_ID eID) = 0;

    virtual std::unique_ptr<CYITimeline> BuildTimeline(CYISceneNode *pRootNode, int32_t nStartOffset, int32_t nDuration) = 0;

    virtual std::unique_ptr<CYITimeline> BuildTimeline(CYISceneNode *pRootNode, uint32_t uTimelineHandle) = 0;

    virtual std::unique_ptr<CYITimeline> BuildTimeline(CYISceneNode *pRootNode, uint32_t uTimelineHandle, const CYIString &markerName) = 0;

    virtual std::unique_ptr<CYITimeline> BuildTimeline(CYISceneNode *pRootNode, uint32_t uTimelineHandle, CYIMarkerData::MARKER_ID eID) = 0;

    virtual std::unique_ptr<CYITimeline> BuildTimeline(CYISceneNode *pRootNode, uint32_t uTimelineHandle, int32_t nStartOffset, int32_t nDuration) = 0;

    virtual void GetSize(float &fWidth, float &fHeight) = 0;

    virtual float GetHeight() = 0;

    virtual float GetWidth() = 0;

    virtual float GetDefaultCameraDistance();

    virtual CYIString GetName() const = 0;

    virtual const CYIString &GetViewClassName() const = 0;

    virtual bool GetBackgroundColor(CYIColor *pColor) = 0;

    virtual bool GetProperty(const CYIString &propertyName, CYIString *pValue) const override = 0;
    
    virtual const std::map<CYIString, CYIString> &GetProperties() const override = 0;

    virtual const std::vector<CYIString> &GetChildTemplateNames() = 0;

    virtual int32_t GetApproximateSize() const = 0;

    virtual std::vector<Source> GetSources() const = 0;

protected:
    CYIViewTemplate() {}

private:
    virtual bool BuildTree(CYISceneNode *pRootNode, const CYIString &path, CYISceneManager::MISSING_CLASS_HANDLING_MODE eMissingHandlingMode = CYISceneManager::ABORT) = 0;

    YI_TYPE_BASES_WITH_SCRIPTABLE_BASE(CYIViewTemplate)
};

#endif // _YI_VIEW_TEMPLATE_H_