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

#include "DbAssocArrayActionBody.h"
#include "DbAssocArrayParameters.h"

#include "TD_PackPush.h"


/** \details
    <group Contraint_Classes>
*/
class DBCONSTRAINTS_EXPORT OdDbAssocArrayModifyParameters : public OdDbAssocArrayParameters
{
public:
  ODRX_DECLARE_MEMBERS( OdDbAssocArrayModifyParameters );

  OdDbAssocArrayModifyParameters();

  /** \details
    Destructor destroys an instance of this class.
    */
  virtual ~OdDbAssocArrayModifyParameters();

  /** \details
    Gets an array of items.
  */
  virtual OdResult getItems( OdArray<OdDbAssocArrayItemPtr>& items ) const;

protected:

  /** \details
    Gets the item locator, position, and transformation matrix. This method is pure and 
    must be overridden in derived classes.
  */
  virtual OdResult getItemPosition( const OdDbItemLocator& locator,
                                   OdGePoint3d& position,
                                   OdGeMatrix3d& xform ) const;

  /** \details
    Gets the item locator. This method is pure and must be overridden in derived classes.
  */
  virtual OdDbItemLocator getCanonicalForm( const OdDbItemLocator& /*locator*/ ) const
  {
    return OdDbItemLocator();
  }

  OdDbAssocArrayModifyParameters(class OdDbImpAssocArrayModifyParameters* pImpl);
  
private:
  
};


typedef OdSmartPtr<OdDbAssocArrayModifyParameters> OdDbAssocArrayModifyParametersPtr;


/** \details
  This class represents an array of associated actions which can be evaluated to manage or locate the items.

  Library: Source *code* provided.
  <group Contraint_Classes> 
*/
class DBCONSTRAINTS_EXPORT OdDbAssocArrayModifyActionBody : public OdDbAssocArrayActionBody
{
public:
  ODRX_DECLARE_MEMBERS(OdDbAssocArrayModifyActionBody);

  /** \details
    Constructor creates an instance of this class.
  */
  OdDbAssocArrayModifyActionBody();

  /** \details
    Destructor destroys an instance of this class.
  */
  virtual ~OdDbAssocArrayModifyActionBody();

  /** \details
    Get indices of overridden items.
  */
  OdResult getOverridenItems( OdArray<OdDbItemLocator> &indices ) const;
  
  /** \details
    Set indices of overridden items.
  */
  OdResult setOverridenItems( const OdArray<OdDbItemLocator> &indices);

  /** \details
    Checks whether an item of an associated array can be controlled either by created action 
    or by another action which modifies this item.
  */
  virtual bool controlsItem(const OdDbItemLocator &index) const;

  
  /** \details
    Creates associative array: action, action body, dependencies etc.
  */
  static OdResult createInstance( OdDbObjectId arrayId,
                                  const OdArray<OdDbItemLocator> &indices,
                                  const OdDbObjectIdArray &subEnt,
                                  OdDbVertexRef &basePoint,
                                  OdDbObjectId& actionBodyId);
 
};

/** \details
  The typified smart pointer. This template class is specialization of the OdSmartPtr class 
  for the OdDbAssocArrayModifyActionBody class.

  \sa
  <link smart_pointers, Working with Smart Pointers>
*/
typedef OdSmartPtr<OdDbAssocArrayModifyActionBody> OdDbAssocArrayModifyActionBodyPtr;

#include "TD_PackPop.h"

#endif