/////////////////////////////////////////////////////////////////////////////// 
// 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.
///////////////////////////////////////////////////////////////////////////////

// StepRepresentationItem.h: interface for the OdStepRepresentationItem class.
//
//////////////////////////////////////////////////////////////////////

#ifndef _STEP_REPRESENTATIONITEM_H_
#define _STEP_REPRESENTATIONITEM_H_

#include "Gi/GiWorldDraw.h"

#include "StepCachedCompound.h"

/** \details
Contains declarations related to working with STEP file content.
*/
namespace OdStep {

  /** \details 
  The class that implements work with a representation items for STEP SDK.
  */
  class STEPGEOM_EXPORT OdStepRepresentationItem : public OdStepCachedCompound
  {
    //DOM-IGNORE-BEGIN
    ODRX_DECLARE_MEMBERS(OdStepRepresentationItem);
    //DOM-IGNORE-END

  public:
    
    /** \details
    Creates the representation item object.
    */
    OdStepRepresentationItem();

    /** \details 
    Destroys the representation item object.
    */
    virtual ~OdStepRepresentationItem();

    /** \details 
    Composes the representation item object.
    */
    virtual void compose();

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

    /** \details 
    Sets the values of the representation item's sub-entity traits.
    \param pTraits [out] A raw pointer to the traits to be filled and returned to a calling subroutine.  
    \returns The result of the value setting.
    */
    virtual OdUInt32 subSetAttributes(OdGiDrawableTraits* pTraits) const;
    
    /** \details 
    Draws graphical representation of the item that is independent on any view port contexts.
    \param wd [in] A raw pointer to the object that encapsulates parameters of view port independent vectorization. 
    \returns true if the drawing was successful; otherwise, the method returns false.
    */
    virtual bool subWorldDraw(OdGiWorldDraw * wd) const;
    
    /** \details 
    Transforms the representation item by a specified transformation matrix.
    \param transform [in] A transformation matrix object.
    \returns eOk if the transformation operation succeeds; otherwise, the method returns an appropriate error code.
    */
    virtual OdResult transformBy(const OdGeMatrix3d &transform);

    /** \details
    Sets drawing options for object.
    \param pWd [in] A raw pointer to the object that encapsulates parameters of view port independent vectorization. 
    \returns The result of the value setting.
    */
    OdResult setAttributes(OdGiWorldDraw* pWd) const;

   //DOM-IGNORE-BEGIN

    enum class RepresentationItemType
    {
      kUnknown,
      kMainRepresentation,
      kDimension,
      kSupplementalGeometry,
      kHolesSemantic,
      kPlyAnglesSemantic,
    };
  protected:
    //temporary protected
    RepresentationItemType itemType() const;

    void updateTraitsAuxData(OdGiWorldDraw * wd) const;
    void resetTraitsAuxData(OdGiWorldDraw * wd) const;

    RepresentationItemType m_itemType;

    friend class OdStepShapeRepresentation;
    friend class OdStepGeomCache;
  //DOM-IGNORE-END
  };
  
  /** \details 
  A data type that represents a smart pointer to an <exref target="https://docs.opendesign.com/step_api_cpp/OdStep__OdStepRepresentationItem.html>OdStepRepresentationItem</exref> object.
  */
  typedef OdSmartPtr<OdStepRepresentationItem> OdStepRepresentationItemPtr;

}

#endif // _STEP_REPRESENTATIONITEM_H_