DbSurface.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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-2024 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 _DBSURFACE_H_INCLUDED_
#define _DBSURFACE_H_INCLUDED_
 
#include "TD_PackPush.h"
#include "ModelerDefs.h"
#include "DbEntity.h"
#include "Db3dSolid.h"
#include "Db3dProfile.h"
 
class OdModelerGeometry;
class OdStreamBuf;
class OdBrBrep;
 
class OdDbSurface;
class OdDbNurbSurface;

typedef OdSmartPtr<OdDbNurbSurface> OdDbNurbSurfacePtr;

typedef OdArray<OdDbNurbSurfacePtr> OdDbNurbSurfacePtrArray;

typedef OdSmartPtr<OdDbSurface> OdDbSurfacePtr;
 

class DBENT_EXPORT OdDbSurface : public OdDbEntity
{
public:
  enum EdgeExtensionType
  {
    kExtendEdge = 0x00,
    kStretchEdge = 0x01,
  };

  OdDbSurface();
 
  //DOM-IGNORE-BEGIN
  ODDB_DECLARE_MEMBERS(OdDbSurface);
  //DOM-IGNORE-END

  virtual OdUInt16 uIsolineDensity() const;

  virtual void setUIsolineDensity(OdUInt16 numIsolines);

  virtual OdUInt16 vIsolineDensity() const;

  virtual void setVIsolineDensity(OdUInt16 numIsolines);

  static OdResult createFrom(const OdDbEntity* pFromEntity, OdDbSurfacePtr& pNewSurface);

  virtual OdResult convertToRegion(OdDbEntityPtrArray& regions);

  virtual OdResult thicken(double thickness, bool bBothSides, OdDb3dSolidPtr& pSolid) const;

  virtual OdResult getArea(double& area) const;

  bool isNull() const;

  OdResult acisOut(
    OdStreamBuf* pStreamBuf,
    AfTypeVer typeVer = kAfTypeVerAny) const;

  OdResult acisIn(
    OdStreamBuf* pStreamBuf,
    AfTypeVer *pTypeVer = 0);

  void brep(OdBrBrep& brep);

  bool getFaceMesh(GeMesh::OdGeTrMesh& mesh, OdGsMarker iFace, const wrTriangulationParams& triangulationParams) const;

  virtual OdDbObjectPtr decomposeForSave(
    OdDb::DwgVersion ver,
    OdDbObjectId& replaceId,
    bool& exchangeXData);

  virtual OdResult subExplode(
    OdRxObjectPtrArray& entitySet) const;

  virtual OdResult subTransformBy(
    const OdGeMatrix3d& xfm);

  virtual void saveAs(
    OdGiWorldDraw* pWd,
    OdDb::DwgVersion ver) const;

  virtual OdResult setBody(const void* pGeometry);

  virtual void* body() const;
 
  // OdDbObject methods

  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);

  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;

  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);

  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;

  virtual bool subWorldDraw(
    OdGiWorldDraw* pWd) const;

  virtual void subViewportDraw(
    OdGiViewportDraw* pVd) const;

  virtual OdResult subGetClassID(
    void* pClsid) const;

  virtual OdDbSubentId internalSubentId(void* ent) const;

  virtual void* internalSubentPtr(const OdDbSubentId& id) const;

  virtual OdDbEntityPtr subSubentPtr(const OdDbFullSubentPath& id) const;

  virtual OdResult createInterferenceObjects(OdDbEntityPtrArray& interferenceObjects,
                                             OdDbEntityPtr pEntity,
                                             unsigned int flags) const;

  virtual OdResult booleanUnion(const OdDbSurface* pSurface, OdDbSurfacePtr& pNewSurface);

  virtual OdResult booleanSubtract(const OdDbSurface* pSurface, OdDbSurfacePtr& pNewSurface);

  virtual OdResult booleanSubtract(const OdDb3dSolid* pSolid, OdDbSurfacePtr& pNewSurface);

  virtual OdResult booleanIntersect(const OdDbSurface* pSurface, OdDbEntityPtrArray& intersectionEntities);

  virtual OdResult booleanIntersect(const OdDb3dSolid* pSolid, OdDbEntityPtrArray& intersectionEntities);

  virtual OdResult imprintEntity(const OdDbEntity* pEntity);

  virtual OdResult createSectionObjects(const OdGePlane& sectionPlane, OdDbEntityPtrArray& sectionObjects) const;

  virtual OdResult sliceByPlane(const OdGePlane& slicePlane,
                                OdDbSurfacePtr& pNegHalfSurface,
                                OdDbSurfacePtr& pNewSurface);

  virtual OdResult sliceBySurface(const OdDbSurfacePtr pSlicingSurface,
                                  OdDbSurfacePtr& pNegHalfSurface,
                                  OdDbSurfacePtr& pNewSurface);

  virtual OdResult chamferEdges(const OdArray<OdDbSubentId *> &edgeSubentIds,
                                const OdDbSubentId& baseFaceSubentId,
                                double baseDist,
                                double otherDist);

  virtual OdResult filletEdges( const OdArray<OdDbSubentId *> &edgeSubentIds,
                                const OdGeDoubleArray& radius,
                                const OdGeDoubleArray& startSetback,
                                const OdGeDoubleArray& endSetback);

  virtual OdResult setSubentColor(const OdDbSubentId& subentId, const OdCmColor& color);

  virtual OdResult getSubentColor(const OdDbSubentId& subentId, OdCmColor& color) const;

  virtual OdResult setSubentMaterial(const OdDbSubentId& subentId, const OdDbObjectId& matId);

  virtual OdResult getSubentMaterial(const OdDbSubentId& subentId, OdDbObjectId& matId) const;

  virtual OdResult setSubentMaterialMapper(const OdDbSubentId& subentId, const OdGiMapper& mapper);

  virtual OdResult getSubentMaterialMapper(const OdDbSubentId& subentId, OdGiMapper& mapper) const;

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

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

  virtual OdResult subGetTransformedCopy(const OdGeMatrix3d& mat, OdDbEntityPtr& pCopy) const;

  virtual OdResult convertToNurbSurface(OdDbNurbSurfacePtrArray& nurbSurfaceArray);

  virtual OdUInt32 subSetAttributes(OdGiDrawableTraits* pTraits) const;

  static OdResult trimSurface(const OdDbObjectId&      blankSurfaceId,
                              const OdDbObjectIdArray& toolIds,
                              const OdDbObjectIdArray& toolCurveIds,
                              const OdGeVector3dArray& projVectors,
                              const OdGePoint3d&       pickPoint,
                              const OdGeVector3d&      viewVector,
                              bool                     bAutoExtend,
                              bool                     bAssociativeEnabled);

  OdResult projectOnToSurface(const OdDbEntity*   pEntityToProject,
                              const OdGeVector3d& projectionDirection,
                              OdDbEntityPtrArray& projectedEntities) const;

  OdResult getPerimeter(double&) const;

  OdResult rayTest( const OdGePoint3d&      rayBasePoint,
                    const OdGeVector3d&     rayDir,
                    double                  rayRadius,
                    OdArray<OdDbSubentId> & subEntIds,
                    OdGeDoubleArray&        parameters) const;

  static OdResult createOffsetSurface ( OdDbEntity* pInputSurface,
                                        double dOffsetDistance,
                                        OdDbEntityPtr& offsetSurface);

  static OdResult createOffsetSurface ( OdDbEntity* pInputSurface,
                                        double dOffsetDistance,
                                        bool  bAssociativeEnabled,
                                        OdDbObjectId& offsetSurfaceId);

  static OdResult createFilletSurface ( const OdDbObjectId&  surfId1,
                                        const OdGePoint3d&   pickPt1,
                                        const OdDbObjectId&  surfId2,
                                        const OdGePoint3d&   pickPt2,
                                        double               dRadius,
                                        OdDb::FilletTrimMode trimMode,
                                        const OdGeVector3d&  projDir,
                                        OdDbSurfacePtr&      filletSurface);

  static OdResult createFilletSurface ( const OdDbObjectId&  surfId1,
                                        const OdGePoint3d&   pickPt1,
                                        const OdDbObjectId&  surfId2,
                                        const OdGePoint3d&   pickPt2,
                                        double               dRadius,
                                        OdDb::FilletTrimMode trimMode,
                                        const OdGeVector3d&  projDir,
                                        bool                 bAssociativeEnabled,
                                        OdDbObjectId&        filletSurfaceId);

  static OdResult createExtendSurface ( OdDbObjectId                 sourceSurface,
                                        const OdArray<OdDbSubentId>& edgesId,
                                        double                       dExtDist,
                                        EdgeExtensionType            extOption,
                                        bool                         bAssociativeEnabled,
                                        OdDbObjectId&                newExtendSurfaceId );

  static OdResult createNetworkSurface( const OdArray<OdDb3dProfilePtr>& uProfiles,
                                        const OdArray<OdDb3dProfilePtr>& vProfiles,
                                        OdDbSurfacePtr& newSurface );

  OdResult extendEdges( OdDbFullSubentPathArray& edgesId,
                        double                   dExtDist,
                        EdgeExtensionType        extOption,
                        bool                     bAssociativeEnabled );

  virtual OdResult subGetGeomExtents( OdGeExtents3d& extents) const;

  virtual void subHandOverTo(OdDbObject* pNewObject);

  virtual void subClose();

  virtual OdUInt32 numChanges() const;
 
  //DOM-IGNORE-BEGIN
  virtual void copyFrom(const OdRxObject* pSource) ODRX_OVERRIDE;
  //DOM-IGNORE-END
};
 
#include "TD_PackPop.h"
#endif //_DBSURFACE_H_INCLUDED_