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

#include "DbBlock1PtParameter.h"
#include "DbBlockXYGrip.h"

/** \details
    Generic one point parameter.
    
    <group OdDb_Classes> 
*/
class DYNBLOCKS_EXPORT OdDbBlockPointParameter : public OdDbBlock1PtParameter
{
public:
  ODDB_EVAL_DECLARE_MEMBERS(OdDbBlockPointParameter);
  OdDbBlockPointParameter();
  /** \details
   Returns the position label
  */
  OdString positionName() const;

  /** \details
   Sets the position label
  */
  void setPositionName(const OdString&);

  /** \details
   Returns the position description (tooltip)
  */
  OdString positionDescription() const;

  /** \details
   Sets the position description (tooltip)
  */
  void setPositionDescription(const OdString&);

  /** \details
   Returns the label position in the original block
  */
  OdGePoint3d definitionLabelPoint() const;

  /** \details
   Sets the label position in the original block
  */
  void setDefinitionLabelPoint( const OdGePoint3d& );

  /** \details
   Returns the X coordinate of the parameter definition point in the original block
  */
  double definitionX() const;

  /** \details
   Returns the Y coordinate of the parameter definition point in the original block
  */
  double definitionY() const;

  /** \details
   Sets the X coordinate of the parameter definition point in the original block
  */
  void setDefinitionX(double);

  /** \details
   Sets the Y coordinate of the parameter definition point in the original block
  */
  void setDefinitionY(double);

  /** \details
   Returns the X coordinate of the parameter point in the representation block
  */
  double X() const;
  
  /** \details
   Returns the Y coordinate of the parameter point in the representation block
  */
  double Y() const;
  
  /** \details
   Sets the X coordinate of the parameter point in the representation block
  */
  void setX(double);
  
  /** \details
   Sets the Y coordinate of the parameter point in the representation block
  */
  void setY(double);

  /** \details
   Returns the X coordinate of the updated parameter point in the representation block
  */
  double updatedX() const;
  
  /** \details
   Returns the Y coordinate of the updated parameter point in the representation block
  */
  double updatedY() const;
  
  /** \details
   Sets the X coordinate of the updated parameter point in the representation block
  */
  void setUpdatedX(double);
  
  /** \details
   Sets the Y coordinate of the updated parameter point in the representation block
  */
  void setUpdatedY(double);

  /** \details
   Returns the grip point associated with this parameter
  */
  OdDbBlockXYGripPtr getAssociatedXYGrip(OdDb::OpenMode = OdDb::kForRead);
};

typedef OdSmartPtr<OdDbBlockPointParameter> OdDbBlockPointParameterPtr;

#endif // _DbBlockPointParameter_h_Included_