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


///////////////////////////////////////////////////////////////////////////////
//
// PdfPublishAnnotationBorderEffect.h
//
///////////////////////////////////////////////////////////////////////////////

#ifndef _PDF_PUBLISH_ANNOTATION_BE_INCLUDED_
#define _PDF_PUBLISH_ANNOTATION_BE_INCLUDED_

#include "PdfPublishBaseObject.h"
#include "DoubleArray.h"

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

/** \details
  A class that implements an annotation border effect in .pdf documents created with PDF Publish SDK.

  Border effects allow a visual effect (e.g., "cloudy") to be applied to the border of an annotation.
*/
class PDFPUBLISH_TOOLKIT OdAnnotationBorderEffect : public OdObject
{
  //DOM-IGNORE-BEGIN
protected:
  OdAnnotationBorderEffect();
  //DOM-IGNORE-END
public:
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdAnnotationBorderEffect);
  ODRX_HEAP_OPERATORS();
  //DOM-IGNORE-END

  /** \details
    Destroys the border effect annotation object.
  */
  virtual ~OdAnnotationBorderEffect();

  /** \details
    Sets the border effect style.
    \param effect [in] A border effect type (e.g., kNoEffect or kCloudy).
  */
  void setEffect(const Border::Effect effect);

  /** \details
    Sets the border effect intensity.
    \param intensity [in] A numeric value from 0.0 to 2.0 that defines the intensity of the effect.
    \remarks
    Throws an exception if the value is out of range.
  */
  void setIntensity(double intensity);

  /** \details
    Returns the current border effect style.
    \param effect [out] A placeholder for the border effect type.
  */
  void getEffect(Border::Effect& effect) const;

  /** \details
    Returns the current border effect intensity.
    \param intensity [out] A placeholder for the intensity value.
  */
  void getIntensity(double& intensity) const;
};

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

}
#endif // _PDF_PUBLISH_ANNOTATION_BE_INCLUDED_