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

#include "PrcUserData.h"
#include "PrcView.h"
#include "PrcMarkups.h"
#include "PrcRepresentationItem.h"
#include "PrcBoundingBox.h"
#include "PrcBaseWithGraphics.h"
SMARTPTR(OdPrcPartDefinition);

/** \details 
Class representing a part definition. 
It consists of a bounding box and views with annotations or specific display parameters.
<group PRC_Files_Structures_Assemblies> 
*/
class PRC_TOOLKIT OdPrcPartDefinition : public OdPrcBaseWithGraphics
{
public:
  //DOM-IGNORE-BEGIN
  ODPRC_DECLARE_MEMBERS_PRCBASE(OdPrcPartDefinition);
  //DOM-IGNORE-END

  /** \details
  Requests the current <link OdPrcBoundingBox, bounding box> for the <link OdPrcPartDefinition, part definition> object. 
  \returns An <link OdPrcBoundingBox, OdPrcBoundingBox> object that contains the current bounding box data.
  \remarks 
  The <link OdPrcBoundingBox, bounding box> is returned via a reference, and therefore any modification of the returned object causes the part definition bounding box to be changed as well.
  To restrict modifications of the user data outside the <link OdPrcPartDefinition, OdPrcPartDefinition> object, 
  call another <link OdPrcPartDefinition::boundingBox@const, boundingBox()> method that returns a constant reference.
  */
  OdPrcBoundingBox &boundingBox();

  /** \details
  Requests the current <link OdPrcBoundingBox, bounding box> for the <link OdPrcPartDefinition, part definition> object. 
  \returns An <link OdPrcBoundingBox, OdPrcBoundingBox> object that contains the current bounding box data.
  */
  const OdPrcBoundingBox &boundingBox() const;

  /** \details
  Requests the visible representation items from the <link OdPrcPartDefinition, part definition> object.
  \returns An <link OdPrcObjectIdArray, array of identifiers> that refer to the visible representation items.
  \remarks 
  The <link OdPrcObjectIdArray, array of identifiers> is returned via a reference, and therefore any modification of the returned array causes the list of visible representation items to be changed as well.
  To restrict modifications of the <link OdPrcObjectIdArray, array of identifiers> outside the <link OdPrcPartDefinition, OdPrcPartDefinition> object, 
  call another <link OdPrcPartDefinition::representationItem@const, representationItem()> method that returns a constant reference.
  */
  OdPrcObjectIdArray &representationItem();

  /** \details
  Requests the visible representation items from the <link OdPrcPartDefinition, part definition> object.
  \returns An <link OdPrcObjectIdArray, array of identifiers> that refer to the visible representation items.
  */
  const OdPrcObjectIdArray &representationItem() const;
  
  /** \details
  Requests the current <link OdPrcMarkups, information about markups> from the <link OdPrcPartDefinition, part definition> object.
  \returns An <link OdPrcMarkups, OdPrcMarkups> object that contains information about markups within the <link OdPrcPartDefinition, part definition> object.
  \remarks 
  The <link OdPrcMarkups, OdPrcMarkups> object is returned via a reference, and therefore any modification of the returned object causes the information about markups to be changed as well.
  To restrict modifications of the <link OdPrcMarkups, information about markups> outside the <link OdPrcPartDefinition, OdPrcPartDefinition> object, 
  call another <link OdPrcPartDefinition::markups@const, markups()> method that returns a constant reference.
  */
  OdPrcMarkups &markups();
   
  /** \details
  Requests the current <link OdPrcMarkups, information about markups> from the <link OdPrcPartDefinition, part definition> object.
  \returns An <link OdPrcMarkups, OdPrcMarkups> object that contains information about markups within the <link OdPrcPartDefinition, part definition> object.
  */
  const OdPrcMarkups &markups() const;
  
  /** \details
  Requests annotation views from the <link OdPrcPartDefinition, part definition> object.
  \returns An <link OdPrcObjectIdArray, array of identifiers> that refer to the annotation views.
  \remarks 
  The <link OdPrcObjectIdArray, array of identifiers> is returned via a reference, and therefore any modification of the returned array causes the list of annotation views to be changed as well.
  To restrict modifications of the <link OdPrcObjectIdArray, array of identifiers> outside the <link OdPrcPartDefinition, OdPrcPartDefinition> object, 
  call another <link OdPrcPartDefinition::annotationView@const, annotationView()> method that returns a constant reference.
  */
  OdPrcObjectIdArray &annotationView();
  
  /** \details
  Requests annotation views from the <link OdPrcPartDefinition, part definition> object.
  \returns An <link OdPrcObjectIdArray, array of identifiers> that refer to the annotation views.
  */
  const OdPrcObjectIdArray &annotationView() const;
  
  /** \details
  Requests the current user-defined data from the <link OdPrcPartDefinition, part definition> object.
  \returns An <link OdPrcUserData, OdPrcUserData> object that contains the user-defined data.
  \remarks 
  User data is returned as a reference to an <link OdPrcUserData, OdPrcUserData> object, and therefore it can be used to set new user data.
  To restrict modifications of the user data outside the <link OdPrcPartDefinition, OdPrcPartDefinition> object, 
  call another <link OdPrcPartDefinition::userData@const, userData()> method that returns a constant reference.
  */
  OdPrcUserData &userData();

  /** \details
  Requests the current user-defined data from the <link OdPrcPartDefinition, part definition> object.
  \returns An <link OdPrcUserData, OdPrcUserData> object that contains the user-defined data.
  */
  const OdPrcUserData &userData() const;

protected:
  virtual OdUInt32 subSetAttributes (OdGiDrawableTraits * traits) const;
  virtual bool subWorldDraw (OdGiWorldDraw * pWd) const;
};

#endif // _PRCPARTDEFINITION_INCLUDED_