BrepBuilder.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 _BREPBUILDER_H_
#define _BREPBUILDER_H_
 
#include "OdaCommon.h"
#include "BrepBuilderExport.h"
#include "Ge/GeCurve3d.h"
#include "CmColorBase.h"
#include "OdResult.h"
#include "TD_PackPush.h"
 
class OdDbStub;
class OdGiMapper;

enum BrepType
{
  kOpenShell,
  kSolid,
  kVoid
};

enum BrepBuilderSettings
{
  kHideEdgesBetweenTangentFaces = 0x1,
};
 
typedef OdUInt32 BRepBuilderGeometryId;

struct BREPBUILDEREXPORT BrepBuilderErrorsHolder
{
public:
  static const BRepBuilderGeometryId kInvalidId = BRepBuilderGeometryId(-1);

  BrepBuilderErrorsHolder()
    : m_errorCode(::eOk)
    , m_complexId(kInvalidId)
    , m_shellId(kInvalidId)
    , m_faceId(kInvalidId)
    , m_loopId(kInvalidId)
    , m_edgeId(kInvalidId)
    , m_coedgeId(kInvalidId)
    , m_errorMessage("")
  {};

  explicit BrepBuilderErrorsHolder(OdResult errCode, const OdString& errMsg = "",
    BRepBuilderGeometryId complexId = kInvalidId,
    BRepBuilderGeometryId shellId = kInvalidId,
    BRepBuilderGeometryId faceId = kInvalidId,
    BRepBuilderGeometryId loopId = kInvalidId,
    BRepBuilderGeometryId edgeId = kInvalidId,
    BRepBuilderGeometryId coedgeId = kInvalidId)
    : m_errorCode(errCode)
    , m_complexId(complexId)
    , m_shellId(shellId)
    , m_faceId(faceId)
    , m_loopId(loopId)
    , m_edgeId(edgeId)
    , m_coedgeId(coedgeId)
    , m_errorMessage(errMsg)
  {};

  OdResult m_errorCode;
  BRepBuilderGeometryId m_complexId;
  BRepBuilderGeometryId m_shellId;
  BRepBuilderGeometryId m_faceId;
  BRepBuilderGeometryId m_loopId;
  BRepBuilderGeometryId m_edgeId;
  BRepBuilderGeometryId m_coedgeId;
  OdString m_errorMessage;
};

typedef OdArray <BrepBuilderErrorsHolder> ValidationErrors;
 

class BREPBUILDEREXPORT OdBrepBuilder
{
public:
  BREPBUILDEREXPORT_STATIC static const BRepBuilderGeometryId kDefaultShellId;
  BREPBUILDEREXPORT_STATIC static const BRepBuilderGeometryId kDefaultVertexId;

  OdBrepBuilder();

  ~OdBrepBuilder();

  enum EntityDirection
  {
    kForward,
    kReversed
  };

  BrepType getType();

  void set(const void* pFile);

  BRepBuilderGeometryId addCoedge(const BRepBuilderGeometryId& loopId, const BRepBuilderGeometryId& edgeId, EntityDirection codgeDirection = kForward, const OdGeCurve2d* pParCur = NULL);

  BRepBuilderGeometryId addEdge(const OdGeCurve3d* pCurveForEdge);
  
  BRepBuilderGeometryId addEdge(const OdGeCurve3d* pCurveForEdge, const BRepBuilderGeometryId& vertex1Id, const BRepBuilderGeometryId& vertex2Id);

  BRepBuilderGeometryId addVertex(const OdGePoint3d& point);

  BRepBuilderGeometryId addFace(const OdGeSurface* pSurf, EntityDirection faceDirection, const BRepBuilderGeometryId& shellId = kDefaultShellId);

  BRepBuilderGeometryId addLoop(const BRepBuilderGeometryId& faceId);

  BRepBuilderGeometryId addShell(const BRepBuilderGeometryId& complexId);

  BRepBuilderGeometryId addComplex();

  void allowRemovalOfProblematicFaces();

  bool canAddGeometry();

  void finishComplex(const BRepBuilderGeometryId& complexId);

  void finishShell(const BRepBuilderGeometryId& shellId);

  void finishFace(const BRepBuilderGeometryId& faceId);

  void finishLoop(const BRepBuilderGeometryId& loopId);

  OdRxObjectPtr getResult();

  bool isPermittedSurfaceType(const OdGeSurface* pSurf);

  bool isResultAvailable();

  bool isValidEdgeId(const BRepBuilderGeometryId& edgeId);

  bool isValidComplexId(const BRepBuilderGeometryId& complexId);

  bool isValidShellId(const BRepBuilderGeometryId& shellId);

  bool isValidFaceId(const BRepBuilderGeometryId& faceId);

  bool isValidLoopId(const BRepBuilderGeometryId& loopId);

  bool removedSomeFaces();

  void setAllowShortEdges();

  void setFlag(const BRepBuilderGeometryId& id, OdUInt32 flag, bool enable);

  OdResult setFacesMaterial(const BRepBuilderGeometryId& faceId, OdDbStub& materialId);

  OdResult setFaceMaterialMapping(const BRepBuilderGeometryId& faceId,
    const OdGiMapper& materialMapper);

  OdResult setEdgeColor(const BRepBuilderGeometryId& edgeId, const OdCmEntityColor& edgeColor);

  OdResult setFaceColor(const BRepBuilderGeometryId& faceId, const OdCmEntityColor& faceColor);

  OdRxObjectPtr finish();

  void setTag(const BRepBuilderGeometryId& id, OdUInt32 tag);

  void enableValidator(bool bEnable = true);

  const ValidationErrors* getValidationErrors() const;

  bool isValid() const;

  OdUInt32 getBBSettings() const;

  void setBBSettings(OdUInt32 flag, bool enable);

  OdResult setTransformation(const OdGeMatrix3d& transformation);
 
protected:
  //DOM-IGNORE-BEGIN
  void* m_pImpl;
  //DOM-IGNORE-END
};
 
#include "TD_PackPop.h"
 
#endif //_BREPBUILDER_H_