/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2024, 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-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

#pragma once
#include "DbBlockGrip.h"
class OdDbBlockFlipParameter;
typedef OdSmartPtr<OdDbBlockFlipParameter> OdDbBlockFlipParameterPtr;

/** \details
    Grip point specialized for the OdDbFlipParameter

    <group OdDb_Classes>
*/
class DYNBLOCKS_EXPORT OdDbBlockFlipGrip : public OdDbBlockGrip
{
public:
  ODDB_EVAL_DECLARE_MEMBERS(OdDbBlockFlipGrip);

  /** \details
   Default constructor.
  */ 
  OdDbBlockFlipGrip();

  /** \details
    Returns the grip state in the representation block
  */
  OdDbBlockFlipParameter::FlipState flipState() const;
  
  /** \details
    Sets the grip state in the representation block.
  */
  void setFlipState(OdDbBlockFlipParameter::FlipState);

  /** \details
    Returns the grip state at runtime.
  */
  OdDbBlockFlipParameter::FlipState updatedFlipState();

  /** \details
    Sets the grip state at runtime.
  */
  void setUpdatedFlipState(OdDbBlockFlipParameter::FlipState);

  /** \details
    Returns the associated flip parameter.
  */
  OdDbBlockFlipParameterPtr getAssociatedFlipParameter(OdDb::OpenMode = OdDb::kForRead);

  /** \details
    Returns the grip orientation vector.
  */
  OdGeVector3d orientation();
  
  /** \details
    Sets the grip orientation vector.
  */
  void setOrientation(const OdGeVector3d&);
  
  /** \details
    Switch the grip state to the opposite.
  */
  void cycleFlipState();

  /** \details
    Returns true if the associated flip parameter normal is mirrored.
  */
  bool isParameterIsMirrored() const;

  void addedToGraph(OdDbEvalGraph* gr) override;
  void removedFromGraph(OdDbEvalGraph* gr) override;
};
typedef OdSmartPtr<OdDbBlockFlipGrip> OdDbBlockFlipGripPtr;