///////////////////////////////////////////////////////////////////////////////
// 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 _PRCUNIQUEVERTEX_INCLUDED_
#define _PRCUNIQUEVERTEX_INCLUDED_ 
 

#include "PrcTopoItem.h"
#include "PrcBaseTopology.h"

/** \details 
A class that stores and handles unique vertex data. 
A vertex position is specified with a tolerance and a 3D absolute position.
<group PRC_Topology_Classes> 
*/
class PRC_TOOLKIT OdPrcUniqueVertex : public OdPrcTopoItem
{
public:
  ODPRC_DECLARE_MEMBERS_TOPO(OdPrcUniqueVertex)

  /** \details
  Requests the current 3D point that specifies the vertex position.
  \returns An <exref target="https://docs.opendesign.com/tkernel/OdGePoint3d.html">OdGePoint3d</exref> object that represents the vertex position.
  \remarks
  The 3D point is returned as a reference to an <exref target="https://docs.opendesign.com/tkernel/OdGePoint3d.html">OdGePoint3d</exref> object; 
  therefore, it can be used to set a new 3D point to specify the vertex position.
  */
  OdGePoint3d &point();
  
  /** \details
  Requests the current 3D point that specifies the vertex position.
  \returns An <exref target="https://docs.opendesign.com/tkernel/OdGePoint3d.html">OdGePoint3d</exref> object that represents the vertex position.
  */
  const OdGePoint3d &point() const;

  /** \details
  Requests the current base topology data.
  \returns An <link OdPrcBaseTopology, OdPrcBaseTopology> object that contains the base topology data.
  \remarks 
  Base topology data is returned as a reference to an <link OdPrcBaseTopology, OdPrcBaseTopology> object; therefore, it can be used to set new topology data.
  */
  OdPrcBaseTopology &baseTopology();

  /** \details
  Requests the current base topology data.
  \returns An <link OdPrcBaseTopology, OdPrcBaseTopology> object that contains the base topology data.
  */  
  const OdPrcBaseTopology &baseTopology() const;

  /** \details
  Sets a new tolerance value.
  \param tolerance [in] A new tolerance value to be set.
  */
  void setTolerance(double tolerance);
  
  /** \details
  Requests the current tolerance value.
  \returns A double value that contains the current tolerance.
  */
  double tolerance() const;

  /** \details
  Sets a new value for the tolerance flag. 
  The tolerance flag indicates whether the tolerance is associated with the vertex (true) or not (false).
  \param have_tolerance [in] A new value of the tolerance flag to be set.
  */
  void setHaveTolerance(bool have_tolerance);
  
  /** \details
  Requests the current value of the tolerance flag.
  The tolerance flag indicates whether the tolerance is associated with the vertex (true) or not (false).
  \returns The true value if the vertex has a tolerance value; otherwise, the method returns false.
  */
  bool haveTolerance() const;
};
SMARTPTR(OdPrcUniqueVertex);

#endif // _PRCUNIQUEVERTEX_INCLUDED_