/////////////////////////////////////////////////////////////////////////////// 
// 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 OD_GE_ENTITY_2D_H
#define OD_GE_ENTITY_2D_H /*!DOM*/

class OdGeMatrix2d;
class OdGeLine2d;
class OdGeEntity2dImpl;

#include "Ge/GePoint2d.h"
#include "OdHeap.h"

#include "TD_PackPush.h"

/** \details
    This class is the base class for all OdGe 2D geometric operations.

    Corresponding C++ library: TD_Ge

    <group OdGe_Classes> 
*/
class GE_TOOLKIT_EXPORT OdGeEntity2d
{
public:
//DOM-IGNORE-BEGIN
  ODRX_HEAP_OPERATORS();
//DOM-IGNORE-END
  
  /** \details
    Destructor for the OdGeEntity2d class.
  */
  ~OdGeEntity2d();
  
  /** \details
    Returns true if and only if this entity is of  type (or is derived from) entType.

    \param entType [in]  Entity type to test. 
  */
  bool isKindOf(
    OdGe::EntityId entType) const;

  /** \details
    Returns the entity type of this entity.
  */
  OdGe::EntityId type() const;

  /** \details
    Returns a copy of this entity.

    \remarks
    The returned object is created with the new operator, and it is the responsibility of the caller to delete it.
  */
  OdGeEntity2d* copy() const;

  /** \details
    Assignment operator for the OdGeEntity2d object.

    \param entity [in]  Entity to assign.
    
    \returns
    A reference to this OdGeEntity2d object.
  */
  OdGeEntity2d& operator =(
    const OdGeEntity2d& entity);

  /** \details
    Comparison operator for the OdGeEntity2d object.

    \param entity [in]  Other entity to compare.
    
    \returns
    A boolean value that indicates whether the input entity is identical to this entity.
  */
  bool operator ==(
    const OdGeEntity2d& entity) const;

  /** \details
    Comparison operator for the OdGeEntity2d object.

    \param entity [in]  Other entity to compare.
    
    \returns
    A boolean value that indicates whether the input entity is not identical to this entity.
  */
  bool operator !=(
    const OdGeEntity2d& entity) const;

  /** \details
    Returns true if the specified entity is equal to this one.

    \param other [in]  Entity to be compared
    \param tol [in]  Geometric tolerance.
    
    \returns
    true if and only if both entities are of the same type, have the same point set within the 
    specified tolerance, and have the same parameterization.
  */
  bool isEqualTo(
    const OdGeEntity2d& other, 
    const OdGeTol& tol = OdGeContext::gTol) const;

  /** \details
    Applies the 2D transformation matrix to this entity, and returns
    a reference to this entity.

    \param xfm [in]  2D transformation matrix.
  */
  OdGeEntity2d& transformBy(
    const OdGeMatrix2d& xfm);

  /** \details
    Applies the 2D translation vector to this entity, and returns
    a reference to this entity.

    \param translateVec [in]  Translation Vector.
  */
  OdGeEntity2d& translateBy(
    const OdGeVector2d& translateVec);

  /** \details
    Rotates this entity about the specified point by the specified angle, and returns
    a reference to this entity.

    \param angle [in]  Rotation angle.
    \param basePoint [in]  Basepoint.
  */
  OdGeEntity2d& rotateBy(
    double angle, 
    const OdGePoint2d& basePoint = OdGePoint2d::kOrigin);

  /** \details
    Mirrors this entity about the specified 2D line, and returns
    a reference to this entity.

    \param line [in]  Mirror Line.
  */
  OdGeEntity2d& mirror(
    const OdGeLine2d& line);

  /** \details
    Scales this entity by the scale factor about the basepoint, and returns
    a reference to this entity.

    \param scaleFactor [in]  Scale Factor. The scale factor must be greater than zero.
    \param basePoint [in]  Basepoint.
  */
  OdGeEntity2d& scaleBy(
    double scaleFactor, 
    const OdGePoint2d& basePoint = OdGePoint2d::kOrigin);

  /** \details
    Returns true if and only if the specified point is on this entity, as determined by the tolerance.

    \param point [in]  Point to be queried.
    \param tol [in]  Geometric tolerance.
  */
  bool isOn(
    const OdGePoint2d& point, 
    const OdGeTol& tol = OdGeContext::gTol) const;

//DOM-IGNORE-BEGIN
protected:
  OdGeEntity2d();
  OdGeEntity2d(const OdGeEntity2d&);
  void connectTo(OdGeEntity2dImpl*);

private:
  OdGeEntity2d(OdGeEntity2dImpl*);
  OdGeEntity2dImpl* m_pImpl;
  friend class OdGeEntity2dImpl;
//DOM-IGNORE-BEGIN
};

#define GE_OPERATORS_OVERRIDE_2D(CLASS)\
CLASS* copy() const;\
CLASS& transformBy(const OdGeMatrix2d& xfm); \
CLASS& translateBy(const OdGeVector2d& translateVec);\
CLASS& rotateBy(double angle, const OdGePoint2d& basePoint = OdGePoint2d::kOrigin);\
CLASS& mirror(const OdGeLine2d& line);\
CLASS& scaleBy(double scaleFactor, const OdGePoint2d& basePoint = OdGePoint2d::kOrigin);

#include "TD_PackPop.h"

#endif // OD_GE_ENTITY_2D_H