GiTransientManager.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 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 __ODGITRANSIENTMANAGER_H__
#define __ODGITRANSIENTMANAGER_H__
 
#include <RxObject.h>
#include <Gi/GiExport.h>
#include <UInt32Array.h>
 
#include "TD_PackPush.h"
 
class OdGiDrawable;
 
class ODGI_EXPORT OdGiTransientManager : public OdRxObject
{
  public:
    ODRX_DECLARE_MEMBERS(OdGiTransientManager);
 
    enum OdGiTransientDrawingMode
    {
      kOdGiMain = 0,
      kOdGiSprite,
      kOdGiDirectShortTerm,
      kOdGiHighlight,
      kOdGiDirectTopmost,
      kOdGiContrast,
      kOdGiDrawingModeCount
    };
 
    virtual bool addTransient(OdGiDrawable *pDrawable,
                              OdGiTransientDrawingMode mode,
                              OdInt32 subMode,
                              const OdUInt32Array &viewportIds) = 0;
 
    virtual bool eraseTransient(OdGiDrawable *pDrawable,
                                const OdUInt32Array &viewportIds) = 0;
 
    virtual bool eraseTransients(OdGiTransientDrawingMode mode,
                                 OdInt32 subMode,
                                 const OdUInt32Array &viewportIds) = 0;
 
    virtual void updateTransient(OdGiDrawable *pDrawable,
                                 const OdUInt32Array &viewportIds) const = 0;
 
    virtual bool addChildTransient(OdGiDrawable *pDrawable, OdGiDrawable *pParent) = 0;
 
    virtual bool eraseChildTransient(OdGiDrawable *pDrawable, OdGiDrawable *pParent) = 0;
 
    virtual void updateChildTransient(OdGiDrawable *pDrawable, OdGiDrawable *pParent) const = 0;
 
    virtual OdInt32 getFreeSubDrawingMode(OdGiTransientDrawingMode mode,
                                          OdInt32 &subMode,
                                          const OdUInt32Array &viewportIds) const = 0;
};
 
typedef OdSmartPtr<OdGiTransientManager> OdGiTransientManagerPtr;
 
ODGI_EXPORT OdGiTransientManager *odgiGetTransientManager(const OdRxObject *pObject);
ODGI_EXPORT void odgiSetTransientManager(OdGiTransientManager *pManager, OdRxObject *pObject);
 
class ODGI_EXPORT OdGiTransientManagerPE : public OdRxObject
{
  public:
    ODRX_DECLARE_MEMBERS(OdGiTransientManagerPE);
 
    virtual OdGiTransientManager *transientManager(const OdRxObject *pThis) const = 0;
    virtual void setTransientManager(OdRxObject *pThis, OdGiTransientManager *pManager) = 0;
};
 
typedef OdSmartPtr<OdGiTransientManagerPE> OdGiTransientManagerPEPtr;
 
#include "TD_PackPop.h"
 
#endif  // __ODGITRANSIENTMANAGER_H__