/////////////////////////////////////////////////////////////////////////////// 
// 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 _NW_PLOTIMAGEHEADER_H_
#define _NW_PLOTIMAGEHEADER_H_
#include "NwObject.h"
#include "NwImageFormat.h"

/** \details
  This class represents geometry.

  <group OdNw_Classes>
*/
class NWDBEXPORT OdNwPlotImageHeader : public OdNwObject
{
  ODRX_DECLARE_MEMBERS(OdNwPlotImageHeader);

  /** \details
    Default constructor. Creates an OdNwPlotImageHeader object.
  */
  OdNwPlotImageHeader();

public:
  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwPlotImageHeader();

public:
  /** \details
   Returns padded row size of image.

   \returns OdUInt32 value of padded row size.
 */
  OdUInt32 getPaddedRowSize(const OdNwImageFormat::Enum format) const;
  /** \details
   Returns non-padded row size of image.

   \returns OdUInt32 value of non-padded row size.
 */
  OdUInt32 getNonPaddedRowSize(const OdNwImageFormat::Enum format) const;
  /** \details
   Returns pixel size in bytes.

   \returns OdUInt32 bytes per pixel value.
 */
  OdUInt32 getPixelBytes(const OdNwImageFormat::Enum format) const;
  /** \details
   Returns image format.

   \returns Image format as OdNwImageFormat enumeration.
 */
  OdNwImageFormat::Enum getImageFormat() const;
  /** \details
   Returns image height in pixels.

   \returns OdUInt32 value of height.
 */
  OdUInt32 getHeight() const;
  /** \details
   Returns image width in pixels.

   \returns OdUInt32 value of width.
 */
  OdUInt32 getWidth() const;
};

/** \details
  This template class is a specialization of the OdSmartPtr class for OdNwPlotImageHeader object pointers.
*/
typedef OdSmartPtr<OdNwPlotImageHeader> OdNwPlotImageHeaderPtr;

#endif // _NW_PLOTIMAGEHEADER_H_