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

#include "IfcRepresentationItem.h"
#include "IfcModelerGeometry/IfcModelerGeometry.h"

#include "TD_PackPush.h"

/** \details 
Contains declarations related to working with IFC files content.
*/
namespace OdIfc {

  /** \details 
  A base class that implements storing and handling data about an IfcMappedItem.
  An IfcMappedItem is a sub-type of an IfcRepresentationItem that represents a representation item nested in other representation item.
  */
  class IFCGEOM_EXPORT OdIfcMappedItem : public OdIfcRepresentationItem
  {
    ODRX_DECLARE_MEMBERS(OdIfcMappedItem);

  public:

    /** \details
    Retrieves an <exref target="../tifc_api_cpp/OdDAIObjectId.html">object identifier</exref> of the underlying <exref target="../tifc_api_cpp/OdIfc__OdIfcRepresentationMap.html">OdIfcRepresentationMap</exref> instance.
    \returns An <exref target="../tifc_api_cpp/OdDAIObjectId.html">object identifier</exref>  of the underlying <exref target="../tifc_api_cpp/OdIfc__OdIfcRepresentationMap.html">OdIfcRepresentationMap</exref> instance.
    */
    OdDAIObjectId mappingSource();

    /** \details
    Retrieves the Mapping Target translation for the mapped item.
    \returns An <exref target="../tkernel_api_cpp/OdGeMatrix3d.html">OdGeMatrix3d</exref> object that contains the Mapping Target translation.
    */
    const OdGeMatrix3d& mappingTarget() const;

    OdUInt32 subSetAttributes(OdGiDrawableTraits* pTraits) const override;

    /** \details 
    Draws the mapped item to the <exref target="../tv_api_cpp/OdGiWorldDraw.html">OdGiWorldDraw interface</exref>.
    \param pWd [in] A raw pointer to the object for the entity-level vectorization.
    \returns true if the mapped item was successfully drawn; otherwise, the method returns false.
    */
    virtual bool draw(OdGiWorldDraw* pWd) const override;

    /** \details
    Composes the mapped item.
    */
    virtual void compose() override;

  protected:

    OdGeMatrix3d m_transf;

    OdResult transformBy(const OdGeMatrix3d &transform) ODRX_OVERRIDE;

    OdResult getMappedItems(OdArray<OdIfcModelerGeometryPtr>& openings, bool needCopy = false, bool needTransform = false);

    friend class OdIfcElement;
  };

  /** \details
  A data type that represents a smart pointer to an <exref target="../tifc_api_cpp/OdIfc__OdIfcMappedItem.html">OdIfcMappedItem</exref> object.
  */
  typedef OdSmartPtr<OdIfcMappedItem> OdIfcMappedItemPtr;

} //namespace OdIfc

#include "TD_PackPop.h"

#endif // _IFC_MAPPEDITEM_H_