///////////////////////////////////////////////////////////////////////////////
// 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.
///////////////////////////////////////////////////////////////////////////////

#ifndef TESTRENDER_H_
#define TESTRENDER_H_

#include "TvDatabase.h"
#include "TvGsDevice.h"
#include "TvInsert.h"

// Structure for additional parameters saving
struct TVDevicePropertiesHolder
{
public:
  bool m_bBlocksCache;

  TVDevicePropertiesHolder() : m_bBlocksCache(false) {};
  TVDevicePropertiesHolder(bool bBlocksCache) : m_bBlocksCache(bBlocksCache) {};
};

class TvBaseTestRender
{
protected:
  OdTvGsDeviceId m_deviceId;
  OdTvDatabaseId m_databaseId;

  TVDevicePropertiesHolder m_devicePropertiesHolder;

public:

  TvBaseTestRender(TVDevicePropertiesHolder devicePropertiesHolder = TVDevicePropertiesHolder());

  // Initialize graphic device
  virtual void initializeDevice(const OdString& bmpDeviceName = OdString());

  // Setup render parameters
  virtual void setupRenderParam(ODCOLORREF bgColor = ODRGB(255, 255, 255));

  // Setup render palette
  virtual void setupPalette(ODCOLORREF bgColor);

  // Set output image dimensions
  virtual void setupOutputDims(long x, long y);

  // Combination of inititlizeDevice and setupRenderParam
  virtual void setupDevice(OdTvGsDevice::Name name, ODCOLORREF bgColor);

  // Combination of inititlizeDevice and copy render param from db device
  virtual void setupDeviceFromDb(OdTvGsDevice::Name name, const OdString&  dbDeviceName = OdString(), const OdString& bmpDeviceName = OdString());

  // Combination of initializeDevice, setupRenderParam and setupOutputDims
  virtual void prepareDevice(OdTvGsDevice::Name name, long x, long y, const OdString&  dbDeviceName = OdString(), const OdString& bmpDeviceName = OdString(), ODCOLORREF bgColor = ODRGB(255, 255, 255));

  // Zoom to extents
  virtual void zoomToExtents(bool bUseActiveView = false);
  virtual void zoomToExtents(OdTvGsViewId viewId);

  // Render
  virtual void render(bool bInvalidate = false);

  // Set database
  void setDatabase(OdTvDatabaseId databaseId);

  // Get entity ant it's model by handle
  OdTvEntityId getEntityByHandle(OdUInt64 h, OdTvModelId* pTvModelId = NULL);
};

#endif // TESTRENDER_H_