DVLScene.h

Go to the documentation of this file.

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



enum DVLSCENEINFO
{
    DVLSCENEINFO_CHILDREN                           = (1 << 0),

    DVLSCENEINFO_SELECTED                           = (1 << 1),

    DVLSCENEINFO_LOCALIZATION_PREFIX                = (1 << 2),

    DVLSCENEINFO_DIMENSIONS                         = (1 << 3),

    DVLSCENEINFO_STEP_INFO                          = (1 << 4),

    DVLSCENEINFO_LAYERS                             = (1 << 5),

    DVLSCENEINFO_DISPLAY_UNITS                      = (1 << 6),

    DVLSCENEINFO_MATERIALS                          = (1 << 7),

    DVLSCENEINFO_HOTSPOTS                           = (1 << 8),

    DVLSCENEINFO_HOTSPOT_LAYERS                     = (1 << 9),
};

#pragma pack(push, 1)
struct sDVLSceneInfo
{
    uint16_t m_uSizeOfDVLSceneInfo;

    uint32_t m_uChildNodesCount;

    DVLID *m_pChildNodes;

    uint32_t m_uSelectedNodesCount;

    DVLID *m_pSelectedNodes;

    char *m_szLocalizationPrefix;

    float m_vSceneDimensions[2][3];

    DVLID m_uStepId;
    float m_fStepTime;

    uint32_t m_uLayersCount;

    DVLID *m_pLayers;

    double m_dDisplayUnits;
};
#pragma pack(pop)



enum DVLNODEINFO
{
    DVLNODEINFO_NAME                                = 0x0001,

    DVLNODEINFO_ASSETID                             = 0x0002,

    DVLNODEINFO_UNIQUEID                            = 0x0004,

    DVLNODEINFO_PARENTS                             = 0x0008,

    DVLNODEINFO_CHILDREN                            = 0x0010,

    DVLNODEINFO_FLAGS                               = 0x0020,

    DVLNODEINFO_OPACITY                             = 0x0040,

    DVLNODEINFO_HIGHLIGHT_COLOR                     = 0x0080,

    DVLNODEINFO_URI                                 = 0x0100,

    DVLNODEINFO_INFO                                = 0x0200,
};



#pragma pack(push, 1)
struct sDVLURI
{
    char *m_szDestination;
    char *m_szTitle;
    char *m_szBehavior;
};
#pragma pack(pop)



#pragma pack(push, 1)
struct sDVLNodeInfo
{
    uint16_t m_uSizeOfDVLNodeInfo;

    char *m_szNodeName;

    char *m_szNodeInfo;

    char *m_szAssetID;

    char *m_szUniqueID;

    uint32_t m_uParentNodesCount;

    DVLID *m_pParentNodes;

    uint32_t m_uChildNodesCount;

    DVLID *m_pChildNodes;

    uint32_t m_uFlags;

    float m_fOpacity;

    uint32_t m_uHighlightColor;
    
    uint32_t m_uURIsCount;

    sDVLURI *m_pURIs;
};
#pragma pack(pop)



#pragma pack(push, 1)
struct sDVLLayerInfo
{
    uint16_t m_uSizeOfDVLLayerInfo;

    char *m_szName;

    char *m_szInfo;

    uint32_t m_uNodesCount;

    DVLID *m_pNodes;

    bool m_bIsHotspotLayer;
};
#pragma pack(pop)



#pragma pack(push, 1)
struct sDVLMetadataNamespace
{
    char *m_szName;

    sDVLMetadata *m_pMetadata;
};

struct sDVLMetadataNameValuePair
{
    char *m_szName;

    char *m_szValue;
};

struct sDVLMetadata
{
    uint32_t m_uNamespacesCount;

    sDVLMetadataNamespace *m_pNamespaces;

    uint32_t m_uNameValuePairsCount;

    sDVLMetadataNameValuePair *m_pNameValuePairs;
};

struct sDVLMetadataInfo
{
    uint16_t m_uSizeOfDVLMetadataInfo;

    void *pimpl;

    sDVLMetadata *m_pMetadata;
};

struct sDVLVEIDNameValuePair
{
    char *m_szName;

    char *m_szValue;
};

struct sDVLVEID
{
    char *m_szSource;

    char *m_szType;

    uint32_t m_uNameValuePairsCount;

    sDVLVEIDNameValuePair *m_pNameValuePairs;
};

struct sDVLVEIDInfo
{
    uint16_t m_uSizeOfDVLVEIDInfo;

    void *pimpl;

    sDVLVEID *m_pIDs;

    uint32_t m_uIDCount;
};
#pragma pack(pop)



#define DVLPARTSLIST_RECOMMENDED_uMaxParts                  1000

#define DVLPARTSLIST_RECOMMENDED_uMaxNodesInSinglePart      1000

#define DVLPARTSLIST_RECOMMENDED_uMaxPartNameLength         200

#define DVLPARTSLIST_UNLIMITED_uMaxParts                    0

#define DVLPARTSLIST_UNLIMITED_uMaxNodesInSinglePart        0

#define DVLPARTSLIST_UNLIMITED_uMaxPartNameLength           0

enum eDVLPartsListType
{
    DVLPARTSLISTTYPE_ALL = 0,

    DVLPARTSLISTTYPE_VISIBLE = 1,

    DVLPARTSLISTTYPE_CONSUMED_BY_STEP = 2,
};

enum eDVLPartsListSort
{
    DVLPARTSLISTSORT_NAME_ASCENDING = 0,

    DVLPARTSLISTSORT_NAME_DESCENDING = 1,

    DVLPARTSLISTSORT_COUNT_ASCENDING = 2,

    DVLPARTSLISTSORT_COUNT_DESCENDING = 3,
};

#pragma pack(push, 1)
struct sDVLPartsListItem
{
    char *m_szName;

    uint32_t m_uNodesCount;

    DVLID *m_pNodes;
};
#pragma pack(pop)

#pragma pack(push, 1)
struct sDVLPartsListInfo
{
    uint16_t m_uSizeOfDVLPartsListInfo;

    void *pimpl;

    uint32_t m_uPartsCount;

    sDVLPartsListItem *m_pParts;
};
#pragma pack(pop)



#pragma pack(push, 1)
struct sDVLStep
{
    DVLID m_ID;

    char *m_szName;

    char *m_szDescription;

    char *m_szKeywords;
};

struct sDVLProcedure
{
    DVLID m_ID;

    char *m_szName;

    uint32_t m_uStepsCount;

    sDVLStep *m_pSteps;
};

struct sDVLProceduresInfo
{
    uint16_t m_uSizeOfDVLProceduresInfo;

    void *pimpl;

    uint32_t m_uProceduresCount;

    sDVLProcedure *m_pProcedures;

    uint32_t m_uPortfoliosCount;

    sDVLProcedure *m_pPortfolios;
};
#pragma pack(pop)



enum eDVLFindNodeType
{
    DVLFINDNODETYPE_NODE_NAME = 0,

    DVLFINDNODETYPE_ASSET_ID = 1,

    DVLFINDNODETYPE_UNIQUE_ID = 2,

    DVLFINDNODETYPE_DSSELECTOR_ID = 3,
};

enum eDVLFindNodeMode
{
    DVLFINDNODEMODE_EQUAL = 0,

    DVLFINDNODEMODE_EQUAL_CASE_INSENSITIVE = 1,

    DVLFINDNODEMODE_SUBSTRING = 2,

    DVLFINDNODEMODE_SUBSTRING_CASE_INSENSITIVE = 3,

    DVLFINDNODEMODE_STARTS_WITH = 4,

    DVLFINDNODEMODE_STARTS_WITH_CASE_INSENSITIVE = 5,
};

#pragma pack(push, 1)
struct sDVLNodeIDsArrayInfo
{
    uint16_t m_uSizeOfDVLFindNodesList;

    uint32_t m_uNodesCount;

    DVLID *m_pNodes;
};
#pragma pack(pop)



class IDVLScene
{
protected:
    virtual ~IDVLScene() {}//can't be deleted using this interface, use Release()

public:
    virtual DVLRESULT RetrieveSceneInfo(uint32_t flags, sDVLSceneInfo *pInfo) = 0;

    virtual void ReleaseSceneInfo(sDVLSceneInfo *pInfo) = 0;

    virtual void GetNodeSelectionInfo(uint32_t *pTotalSelectedNodesCount, uint32_t *pVisibleSelectedNodesCount, uint32_t *pHiddenSelectedNodesCount) = 0;

    virtual void PerformAction(DVLSCENEACTION action) = 0;

    virtual DVLRESULT RetrieveNodeInfo(DVLID id, uint32_t flags, sDVLNodeInfo *pInfo) = 0;

    virtual void ReleaseNodeInfo(sDVLNodeInfo *pInfo) = 0;



    virtual DVLRESULT RetrieveLayerInfo(DVLID id, sDVLLayerInfo *pInfo) = 0;

    virtual void ReleaseLayerInfo(sDVLLayerInfo *pInfo) = 0;



    virtual DVLRESULT RetrieveMetadata(DVLID id, sDVLMetadataInfo *pInfo) = 0;

    virtual void ReleaseMetadata(sDVLMetadataInfo *pInfo) = 0;



    virtual DVLRESULT RetrieveVEIDs(DVLID id, sDVLVEIDInfo *pInfo) = 0;

    virtual void ReleaseVEIDs(sDVLVEIDInfo *pInfo) = 0;



    virtual DVLRESULT RetrieveThumbnail(DVLID id, sDVLImage *pThumbnail) = 0;

    virtual void ReleaseThumbnail(sDVLImage *pThumbnail) = 0;



    virtual DVLRESULT BuildPartsList(uint32_t uMaxParts, uint32_t uMaxNodesInSinglePart, uint32_t uMaxPartNameLength,
        eDVLPartsListType eType, eDVLPartsListSort eSort, DVLID idConsumedStep, const char *szSubstring, sDVLPartsListInfo *pInfo) = 0;

    virtual void ReleasePartsList(sDVLPartsListInfo *pInfo) = 0;



    virtual DVLRESULT FindNodes(eDVLFindNodeType type, eDVLFindNodeMode mode, const char *str, sDVLNodeIDsArrayInfo *pInfo) = 0;

    virtual void ReleaseNodeIDsArrayInfo(sDVLNodeIDsArrayInfo *pInfo) = 0;



    virtual DVLRESULT RetrieveProcedures(sDVLProceduresInfo *pInfo) = 0;

    virtual void ReleaseProcedures(sDVLProceduresInfo *pInfo) = 0;



    virtual DVLRESULT ActivateStep(DVLID id, bool bFromTheBeginning, bool bContinueToTheNext, float stepTime = -1.f) = 0;

    virtual DVLRESULT PauseCurrentStep() = 0;



    virtual DVLRESULT ApplyLayerVisibility(DVLID id, DVLLAYERVISIBILITYACTION action = DVLLAYERVISIBILITYACTION_HIDEALL_SHOWLAYER) = 0;



    virtual DVLID CreateNode(DVLID idParent, const char *szNodeName = NULL, DVLID idInsertBefore = DVLID_INVALID) = 0;



    enum eCreateNodeCopyFlags : uint16_t
    {
        COPY_CHILDREN           = (1 << 0),
        COPY_ANIMATION          = (1 << 1),
        FULL_COPY               = 0xFFFF,
    };

    virtual DVLID CreateNodeCopy(DVLID idNode, DVLID idParent, eCreateNodeCopyFlags flags) = 0;



    virtual DVLRESULT DeleteNode(DVLID id) = 0;



    virtual DVLRESULT ChangeNodeFlags(DVLID id, uint32_t flags, DVLFLAGOPERATION flagop) = 0;



    virtual DVLRESULT SetNodeOpacity(DVLID id, float opacity) = 0;

    virtual DVLRESULT SetNodeHighlightColor(DVLID id, uint32_t color) = 0;



    virtual DVLRESULT GetNodeWorldMatrix(DVLID id, sDVLMatrix &wtm) const = 0;

    virtual DVLRESULT SetNodeWorldMatrix(DVLID id, const sDVLMatrix *pwtm) = 0;



    virtual DVLRESULT GetNodeLocalMatrix(DVLID id, sDVLMatrix &tm) const = 0;

    virtual DVLRESULT SetNodeLocalMatrix(DVLID id, const sDVLMatrix *ptm) = 0;
    
    
    
    virtual IDVLMaterial *GetMaterialByName(const char *name) const = 0;

    virtual size_t GetNodeSubmeshesCount(DVLID nodeId) const = 0;

    virtual IDVLMaterial *GetNodeSubmeshMaterial(DVLID nodeId, size_t index) const = 0;

    virtual DVLRESULT SetNodeSubmeshMaterial(DVLID nodeId, size_t index, IDVLMaterial *material) = 0;



    virtual DVLRESULT Execute(DVLEXECUTE type, const char *str) = 0;



    virtual void Retain() = 0;

    virtual void Release() = 0;
};