/////////////////////////////////////////////////////////////////////////////// 
// 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_FACE_
#define _OD_DB_FACE_

#include "TD_PackPush.h"

#include "DbEntity.h"

/** \details
  <group OdDb_Classes> 

  This class implements the /3d face/ object (3D Face entity) in the database. 
  This class inherits the base functionality of entities. 

  \sa
  TD_Db
    
  \sa
  <link db_face_sample.html, Example of Working with the 3D Face Object>

  \sa
  <link db_face.html, Working with 3D Faces>
*/
class TOOLKIT_EXPORT OdDbFace : public OdDbEntity
{
public:                
  ODDB_DECLARE_MEMBERS(OdDbFace);

  /** \details
    Builds an instance of the /3d face/ entity.
    
    \remarks
    Use the static pseudo-constructor instead it.
    See: <link db_face_overview.html, Overview of 3D Faces>
  */
  OdDbFace();


  /** \details
    Gets the WCS coordinates of the vertex belonged to the 3d face entity using its index 
    (DXF 10, 11, 12, or 13).

    \param vertexIndex [in]  Vertex index 0, 1, 2, or 3.
    \param vertexValue [out]  Reference to a variable in which this method must save the 3d face vertex 
                    as a three-dimensional point instance.

    \sa
    <link db_face_sample.html, Example of Working with the 3D Face Object>

    \sa
    <link db_face_specific.html, Specific 3D Face Properties>

    OdDbFace::setVertexAt() method
  */
  void getVertexAt( OdUInt16 vertexIndex, OdGePoint3d& vertexValue ) const;


  /** \details
    Sets the WCS coordinates of the vertex belonged to the 3d face entity using its index 
    (DXF 10, 11, 12, or 13).

    \param pointIndex [in]  Vertex index 0, 1, 2, or 3.
    \param pointValue [in]  Three-dimensional point instance to be set the vertex.

    \sa
    <link db_face_sample.html, Example of Working with the 3D Face Object>

    \sa
    <link db_face_specific.html, Specific 3D Face Properties>

    OdDbFace::getVertexAt() method
  */
  void setVertexAt( OdUInt16 vertexIndex, const OdGePoint3d& vertexValue );


  /** \details
    Determines the visiblity of 3d face edge at the specified index (DXF 70) and returns 
    True if the edge is visible or False if the edge is invisible. 

    \param edgeIndex [in]  Edge index 0, 1, 2, or 3.

    \sa
    <link db_face_sample.html, Example of Working with the 3D Face Object>

    \sa
    <link db_face_specific.html, Specific 3D Face Properties>

    OdDbFace::makeEdgeVisibleAt(), OdDbFace::makeEdgeInvisibleAt() methods
  */
  bool isEdgeVisibleAt( OdUInt16 edgeIndex ) const;


  /** \details
    Turns to visible the 3d face edge at the specified index (DXF 70).

    \param edgeIndex [in]  Edge index 0, 1, 2, or 3.

    \sa
    <link db_face_sample.html, Example of Working with the 3D Face Object>

    \sa
    <link db_face_specific.html, Specific 3D Face Properties>

    OdDbFace::isEdgeVisibleAt(), OdDbFace::makeEdgeInvisibleAt() methods
  */
  void makeEdgeVisibleAt( OdUInt16 edgeIndex );


  /** \details
    Turns to invisible the 3d face edge at the specified index (DXF 70).

    \param edgeIndex [in]  Edge index 0, 1, 2, or 3.

    \sa
    <link db_face_sample.html, Example of Working with the 3D Face Object>

    \sa
    <link db_face_specific.html, Specific 3D Face Properties>

    OdDbFace::makeEdgeVisibleAt(), OdDbFace::isEdgeVisibleAt() methods
  */
  void makeEdgeInvisibleAt( OdUInt16 edgeIndex );

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


  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);

  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;

  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);

  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;

  virtual OdResult dxfInFields_R12(
    OdDbDxfFiler* pFiler);

  virtual void dxfOutFields_R12(
    OdDbDxfFiler* pFiler) const;

  bool subWorldDraw(
    OdGiWorldDraw* pWd) const;

  void subViewportDraw(
    OdGiViewportDraw* pVd) const;

  virtual OdResult subGetClassID(
    void* pClsid) const;

  virtual OdResult subTransformBy(const OdGeMatrix3d& xfm);

  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
  The typified smart pointer for the /3d face/ object (3D Face entity). This template class 
  is specialization of the OdSmartPtr class for the OdDbFace object.

  \sa
  <link smart_pointers.html, Working with Smart Pointers>
*/
typedef OdSmartPtr<OdDbFace> OdDbFacePtr;

#include "TD_PackPop.h"

#endif