OdDbSweepOptions Class

Class Hierarchy

Syntax

C++

class OdDbSweepOptions;

File

DbSweepOptions.h

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.

Group

OdDb Classes

Public Methods

	Name	Description
	~OdDbSweepOptions	Destroys the instance of sweep options.
	OdDbSweepOptions	This is the overview for the OdDbSweepOptions constructor overload.

OdDbSweepOptions Enumerations

	Name	Description
	AlignOption	Alignment options enumerator for swept entities.
	MiterOption	Miter options enumerator for swept entities.

OdDbSweepOptions Methods

	Name	Description
	align	Returns the align option.
	alignAngle	Returns the align angle.
	alignStart	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	Returns the bank flag.
	basePoint	Returns the base point for alignment.
	checkIntersections	Returns the check self-intersections flag. If this flag is disabled, a self-intersecting surface may be created.
	checkPathCurve	Determines if the passed-in path curve is valid.
	checkSweepCurve	Determines if the specified sweep entity is valid and returns the planarity of the sweep entity.
	draftAngle	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	Returns the end draft distance. The default value is equal to 0.0.
	getPathEntityTransform	Returns the transformation associated with the start and end of the path curve.
	getSweepEntityTransform	Returns the transformation associated with this entity.
	miterOption	Returns the miter option.
	scaleFactor	Returns the scale factor.
	setAlign	Sets the align option.
	setAlignAngle	Sets the align angle.
	setAlignStart	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.
	setBank	Sets the bank flag.
	setBasePoint	Sets the base point for alignment.
	setCheckIntersections	Sets the check self-intersections flag. If this flag is disabled, a self-intersecting surface may be created.
	setDraftAngle	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.
	setEndDraftDist	Sets the start draft distance. The default value is equal to 0.0.
	setMiterOption	Sets the miter option.
	setPathEntityTransform	This is the overview for the setPathEntityTransform method overload.
	setScaleFactor	Sets the scale factor.
	setStartDraftDist	Sets the start draft distance. The default value is equal to 0.0.
	setSweepEntityTransform	This is the overview for the setSweepEntityTransform method overload.
	setTwistAngle	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.
	setTwistRefVec	Sets the twist vector.
	startDraftDist	Returns the start draft distance. The default value is equal to 0.0.
	twistAngle	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	Returns the twist vector.

OdDbSweepOptions Operators

	Name	Description
	=	Assigning operator for swept entity options.
	==	Compares two OdDbSweepOptions objects, returns true when their values are equal, or false when their values are not equal.

Send feedback about this topic