GsUpdateManager.h

Go to the documentation of this file.

// Copyright (C) 2002-2017, 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 Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2017 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef __ODGSUPDATEMANAGER_H__
#define __ODGSUPDATEMANAGER_H__
 
class OdDbStub;
class OdGsEntityNode;
class OdRxObject;
class OdGsViewImpl;
 
#include "Gs/GsExport.h"
#include "Ge/GeExtents3d.h"
 
#include "TD_PackPush.h"
 
class GS_TOOLKIT_EXPORT OdGsUpdateManager : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdGsUpdateManager);
 
  enum FiltrationType
  {
    kKeepDrawOrder = 0, //Keep draw order
    kFilterByLimit = (1 << 0) //Filtration by memory limit (CLOUD)
  };
 
  enum Action
  {
    kAdd,
    kRemove,
    kNoChanges
  };
 
  class GS_TOOLKIT_EXPORT OdGsUpdateManagerElement
  {
  protected:
    OdUInt8 m_stateFlags;
  public:
    OdGsUpdateManagerElement() : m_stateFlags( 0 ){ };
    OdUInt8 state() const { return m_stateFlags; }
    void setState( OdUInt8 state ) { m_stateFlags = state; }
  };
 
  typedef void (*UpdateManagerProcessCallback)( Action action, OdUInt32 viewportId, OdDbStub* drawableId, OdGsEntityNode* pNode, OdGsUpdateManagerElement* pElement );
 
  struct UpdateManagerSettings
  {
    FiltrationType type;
    OdUInt64 nMemoryLimit;
    OdUInt64 nMinMemoryLimit;
    OdUInt64 nClientCurrentHeapUsage;
  };
 
public:
  virtual UpdateManagerSettings settings() const = 0;
 
  virtual void setSettings( const UpdateManagerSettings& ) = 0;
 
  virtual void addElement( OdUInt32 viewportId, OdGsEntityNode* pNode, OdGsUpdateManagerElement* pElement ) = 0;
 
  virtual void addElement( OdUInt32 viewportId, OdGsEntityNode* pNode, OdGsUpdateManagerElement* pElement, OdUInt64 nLength, OdGsViewImpl* pView, const OdGeExtents3d& extents, bool bSetZeroWeight = false ) = 0;
 
  virtual void setProcessCallback( UpdateManagerProcessCallback ) = 0;
 
  virtual void process() = 0;
 
  virtual void reset() = 0;
 
  virtual void removeElement( OdUInt32 viewportId, OdGsEntityNode* pNode, OdGsUpdateManagerElement* pElement ) = 0;
};
 
#include "TD_PackPop.h"
 
#endif // __ODGSUPDATEMANAGER_H__