#include <DbSweepOptions.h>

Public Types
enum	AlignOption { kNoAlignment = 0 , kAlignSweepEntityToPath = 1 , kTranslateSweepEntityToPath = 2 , kTranslatePathToSweepEntity = 3 }

enum	MiterOption { kDefaultMiter = 0 , kOldMiter = 1 , kNewMiter = 2 , kCrimpMiter = 3 , kBendMiter = 4 }

Public Member Functions
	OdDbSweepOptions ()

	~OdDbSweepOptions ()

	OdDbSweepOptions (const OdDbSweepOptions &src)

OdDbSweepOptions &	operator= (const OdDbSweepOptions &src)

bool	operator== (const OdDbSweepOptions &opt) const

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)

Friends
class	OdDbSweepOptionsImpl

Detailed Description

Class for setting options used for creating swept surfaces and swept solids (by calling OdDbSweptSurface::createSweptSurface() or OdDb3dSolid::createSweptSolid() methods). Sweep options are used to control the shape of the resulting surface or solid object.

Definition at line 40 of file DbSweepOptions.h.

Member Enumeration Documentation

◆ AlignOption

enum OdDbSweepOptions::AlignOption

Alignment options enumerator for swept entities.

Enumerator
kNoAlignment
kAlignSweepEntityToPath
kTranslateSweepEntityToPath
kTranslatePathToSweepEntity

Definition at line 78 of file DbSweepOptions.h.

◆ MiterOption

enum OdDbSweepOptions::MiterOption

Miter options enumerator for swept entities.

Enumerator
kDefaultMiter
kOldMiter
kNewMiter
kCrimpMiter
kBendMiter

Definition at line 89 of file DbSweepOptions.h.

Constructor & Destructor Documentation

◆ OdDbSweepOptions() [1/2]

OdDbSweepOptions::OdDbSweepOptions ( )

Creates an instance of sweep options.

◆ ~OdDbSweepOptions()

OdDbSweepOptions::~OdDbSweepOptions ( )

Destroys the instance of sweep options.

◆ OdDbSweepOptions() [2/2]

OdDbSweepOptions::OdDbSweepOptions ( const OdDbSweepOptions & src )

Creates a copy of another instance of swept entity options (copy constructor).

Parameters

src	[in] An instance of swept entity options to be copied.

Member Function Documentation

◆ align()

OdDbSweepOptions::AlignOption OdDbSweepOptions::align ( ) const

Returns the align option.

◆ alignAngle()

double OdDbSweepOptions::alignAngle ( ) const

Returns the align angle.

◆ alignStart()

bool OdDbSweepOptions::alignStart ( ) const

Returns the align to start option.

If the option value is equal to true, alignment to the start of the curve is applied. If the option value is equal to false, alignment to the end of the curve is applied.

◆ bank()

bool OdDbSweepOptions::bank ( ) const

Returns the bank flag.

◆ basePoint()

OdGePoint3d OdDbSweepOptions::basePoint ( ) const

Returns the base point for alignment.

◆ checkIntersections()

bool OdDbSweepOptions::checkIntersections ( ) const

Returns the check self-intersections flag. If this flag is disabled, a self-intersecting surface may be created.

◆ checkPathCurve()

OdResult OdDbSweepOptions::checkPathCurve	(	OdDbEntity *	pPathEnt,
		bool	displayErrorMessages = `false`
	)

Determines if the passed-in path curve is valid.

Parameters

pPathEnt	[in] A pointer to the path curve.
displayErrorMessages	[in] Indicates whether error messages are displayed. Default value is false.

Returns: Returns eOk if curve is valid or eInvalidInput otherwise.

◆ checkSweepCurve()

OdResult OdDbSweepOptions::checkSweepCurve	(	OdDbEntity *	pSweepEnt,
		OdDb::Planarity &	planarity,
		OdGePoint3d &	pnt,
		OdGeVector3d &	vec,
		bool &	closed,
		double &	approxArcLen,
		bool	displayErrorMessages = `false`
	)

Determines if the specified sweep entity is valid and returns the planarity of the sweep entity.

Parameters

pSweepEnt	[in] A pointer to the curve, region, or planar surface to be swept.
planarity	[out] A passed-in parameter for returning the planarity flag of the entity.
pnt	[out] A passed-in parameter for returning the point on the sweep entity if planarity is kPlanar, or a point on the line if planarity is kLinear.
vec	[out] A passed-in parameter for returning the normal vector of the entity if planarity is kPlanar, or the line direction if planarity is kLinear.
closed	[out] A passed-in parameter for returning the closed flag determining whether an entity to be swept is a closed entity.
approxArcLen	[out] A passed-in parameter for returning the approximate arc length.
displayErrorMessages	[in] Indicates whether error messages are displayed. Default value is false.

Returns: If kPlanar is returned, then pnt and vec will specify the normal plane of the entity. If kLinear is returned, then pnt and vec will specify a defining point and direction of the sweep entity.

◆ draftAngle()

double OdDbSweepOptions::draftAngle ( ) const

Returns the draft angle (in radians). The draft angle is the angle by which the profile will taper as it is swept. The default value is equal to 0.0.

◆ endDraftDist()

double OdDbSweepOptions::endDraftDist ( ) const

Returns the end draft distance. The default value is equal to 0.0.

◆ getPathEntityTransform()

bool OdDbSweepOptions::getPathEntityTransform ( OdGeMatrix3d & mat ) const

Returns the transformation associated with the start and end of the path curve.

Parameters

mat	[in] A passed-in parameter for returning the transformation matrix of the path curve.

Returns: Returns true if the transformation matrix was successfully returned, otherwise returns false.

◆ getSweepEntityTransform()

bool OdDbSweepOptions::getSweepEntityTransform ( OdGeMatrix3d & mat ) const

Returns the transformation associated with this entity.

Parameters

mat	[out] A passed-in parameter for returning the transformation matrix.

◆ miterOption()

OdDbSweepOptions::MiterOption OdDbSweepOptions::miterOption ( ) const

Returns the miter option.

◆ operator=()

OdDbSweepOptions & OdDbSweepOptions::operator= ( const OdDbSweepOptions & src )

Assigning operator for swept entity options.

Parameters

src	[in] An instance of swept entity options to be assigned to this instance.

◆ operator==()

bool OdDbSweepOptions::operator== ( const OdDbSweepOptions & opt ) const

Compares two OdDbSweepOptions objects, returns true when their values are equal, or false when their values are not equal.

Parameters

opt	[in] Another OdDbSweepOptions object to compare.

◆ scaleFactor()

double OdDbSweepOptions::scaleFactor ( ) const

Returns the scale factor.

◆ setAlign()

void OdDbSweepOptions::setAlign ( OdDbSweepOptions::AlignOption val )

Sets the align option.

Parameters

val	[in] A new value for the align option.

◆ setAlignAngle()

void OdDbSweepOptions::setAlignAngle ( double ang )

Sets the align angle.

Parameters

ang	[in] A new value of the align angle.

◆ setAlignStart()

void OdDbSweepOptions::setAlignStart ( bool val )

Sets the align to start option.

If the option value is equal to true, alignment to the start of the curve is applied. If the option value is equal to false, alignment to the end of the curve is applied.

Parameters

val	[in] A new value of the align to start option.

◆ setBank()

void OdDbSweepOptions::setBank ( bool val )

Sets the bank flag.

Parameters

val	[in] A new value for the bank flag.

◆ setBasePoint()

void OdDbSweepOptions::setBasePoint ( const OdGePoint3d & pnt )

Sets the base point for alignment.

Parameters

pnt	[in] A new base point for alignment.

◆ setCheckIntersections()

void OdDbSweepOptions::setCheckIntersections ( bool val )

Sets the check self-intersections flag.

  If this flag is disabled, a self-intersecting surface may be created.

Parameters

val	[in] A new value of the check self-intersections flag.

◆ setDraftAngle()

void OdDbSweepOptions::setDraftAngle ( double ang )

Sets the draft angle.

The draft angle is the angle by which the profile will taper as it is swept. The default value is equal to 0.0.

Parameters

ang	[in] A new draft angle (in radians).

◆ setEndDraftDist()

void OdDbSweepOptions::setEndDraftDist ( double val )

Sets the start draft distance. The default value is equal to 0.0.

Parameters

val	[in] A new value of the end draft distance.

◆ setMiterOption()

void OdDbSweepOptions::setMiterOption ( OdDbSweepOptions::MiterOption val )

Sets the miter option.

Parameters

val	[in] A new value for the miter option.

◆ setPathEntityTransform() [1/2]

void OdDbSweepOptions::setPathEntityTransform ( const OdGeMatrix3d & mat )

Sets the transformation associated with the start and end of the path curve.

Parameters

mat	[in] A new transformation matrix to be applied.

◆ setPathEntityTransform() [2/2]

OdResult OdDbSweepOptions::setPathEntityTransform	(	OdDbEntity *	pPathEnt,
		bool	displayErrorMessages = `false`
	)

Sets the transformation associated with the start and end of the path curve.

Parameters

pPathEnt	[in] A pointer to the new transformation matrix to be applied.
displayErrorMessages	[in] Indicates whether error messages are displayed. Default value is false.

Remarks: Before calling the method, setSweepEntityTranform() method must be called.

◆ setScaleFactor()

void OdDbSweepOptions::setScaleFactor ( double val )

Sets the scale factor.

  \param val [in] A new value of the scale factor.

◆ setStartDraftDist()

void OdDbSweepOptions::setStartDraftDist ( double val )

Sets the start draft distance. The default value is equal to 0.0.

Parameters

val	[in] A new value of the start draft distance.

◆ setSweepEntityTransform() [1/2]

void OdDbSweepOptions::setSweepEntityTransform ( const OdGeMatrix3d & mat )

Sets the transformation associated with this entity.

Parameters

mat	[in] A new transformation to be associated with the entity.

◆ setSweepEntityTransform() [2/2]

OdResult OdDbSweepOptions::setSweepEntityTransform	(	OdDbEntityPtrArray &	sweepEntities,
		bool	displayErrorMessages = `false`
	)

Sets the coordinate system transformation matrix to be applied to the sweep entity, using the sweep entity geometry for calculating the transformation matrix.

Parameters

sweepEntities	[out] Sweep entity geometry to be used for calculation of the sweep entity transformation matrix.
displayErrorMessages	[in] Indicates whether error messages are displayed. Default value is false.

Returns: Returns eOk if transformation was successfully done.

◆ setTwistAngle()

void OdDbSweepOptions::setTwistAngle ( double ang )

Sets the twist angle.

Twist angle is the angle by which the profile will be twisted as it is swept. The default value is equal to 0.0.

Parameters

ang	[in] A new twist angle (in radians).

◆ setTwistRefVec()

void OdDbSweepOptions::setTwistRefVec ( const OdGeVector3d & vec )

Sets the twist vector.

Parameters

vec	[in] A new twist vector.

◆ startDraftDist()

double OdDbSweepOptions::startDraftDist ( ) const

Returns the start draft distance. The default value is equal to 0.0.

◆ twistAngle()

double OdDbSweepOptions::twistAngle ( ) const

Returns the twist angle in radians. Twist angle is the angle by which the profile will be twisted as it is swept. The default value is equal to 0.0.

◆ twistRefVec()

OdGeVector3d OdDbSweepOptions::twistRefVec ( ) const

Returns the twist vector.

Friends And Related Function Documentation

◆ OdDbSweepOptionsImpl

friend class OdDbSweepOptionsImpl

friend

Definition at line 358 of file DbSweepOptions.h.

The documentation for this class was generated from the following file:

DbSweepOptions.h

Public Types

Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ AlignOption

◆ MiterOption

Constructor & Destructor Documentation

◆ OdDbSweepOptions() [1/2]

◆ ~OdDbSweepOptions()

◆ OdDbSweepOptions() [2/2]

Member Function Documentation

◆ align()

◆ alignAngle()

◆ alignStart()

◆ bank()

◆ basePoint()

◆ checkIntersections()

◆ checkPathCurve()

◆ checkSweepCurve()

◆ draftAngle()

◆ endDraftDist()

◆ getPathEntityTransform()

◆ getSweepEntityTransform()

◆ miterOption()

◆ operator=()

◆ operator==()

◆ scaleFactor()

◆ setAlign()

◆ setAlignAngle()

◆ setAlignStart()

◆ setBank()

◆ setBasePoint()

◆ setCheckIntersections()

◆ setDraftAngle()

◆ setEndDraftDist()

◆ setMiterOption()

◆ setPathEntityTransform() [1/2]

◆ setPathEntityTransform() [2/2]

◆ setScaleFactor()

◆ setStartDraftDist()

◆ setSweepEntityTransform() [1/2]

◆ setSweepEntityTransform() [2/2]

◆ setTwistAngle()

◆ setTwistRefVec()

◆ startDraftDist()

◆ twistAngle()

◆ twistRefVec()

Friends And Related Function Documentation

◆ OdDbSweepOptionsImpl