DVLRenderer.h

Go to the documentation of this file.

/*
 (C) 2013 SAP AG or an SAP affiliate company. All rights reserved.
*/
#pragma once



#pragma pack(push, 1)
struct sDVLHitTest
{
    uint16_t m_uSizeOfDVLHitTest;

    float m_fScreenCoordinateX;
    float m_fScreenCoordinateY;

    DVLID m_idNode;

    float m_fWorldCoordinateX;
    float m_fWorldCoordinateY;
    float m_fWorldCoordinateZ;

    float m_fLocalCoordinateX;
    float m_fLocalCoordinateY;
    float m_fLocalCoordinateZ;
};
#pragma pack(pop)



class IDVLRenderer
{
protected:
    virtual ~IDVLRenderer() {}//can't be deleted using this interface

public:
    virtual DVLRESULT SetDimensions(uint32_t width, uint32_t height) = 0;

    virtual void SetBackgroundColor(float fTopRed, float fTopGreen, float fTopBlue, float fBottomRed, float fBottomGreen, float fBottomBlue) = 0;

    virtual void SetBackgroundOpacity(float fTopAlpha, float fBottomAlpha) = 0;

    virtual DVLRESULT AttachScene(IDVLScene *pScene) = 0;

    virtual IDVLScene *GetAttachedScenePtr() = 0;

    virtual size_t GetAuxiliaryScenesCount() = 0;

    virtual DVLRESULT AttachAuxiliaryScene(IDVLScene *pScene) = 0;

    virtual DVLRESULT DetachAuxiliaryScene(size_t index) = 0;

    virtual DVLRESULT GetAuxiliarySceneInfo(size_t index, IDVLScene **ppScene, DVLID *pIDAnchorNode, sDVLMatrix *pTMWorld) = 0;

    virtual DVLRESULT SetAuxiliarySceneAnchor(size_t index, DVLID idAnchorNode) = 0;

    virtual DVLRESULT SetAuxiliarySceneAnchorMatrix(size_t index, const sDVLMatrix &tmLocal) = 0;


    virtual DVLRESULT SetAuxiliarySceneMatrix(size_t index, const sDVLMatrix &tmWorld) = 0;

    virtual bool ShouldRenderFrame() const = 0;

    virtual DVLRESULT RenderFrame() = 0;

    virtual DVLRESULT RenderFrameEx(const sDVLMatrix &matView, const sDVLMatrix &matProjection) = 0;

    virtual DVLRESULT GetCameraMatrices(sDVLMatrix &matView, sDVLMatrix &matProjection) const = 0;

    virtual DVLRESULT SetCameraMatrices(const sDVLMatrix &matView, const sDVLMatrix &matProjection, float fCrossFadeSeconds) = 0;

    virtual DVLRESULT SetOption(DVLRENDEROPTION type, bool bEnable) = 0;

    virtual DVLRESULT GetOption(DVLRENDEROPTION type, bool &bEnabled) = 0;

    virtual DVLRESULT SetOptionF(DVLRENDEROPTIONF type, float fValue) = 0;

    virtual DVLRESULT GetOptionF(DVLRENDEROPTIONF type, float &fValue) const = 0;

    virtual DVLRESULT ResetView(uint32_t flags = DVLRESETVIEWFLAG::DVLRESETVIEWFLAG_CAMERA | DVLRESETVIEWFLAG::DVLRESETVIEWFLAG_SMOOTHTRANSITION) = 0;

    virtual DVLRESULT BeginGesture(float x, float y) = 0;

    virtual DVLRESULT EndGesture() = 0;

    virtual DVLRESULT Pan(float dx, float dy) = 0;

    virtual DVLRESULT Rotate(float dx, float dy) = 0;

    virtual DVLRESULT Zoom(float f) = 0;

    virtual bool CanIsolateNode(DVLID id) = 0;

    virtual DVLRESULT SetIsolatedNode(DVLID id) = 0;

    virtual DVLID GetIsolatedNode() = 0;

    virtual DVLRESULT ZoomTo(DVLZOOMTO what, DVLID idNode, float fCrossFadeSeconds) = 0;

    virtual DVLRESULT Tap(float x, float y, bool bDouble) = 0;

    virtual DVLRESULT HitTest(sDVLHitTest *pHitTest) = 0;

    virtual DVLRESULT MultipleHitTest(size_t numHitTests, sDVLHitTest *pHitTests) = 0;

    virtual IDVLTexture *CreateTexture(uint32_t width, uint32_t height, uint8_t bpp, const void *pData) = 0;
    virtual DVLRESULT ReleaseTexture(IDVLTexture *pTexture) = 0;
};