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

#include "Br/BrEnums.h"
#include "Br/BrEntity.h"
#include "Br/BrExport.h"

/** \details
  This class defines the interface base class for mesh objects and subobjects.

  \remarks 
  This class is implemented only for Spatial modeler.

  \sa
  TD_Br
  
  <group OdBr_Classes>
*/
class ODBR_TOOLKIT_EXPORT OdBrMeshEntity
{
  friend class OdBrEntityInternals;
public:

  /** \details
    Virtual destructor.
  */
  virtual ~OdBrMeshEntity();

  /** \details
    Checks if content of the two mesh objects is equal.
    
    \param other [in] Another mesh object.
    
    \returns Returns true if two mesh objects are equal, 
    or returns false in the other case.  
  */
  bool      isEqualTo       (const OdBrMeshEntity* other) const;

  /** \details
    Returns true if and only if this mesh object is uninitialized.
  */
  bool      isNull          () const;

  /** \details
    Returns the topology object associated with this mesh object.

    \param entity [out] Dimensionally lowest topology object.

    \returns Returns odbrOK if successful, or an appropriate error code if not.
  */
  OdBrErrorStatus   getEntityAssociated(OdBrEntity*& entity) const;

  // Validation
  /** \details
    Sets the validation level. 

    \param level [in] Validation level.

    \returns Returns odbrOK if successful, or an appropriate error code if not.  
  */
  OdBrErrorStatus setValidationLevel(const BrValidationLevel& level);
  
  /** \details
    Returns the validation level used by the mesh object.

    \param level [out] Validation level.

    \returns Returns odbrOK if successful, or an appropriate error code if not.  
  */
  OdBrErrorStatus getValidationLevel(BrValidationLevel& level) const;
  
  /** \details
    Checks whether the object associated with this mesh has changed since the mesh 
    object was last set.

    \returns Returns true if the associated object has changed or if it is impossible to 
    determine whether it has changed. Returns false if the associated object has 
    not changed or if it is a non-database resident.
  */
  bool    brepChanged    () const;

protected:
  /** \details
    Default constructor.
  */
  OdBrMeshEntity();
#ifdef OD_ADD_MOVE_CTOR_HAVE_DEF_DEL_FUNC
  //DOM-IGNORE-BEGIN
  OdBrMeshEntity(const OdBrMeshEntity&) = default;
  OdBrMeshEntity& operator=(const OdBrMeshEntity&) = default;
  OdBrMeshEntity(OdBrMeshEntity&&) = default;
  OdBrMeshEntity& operator=(OdBrMeshEntity&&) = default;
  //DOM-IGNORE-END
#endif

  OdRxObjectPtr m_pImp;
  bool m_bIsValidate; //The enum has only 2 values.
};


#endif