DVLCore.h

Go to the documentation of this file.

/*
 (C) 2016 SAP SE or an SAP affiliate company. All rights reserved.
*/
#pragma once
class IDVLRenderer;


#pragma pack(push, 1)
class sDVLRootEntityItem
{
public:

    char*   m_type;
    char*   m_source;
    const char**   m_fields;
    // The number of pairs in the m_fields array.
    uint32_t m_count;
    char*   m_name;
    
    sDVLRootEntityItem() 
    {
        m_count = 0;
        m_fields = nullptr;
        m_type = m_source = m_name = nullptr;
    }

private:
    sDVLRootEntityItem(const sDVLRootEntityItem& other); // non construction-copyable
    sDVLRootEntityItem& operator=(const sDVLRootEntityItem&); // non copyable

    

};
#pragma pack(pop)

#pragma pack(push, 1)
class sDVLRootEntitiesInfo
{
public:
    uint32_t m_uRootEntitiesCount;

    sDVLRootEntityItem *m_pRootEntities;

    sDVLRootEntitiesInfo()
    {
        m_uRootEntitiesCount = 0;
        m_pRootEntities = nullptr;
    }

private:
    sDVLRootEntitiesInfo(const sDVLRootEntitiesInfo& other); // non construction-copyable
    sDVLRootEntitiesInfo& operator=(const sDVLRootEntitiesInfo&); // non copyable

};
#pragma pack(pop)

class IDVLCore
{
protected:
    virtual ~IDVLCore() {}//use Release() instead

public:

    virtual DVLRESULT Init(IDVLClient *pDVLClient, uint32_t uVersionMajor, uint32_t uVersionMinor) = 0;

    virtual DVLRESULT InitRenderer() = 0;

    virtual DVLRESULT DoneRenderer() = 0;

    virtual void Release() = 0;

    virtual uint32_t GetMajorVersion() = 0;

    virtual uint32_t GetMinorVersion() = 0;

    virtual uint32_t GetMicroVersion() = 0;

    virtual uint32_t GetBuildNumber() = 0;

    virtual DVLRESULT LoadScene(const char *szURL, const char *szOptionalPassword/*set to NULL*/, IDVLScene **ppScene, size_t uBallastBufferSize = 0, sDVLRootEntityItem* pRootEntity = NULL) = 0;

    virtual DVLRESULT LoadSceneFromVDSL(const char *content, const char *password, IDVLScene **ppScene, size_t uBallastBufferSize = 0, sDVLRootEntityItem* pRootEntity = NULL) = 0;

    virtual DVLRESULT CreateEmptyScene(IDVLScene **ppScene, size_t uBallastBufferSize = 0) = 0;


    virtual DVLRESULT RetrieveConfigurationList(const char *szURL, const char *szOptionalPassword, sDVLRootEntitiesInfo* listOfRootEntities) = 0;

    virtual void ReleaseConfigurationList(sDVLRootEntitiesInfo *pInfo) = 0;

    virtual IDVLRenderer *GetRendererPtr() = 0;

    virtual IDVLLibrary *GetLibraryPtr() = 0;

    virtual void OnLowMemory() = 0;

    virtual DVLRESULT SetLocale(const char *szLocale) = 0;

    virtual void ExecuteCallback(void *pCallbackParam) = 0;
};



DVL_EXPORT IDVLCore* DVLCreateCoreInstance();



#ifdef DVL_PLATFORM_ANDROID

void DVL_JNI_OnLoad(void *pJavaVM);
#endif