DbSweepOptions.h

Go to the documentation of this file.

 
// Copyright (C) 2002-2022, 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-2022 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 _DbSweepOptions_h_Included_
#define _DbSweepOptions_h_Included_
 
#include "TD_PackPush.h"
#include "DbEntity.h"
 
 
class OdDbSweepOptionsImpl;
 
class DBENT_EXPORT OdDbSweepOptions
{
public:
  OdDbSweepOptions ();
  
  ~OdDbSweepOptions ();
  
  OdDbSweepOptions ( const OdDbSweepOptions& src );
  
  OdDbSweepOptions& operator = ( const OdDbSweepOptions& src );
 
  bool operator == (const OdDbSweepOptions& opt) const;
 
  enum AlignOption 
  {
    kNoAlignment                = 0, // 
    kAlignSweepEntityToPath     = 1, // 
    kTranslateSweepEntityToPath = 2, // 
    kTranslatePathToSweepEntity = 3 // 
  };
 
  enum MiterOption 
  {
    kDefaultMiter = 0,
    kOldMiter     = 1,
    kNewMiter     = 2,
    kCrimpMiter   = 3,
    kBendMiter    = 4
  };
 
  double  draftAngle () const;
 
  void  setDraftAngle ( double ang );
 
  double  startDraftDist () const;
 
  void  setStartDraftDist ( double val );
 
  double  endDraftDist () const;
 
  void  setEndDraftDist ( double val );
 
  double  twistAngle () const;
 
  void  setTwistAngle ( double ang );
 
  double  scaleFactor () const;
 
  void  setScaleFactor ( double val );
 
  double  alignAngle () const;
 
  void  setAlignAngle ( double ang );
 
  OdDbSweepOptions::AlignOption  align () const;
 
  void  setAlign ( OdDbSweepOptions::AlignOption val );
 
  OdDbSweepOptions::MiterOption  miterOption () const;
 
  void  setMiterOption ( OdDbSweepOptions::MiterOption val );
 
  bool  alignStart () const;
 
  void  setAlignStart ( bool val );
 
  OdGePoint3d  basePoint () const;
 
  void  setBasePoint ( const OdGePoint3d& pnt );
 
  bool  bank () const;
 
  void  setBank ( bool val );
 
  bool  checkIntersections () const;
 
  void  setCheckIntersections ( bool val );
 
  OdGeVector3d  twistRefVec () const;
 
  void  setTwistRefVec ( const OdGeVector3d& vec );
 
  bool  getSweepEntityTransform ( OdGeMatrix3d& mat )const;
 
  void  setSweepEntityTransform ( const OdGeMatrix3d& mat ); 
  
  OdResult  setSweepEntityTransform ( OdDbEntityPtrArray& sweepEntities,  bool displayErrorMessages = false );
 
  bool  getPathEntityTransform ( OdGeMatrix3d& mat )const;
 
  void  setPathEntityTransform ( const OdGeMatrix3d& mat ); 
 
  OdResult  setPathEntityTransform ( OdDbEntity *pPathEnt,  bool displayErrorMessages = false );
 
  OdResult  checkSweepCurve ( OdDbEntity *pSweepEnt,
    OdDb::Planarity& planarity, OdGePoint3d& pnt, OdGeVector3d& vec,
    bool& closed, double& approxArcLen, bool displayErrorMessages = false );
 
  OdResult  checkPathCurve ( OdDbEntity *pPathEnt,    bool displayErrorMessages = false );
 
private:
  friend class OdDbSweepOptionsImpl;
  OdDbSweepOptionsImpl *m_pImpl;
};
 
#include "TD_PackPop.h"
#endif //_DbSweepOptions_h_Included_