Package empro :: Module empro :: Module geometry :: Class SweepOptions

Class SweepOptions

core.Updatable --+
                 |
                SweepOptions

Describes the options during a sweeping operation.

Class Hierarchy for SweepOptions

Instance Methods
Inherited from `core.Updatable`: `__enter__`, `__exit__`, `clone`, `hash`, `isValid`, `reasonWhyInvalid`

Properties
	boolType Specifies the boolean operation to be used.
boolNone	cutEndOff Cuts the end of the swept body squarely, with a perpendicular plane to the end of the profile.
boolNone	doubleSided Determines whether the sweep operations are double sided or not.
ExpressionNone	draftAngle The draft angle of the sweep opearation.
ExpressionNone	draftHoleAngle The draft hole angle of the sweep operation.
	draftHoleOption Controls the directionality of the draft applied to a hole.
stringNone	draftLaw The equation of the draft.
	draftOption Controls how drafting will occur.
	draftRepair Controls the behavior when a degeneracy is encountered.
boolNone	enableKeepBranches Option to keep extra branches produced in sweep operations.
ExpressionNone	endDraftDistance The end distance of the draft.
	gapType Controls how gaps are formed.
stringNone	keepLaw The resulting graph of the sweep operation can be defined using a customized law.
boolNone	keepStartFace Determines whether the start face in the sweep operations has to be kept or not.
ExpressionNone	miterAmount The amount of miter.
	miterType Controls how miters are created.
	portion Controls the location of the sweep.
Vector3dNone	portionEnd The portion end of the sweep opearation.
Vector3dNone	portionStart The portion start of the sweep opearation.
list(string)None	railLaws The list of rail laws.
boolNone	rigid Determines whether the sweep operations is rigid or not.
stringNone	scaleLaw The scale law of the sweep operations.
	selfIntersectionTest Determines what to do when a self intersection is encountered.
boolNone	simplify Determines whether simplify is enabled in the sweep operations or not.
boolNone	solid Determines whether create solid is enabled in the sweep operations or not.
ExpressionNone	startDraftDistance The start distance of the draft.
intNone	steps Number of linear divisions in revolve operations.
ExpressionNone	twistAngle The twist angle of the sweep operations.
stringNone	twistLaw The twist law of the sweep operations.

Property Details

boolType

Specifies the boolean operation to be used. 
 Can be one of('Limit','Unite','Intersect','Subtract','KeepBoth'). The default is 'Limit'.
@type: stringNone

cutEndOff

Cuts the end of the swept body squarely, with a perpendicular plane to the end of the profile. Defaults to False.

Type:: boolNone

draftHoleOption

Controls the directionality of the draft applied to a hole. 
 Can be one of('NoDraftHole','WithPeriphery','AgainstPeriphery','ByAngle'). The default is 'AgainstPeriphery'.
@type: stringNone

draftOption

Controls how drafting will occur. 
 Can be one of('NoDraft','DraftAngle','DraftEndDistance','DraftStartDistance','DraftLaw'). The default is 'NoDraft'.
@type: stringNone

draftRepair

Controls the behavior when a degeneracy is encountered. 
 Can be one of('NoRepair','ErrorOnRepair','Degeneracy','FirstDegeneracy','SelfIntersection','FirstSelfIntersection'). The default is 'Degeneracy'.
@type: stringNone

gapType

Controls how gaps are formed. 
 Can be one of('Extended','Rounded','Natural'). The default is 'Natural'.
@type: stringNone

miterType

Controls how miters are created. 
 Can be one of('OldMiter','NewMiter','CrimpMiter','BendMiter'). The default is 'NewMiter'.
@type: stringNone

portion

Controls the location of the sweep. 
 Can be one of('ToProfile','FromProfile','EntirePath','BetweenPoints','SweepOptionsTo','AsIs'). The default is 'EntirePath'.
@type: stringNone

selfIntersectionTest

Determines what to do when a self intersection is encountered. 
 Can be one of('NoCheck','CheckAndWarn','CheckAndError'). The default is 'CheckAndError'.
@type: stringNone