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

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

class OdDbBlockRotationGrip;
typedef OdSmartPtr<OdDbBlockRotationGrip> OdDbBlockRotationGripPtr;


/** \details
    Block parameter representing angle for the OdDbBlockRotateAction
    
    <group OdDb_Classes> 
*/
class DYNBLOCKS_EXPORT OdDbBlockRotationParameter : public OdDbBlock2PtParameter
{
public:
  ODDB_EVAL_DECLARE_MEMBERS(OdDbBlockRotationParameter);

  /** \details
    Default constructor
  */
  OdDbBlockRotationParameter();

  /** \details
    Returns angle value name
  */
  OdString angleName() const;

  /** \details
    Sets angle value name
  */
  void setAngleName(const OdString&);

  /** \details
    Returns angle value description (tooltip)
  */
  OdString angleDescription() const;

  /** \details
    Sets angle value description (tooltip)
  */
  void setAngleDescription(const OdString &);

  /** \details
    Returns the base angle from which parameter angle is calculated
  */
  double baseAngle() const;

  /** \details
    Returns the point defining the base angle from which parameter angle is calculated
  */
  OdGePoint3d baseAnglePoint() const;

  /** \details
    Returns the definition (template) base angle from which parameter angle is calculated
  */
  double definitionBaseAngle() const;

  /** \details
    Returns the point defining the base angle in the original (template) block
  */
  OdGePoint3d definitionBaseAnglePoint() const;
  
  /** \details
    Sets the point defining the base angle in the original (template) block
  */
  void setDefinitionBaseAnglePoint(const OdGePoint3d&);

  /** \details
    Returns the grip point that moves this parameter
  */
  OdDbBlockRotationGripPtr getAssociatedRotationGrip(OdDb::OpenMode = OdDb::kForRead);

  /** \details
    Returns the offset added to the angle value
  */
  double offset() const;

  /** \details
    Sets the offset added to the angle value
  */
  void setOffset(double);

  /** \details
    Returns the angle value limitations
  */
  void setValueSet(const OdDbBlockParamValueSet&);
  /** \details
    Sets the angle value limitations
  */
  OdDbBlockParamValueSetPtr valueSet() const;

  /** \details
    Sets the updated angle parameter value
  */
  void setUpdatedAngle(double);
};

typedef OdSmartPtr<OdDbBlockRotationParameter> OdDbBlockRotationParameterPtr;

#endif // _DbBlockRotationParameter_h_Included_