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

#include "DbBlock2PtParameter.h"
#include "DbBlockParamValueSet.h"

class OdDbBlockXYGrip;
typedef OdSmartPtr<OdDbBlockXYGrip>OdDbBlockXYGripPtr;

/** \details
    Block parameter representing 2d offset represented as a pair of distances
    <group OdDb_Classes> 
*/
class DYNBLOCKS_EXPORT OdDbBlockXYParameter : public OdDbBlock2PtParameter
{
public:
  ODDB_EVAL_DECLARE_MEMBERS(OdDbBlockXYParameter);
  /** \details
   Default constructor
  */ 
  OdDbBlockXYParameter();

  /** \details
   Returns horizontal distance name
  */
  OdString horzName() const;
  
  /** \details
   Returns vertical distance name
  */
  OdString vertName() const;

  /** \details
   Sets horizontal distance name
  */
  void setHorzName(const OdString&);

  /** \details
   Sets vertical distance name
  */
  void setVertName(const OdString&);

  /** \details
   Returns horizontal distance description
  */
  OdString horzDescription() const;
  
  /** \details
   Returns vertical distance description
  */
  OdString vertDescription() const;
  
  /** \details
   Sets horizontal distance description
  */
  void setHorzDescription(const OdString&);

  /** \details
   Sets vertical distance description
  */
  void setVertDescription(const OdString&);

  /** \details
   Returns horizontal distance label offset
  */
  double XOffset() const;
  
  /** \details
   Returns vertical distance label offset
  */
  double YOffset() const;
  
  /** \details
   Sets horizontal distance label offset
  */
  void setXOffset(double);
  
  /** \details
   Sets vertical distance label offset
  */
  void setYOffset(double);
 
  /** \details
   Returns horizontal distance value constraints
  */
  OdDbBlockParamValueSetPtr xValueSet() const;
  
  /** \details
   Returns vertical distance value constraints
  */
  OdDbBlockParamValueSetPtr yValueSet() const;
  
  /** \details
   Sets horizontal distance value constraints
  */
  void setXValueSet(const OdDbBlockParamValueSet&);
  
  /** \details
   Sets vertical distance value constraints
  */
  void setYValueSet(const OdDbBlockParamValueSet&);

  /** \details
   Returns horizontal distance value in the template block
  */
  double definitionHorzDistance() const;
  
  /** \details
   Returns vertical distance value in the template block
  */
  double definitionVertDistance() const;
  
  /** \details
   Sets horizontal distance value in the template block
  */
  void setDefinitionHorzDistance(double);
  
  /** \details
   Sets vertical distance value in the template block
  */
  void setDefinitionVertDistance(double);

  /** \details
   Returns the parameter grip point for the given component
  */
  OdDbBlockXYGripPtr getAssociatedXYGrip(OdDbBlockParameter::ParameterComponent pc, OdDb::OpenMode mode = OdDb::kForRead);

  /** \details
   Returns horizontal distance value in the representation block
  */
  double horzDistance() const;
  
  /** \details
   Returns vertical distance value in the representation block
  */
  double vertDistance() const;
  
  /** \details
   Sets horizontal distance value in the representation block
  */
  void setHorzDistance(double);

  /** \details
   Sets vertical distance value in the representation block
  */
  void setVertDistance(double);

  /** \details
   Returns horizontal distance value at runtime
  */
  double updatedHorzDistance() const;
  
  /** \details
   Returns vertical distance value at runtime
  */
  double updatedVertDistance() const;

  /** \details
   Sets horizontal distance value at runtime
  */
  void setUpdatedHorzDistance(double);

  /** \details
   Sets vertical distance value at runtime
  */
  void setUpdatedVertDistance(double);
};

typedef OdSmartPtr<OdDbBlockXYParameter> OdDbBlockXYParameterPtr;

#endif // _DbBlockXYParameter_h_Included_