/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////
// Local resource sharing provider

#ifndef ODVECLOCALSHARINGPROVIDER
#define ODVECLOCALSHARINGPROVIDER

#include "TD_PackPush.h"

#include "TrVecResourceSharingProvider.h"
#include "TrRndRenderModule.h"

class OdTrRndLocalRenditionHost;

/** \details
    <group Tr_Vectorization_Classes> 
*/
class OdTrVecLocalSharingProvider : public OdTrVecResourceSharingProvider
{
  protected:
    OdTrRndRenderModulePtr m_pRenderModule;
  public:
    /** \details
      Default constructor for the OdTrVecLocalSharingProvider class.
    */
    OdTrVecLocalSharingProvider();
    
    /** \details
      Destructor for the OdTrVecLocalSharingProvider class.
    */
    ~OdTrVecLocalSharingProvider() override;

    /** \details
      Shares metafile with secondary device.
      
      \param pRequestedFor      [in]  Pointer to a device for which to request metafile.
      \param pRequestedFrom     [in]  Pointer to a device from which to request metafile.
      \param metafileId         [in]  Metafile identifier.
      \returns
      true.
      \remarks
      Should be overridden by client, by default does nothing.
    */
    bool shareMetafile(OdTrVecDevice *pRequestedFor, OdTrVecDevice *pRequestedFrom,
                       OdTrVisMetafileId metafileId, void *pInternalDataPtr, void *pOriginatorPtr) override;
    /** \details
      Shares metafile group with secondary device.
      
      \param pRequestedFor      [in]  Pointer to a device for which to request a metafile group.
      \param pRequestedFrom     [in]  Pointer to a device from which to request a metafile group.
      \param groupId            [in]  Group identifier.
      \returns
      true.
      \remarks
      Should be overridden by client, by default does nothing.
    */
    bool shareGroup(OdTrVecDevice *pRequestedFor, OdTrVecDevice *pRequestedFrom,
                    OdTrVisGroupId groupId, void *pInternalDataPtr, void *pOriginatorPtr) override;
    
    /** \details
      Shares texture with secondary device.
      
      \param pRequestedFor      [in]  Pointer to a device for which to request a texture.
      \param pRequestedFrom     [in]  Pointer to a device from which to request a texture.
      \param textureId          [in]  Texture identifier.
      \returns
      true if successful, false otherwise.
      \remarks
      Should be overridden by client, by default does nothing.
    */
    bool shareTexture(OdTrVecDevice *pRequestedFor, OdTrVecDevice *pRequestedFrom,
                      OdTrVisTextureId textureId, void *pInternalDataPtr, void *pOriginatorPtr) override;
    /** \details
      Shares material with secondary device.
      
      \param pRequestedFor      [in]  Pointer to a device for which to request a material.
      \param pRequestedFrom     [in]  Pointer to a device from which to request a material.
      \param materialId         [in]  Material identifier.
      \returns
      true.
      \remarks
      Should be overridden by client, by default does nothing.
    */
    bool shareMaterial(OdTrVecDevice *pRequestedFor, OdTrVecDevice *pRequestedFrom,
                       OdTrVisMaterialId materialId, void *pInternalDataPtr, void *pOriginatorPtr) override;

    static OdTrVecResourceSharingProviderPtr createObject(OdTrRndRenderModule *pRenderModule);
  protected:
    OdTrRndLocalRenditionHost *renditionHost(OdTrVecDevice *pRequestFor);
};

#include "TD_PackPop.h"

#endif // ODVECLOCALSHARINGPROVIDER