/////////////////////////////////////////////////////////////////////////////// 
// 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_PLOTPAPERSTYLE_H_
#define _NW_PLOTPAPERSTYLE_H_
#include "NwObject.h"
#include "NwColor.h"
#include "NwModelUnits.h"
#include "Ge/GePoint2d.h"
#include "Ge/GeMatrix2d.h"

/** \details
  This class represents geometry.

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

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

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

public:

  /** \details
    Indicates whether the paper is visible.

    \returns The true value if the paper is visible, otherwise false.
  */
  bool isVisible() const;

  /** \details
    Receives the paper's color.

    \returns OdNwColor object with the paper color.
  */
  OdNwColor getColor() const;

  /** \details
    Receives the unit for the paper style.

    \returns The unit type as one of the enumerated items from the NwModelUnits::Enum enumerated type.
  */
  NwModelUnits::Enum getUnits() const;

  /** \details
    Receives the size of the paper.

    \returns OdGePoint2d object with the paper type.
  */
  OdGePoint2d getSize() const;

  /** \details
    Gets the paper clip bounds.

    \param min           [out] OdGePoint2d object with the minimum point.
    \param max           [out] OdGePoint2d object with the maximum point.

    \returns The eOk value if the operation is successful, or an appropriate error code
    otherwise.
  */
  OdResult getClip(OdGePoint2d& min, OdGePoint2d& max) const;

  /** \details
    Receives the transformation matrix for the paper.

    \returns OdGeMatrix2d object with the transformation matrix.
  */
  OdGeMatrix2d getTransform() const;
};

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

#endif // _NW_PLOTPAPERSTYLE_H_