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


///////////////////////////////////////////////////////////////////////////////
//
// PdfPublishInkAnnotation.h
//
///////////////////////////////////////////////////////////////////////////////

#ifndef _PDF_PUBLISH_INK_ANNOTATION_INCLUDED_
#define _PDF_PUBLISH_INK_ANNOTATION_INCLUDED_

#include "PdfPublishMarkupAnnotation.h"
#include "Ge/GePoint2dArray.h"
#include "OdArray.h"
#include "PdfPublishAnnotationBorderStyle.h"

/** \details
  Contains declarations for Publish SDK.
  <group OdPdfPublish_Classes>
*/
namespace OdPdfPublish {

/** \details
  This class implements an ink annotation in a .pdf document created with Publish SDK.
  Ink annotations represent freehand "scribbles" made up of one or more strokes.
*/
class PDFPUBLISH_TOOLKIT OdInkAnnotation : public OdMarkupAnnotation
{
  //DOM-IGNORE-BEGIN
protected:
  OdInkAnnotation();
  //DOM-IGNORE-END
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdInkAnnotation);
  ODRX_HEAP_OPERATORS();
  //DOM-IGNORE-END

  /** \details
    Destroys the ink annotation.
  */
  virtual ~OdInkAnnotation();

  /** \details
    Sets a list of strokes for the ink annotation.
    \param ink_list [in] An array of point arrays. Each point array represents a single stroke.
    \remarks
    This method overwrites any previously existing strokes.
  */
  void setInkList(const OdArray<OdGePoint2dArray>& ink_list);

  /** \details
    Adds a single stroke to the ink annotation's list of strokes.
    \param stroke [in] An array of 2D points that defines the stroke to be added.
  */
  void addStroke(const OdGePoint2dArray& stroke);

  /** \details
    Sets the border style for the ink annotation.
    \param style [in] A smart pointer to an annotation border style object.
  */
  void setLineStyle(const OdAnnotationBorderStylePtr& style);

  /** \details
    Gets the list of strokes for the ink annotation.
    \param ink_list [out] A placeholder for the list of strokes. Each returned point array represents a single stroke.
  */
  void getInkList(OdArray<OdGePoint2dArray>& ink_list) const;

  /** \details
    Gets the border style for the ink annotation.
    \param style [out] A placeholder for the annotation border style.
  */
  void getLineStyle(OdAnnotationBorderStylePtr& style) const;
};

/** \details
  A data type that represents a smart pointer to an <link OdPdfPublish::OdInkAnnotation, OdInkAnnotation> object.
*/
SMARTPTR(OdInkAnnotation);

} // namespace OdPdfPublish

#endif // _PDF_PUBLISH_INK_ANNOTATION_INCLUDED_