/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2016, 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 Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2016 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 _OD_DB_POLYFACE_MESH_
#define _OD_DB_POLYFACE_MESH_

#include "TD_PackPush.h"

#include "DbEntity.h"
#include "DbObjectIterator.h"

class OdDbPolyFaceMeshVertex;
class OdDbSequenceEnd;
class OdDbFaceRecord;
/** \details
  This template class is a specialization of the OdSmartPtr class for OdDbPolyFaceMeshVertex object pointers.
*/
typedef OdSmartPtr<OdDbPolyFaceMeshVertex> OdDbPolyFaceMeshVertexPtr;
/** \details
  This template class is a specialization of the OdSmartPtr class for OdDbSequenceEnd object pointers.
*/
typedef OdSmartPtr<OdDbSequenceEnd> OdDbSequenceEndPtr;

/** \details
    This class represents PolyFaceMesh entities in an OdDbDatabase instance.
  
    \sa
    TD_Db

    \remarks
    A PolyFaceMesh entity consists of a list of PolyFaceMeshVertex (coordinate) vertices 
    and a list of OdDbFaceRecord face records.
    Together they define a set of 3D faces.
    
    \note
    Never derive from this class.

    <group OdDb_Classes>
*/
class TOOLKIT_EXPORT OdDbPolyFaceMesh : public OdDbEntity
{
public:
  ODDB_DECLARE_MEMBERS(OdDbPolyFaceMesh);

  OdDbPolyFaceMesh();
  
  /** \details
    Returns the number of vertices in this PolyFaceMesh entity (DXF 71).
  */
  OdInt16 numVertices() const;

  /** \details
    Returns the number of faces in this PolyFaceMesh entity (DXF 72).
  */
  OdInt16 numFaces() const;
  
  /** \details
    Appends the specified face vertex onto this PolyFaceMesh entity.

    \param pVertex [in]  Pointer to the vertex to append.

    \remarks
    Returns the Object ID of the appended face vertex.
  */
  OdDbObjectId appendVertex(
    OdDbPolyFaceMeshVertex* pVertex);
  
  /** \details
    Appends the specified face record onto this PolyFaceMesh entity.

    \param pFaceRecord [in]  Pointer to the face record to append.

    \remarks
    Returns the Object ID of the newly appended face record.
  */
  OdDbObjectId appendFaceRecord(
    OdDbFaceRecord* pFaceRecord);
  
  /** \details
    Opens the specified vertex or face record owned by this PolyFaceMesh entity.

    \param subObjId [in]  Object ID of vertex or face record to be opened.
    \param mode [in]  Mode in which the object is being opened.
    \param openErasedOne [in]  If and only if true, erased objects will be opened.
    \remarks
    Returns a SmartPointer to the opened object if successful, otherwise a null SmartPointer.
  */
  OdDbPolyFaceMeshVertexPtr openVertex(
    OdDbObjectId subObjId, 
    OdDb::OpenMode mode, 
    bool openErasedOne = false);
  
  /** \details
    Opens the OdDbSequenceEnd entity for this PolyfaceMesh entity.

    \param mode [in]  Mode in which to open the OdDbSequenceEnd entity.

    \remarks
    Returns a SmartPointer to the newly opened OdDbSequenceEnd, or a null SmartPointer.

    \note
    This method is provided solely for applications that store XData on
    OdDbSequenceEnd entities; this is not recommended. 
  */
  OdDbSequenceEndPtr openSequenceEnd(
    OdDb::OpenMode mode);
  
  /** \details
    Returns a SmartPointer to an iterator that can be used to traverse the vertices and face records owned 
    by this PolyFaceMesh entity.
  */
  OdDbObjectIteratorPtr vertexIterator() const;

  virtual bool subWorldDraw(
    OdGiWorldDraw* pWd) const;
  
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);

  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;

  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);

  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;

  virtual void dxfOut(
    OdDbDxfFiler* pFiler) const;

  virtual OdResult dxfIn(
    OdDbDxfFiler* pFiler);

  virtual OdResult subGetClassID(
    void* pClsid) const;

  virtual OdResult dxfInFields_R12(
    OdDbDxfFiler* pFiler);

  virtual void dxfOutFields_R12(
    OdDbDxfFiler* pFiler) const;

  void subClose();

  virtual bool isPlanar() const;
  
  virtual OdResult getPlane(
    OdGePlane& plane, 
    OdDb::Planarity& planarity) const;

  virtual OdResult subTransformBy(
    const OdGeMatrix3d& xfm);

  OdResult subGetGeomExtents(
    OdGeExtents3d& extents) const;

  /** \remarks
    Creates and returns a set of OdDbFace entities.
  */
  virtual OdResult subExplode(
    OdRxObjectPtrArray& entitySet) const;

  /** \remarks
    Creates and returns a set of OdDbFace entities.
  */
  virtual OdResult explodeGeometry(OdRxObjectPtrArray& entitySet) const;

  OdResult subGetSubentPathsAtGsMarker( OdDb::SubentType type,
                                        OdGsMarker gsMark, 
                                        const OdGePoint3d& ,
                                        const OdGeMatrix3d& , 
                                        OdDbFullSubentPathArray& subentPaths, 
                                        const OdDbObjectIdArray* pEntAndInsertStack ) const;

  OdResult subGetGsMarkersAtSubentPath( const OdDbFullSubentPath& subPath, 
                                        OdGsMarkerArray& gsMarkers) const;

};
/** \details
  This template class is a specialization of the OdSmartPtr class for OdDbPolyFaceMesh object pointers.
*/
typedef OdSmartPtr<OdDbPolyFaceMesh> OdDbPolyFaceMeshPtr;

#include "TD_PackPop.h"

#endif