/////////////////////////////////////////////////////////////////////////////// 
// 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_PLOTIMAGEBRUSH_H_
#define _NW_PLOTIMAGEBRUSH_H_
#include "NwPlotBrush.h"
#include "NwPlotEnums.h"
#include "Ge/GeMatrix2d.h"
#include "OdBinaryData.h"

class OdNwPlotImageHeader;
typedef OdSmartPtr<OdNwPlotImageHeader> OdNwPlotImageHeaderPtr;
/** \details
  This class represents geometry.

  <group OdNw_Classes>
*/
class NWDBEXPORT OdNwPlotImageBrush : public OdNwPlotBrush
{
  ODRX_DECLARE_MEMBERS(OdNwPlotImageBrush);

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

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

public:
  /** \details
    Receives the transformation matrix for the image brush.

    \returns OdGeMatrix2d object with the transformation matrix.
  */
  OdGeMatrix2d getTransform() const;
  /** \details
    Gets the opacity factor for the plot image brush.

    \returns Radius as a double value.
  */
  double getOpacityFactor() const;
  /** \details
    Gets the origin for view source by X axe.

    \returns Radius origin for view source as an OdInt32 value.
  */
  OdInt32 getViewSourceOriginX() const;
  /** \details
    Gets the origin for view source by Y axe.

    \returns Radius origin for view source as an OdInt32 value.
  */
  OdInt32 getViewSourceOriginY() const;
  /** \details
    Gets the size of view source by X axe.

    \returns Radius size of view source as an OdInt32 value.
  */
  OdInt32 getViewSourceSizeX() const;
  /** \details
    Gets the size of view source by Y axe.

    \returns Radius size of view source as an OdInt32 value.
  */
  OdInt32 getViewSourceSizeY() const;
  /** \details
    Gets the origin for view destination by X axe.

    \returns Radius origin for view destination as a double value.
  */
  double getViewDestinationOriginX() const;
  /** \details
    Gets the origin for view destination by Y axe.

    \returns Radius origin for view destination as a double value.
  */
  double getViewDestinationOriginY() const;
  /** \details
    Gets the size of view destination by X axe.

    \returns Radius size of view destination as a double value.
  */
  double getViewDestinationSizeX() const;
  /** \details
    Gets the size of view destination by Y axe.

    \returns Radius size of view destination as a double value.
  */
  double getViewDestinationSizeY() const;
  /** \details
    Returns the tile mode for the image brush.

    \returns One of the enumerated items from the NwPlotBrushTileMode::Enum enumerated type.
  */
  NwPlotBrushTileMode::Enum getTileMode() const;
  /** \details
    Returns the tile offset for the image brush.

    \returns Radius tile offset as a double value.
  */
  double getTileOffset() const;
  /** \details
    An image header for the image brush.

    \returns Smart pointer for an OdNwPlotImageHeader object.
  */
  OdNwPlotImageHeaderPtr getImageHeader() const;
  /** \details
    An image data for the image brush.

    \returns Binary buffer object with an OdBinaryData object type.
  */
  OdBinaryData getImageData() const;

  /** \details
    A temporary file buffer for the image brush.

    \returns Binary buffer object with an OdBinaryData object type.
  */
  OdBinaryData getTempFileBuffer() const;
};

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

#endif // _NW_PLOTIMAGEBRUSH_H_