Sketcher

Sketcher commands are used to define the entities, such as the geometry, constraints, and dimensions, to create a sketch and to store the values and attributes associated with a particular sketch.

Create constrained sketches

class SketchModel(name, description='', stefanBoltzmann=None, absoluteZero=None, waveFormulation=abaqusConstants.NOT_SET, modelType=abaqusConstants.STANDARD_EXPLICIT, universalGas=None, copyConstraints=ON, copyConnectors=ON, copyInteractions=ON)

Abaqus creates a Model object named Model-1 when a session is started.

Note

This object can be accessed by:

mdb.models[name]

Note

Check SketchModel on help.3ds.com/0.1..

Public Data Attributes:

Inherited from ModelBase

name	A String specifying the repository key.
stefanBoltzmann	None or a Float specifying the Stefan-Boltzmann constant.
absoluteZero	None or a Float specifying the absolute zero constant.
waveFormulation	A SymbolicConstant specifying the type of incident wave formulation to be used in acoustic problems.
universalGas	None or a Float specifying the universal gas constant.
noPartsInputFile	A Boolean specifying whether an input file should be written without parts and assemblies.
restartIncrement	An Int specifying the increment, interval, iteration or cycle where the restart analysis will start.
endRestartStep	A Boolean specifying that the step specified by restartStep should be terminated at the increment specified by restartIncrement.
shellToSolid	A Boolean specifying that a shell global model drives a solid submodel.
lastChangedCount	A Float specifying the time stamp that indicates when the model was last changed.
description	A String specifying the purpose and contents of the Model object.
restartJob	A String specifying the name of the job that generated the restart data.
restartStep	A String specifying the name of the step where the restart analysis will start.
globalJob	A String specifying the name of the job that generated the results for the global model.
copyConstraints	A boolean specifying the status of constraints created in a model, in the model which instances this model.
copyConnectors	A boolean specifying the status of connectors created in a model, in the model which instances this model.
copyInteractions	A boolean specifying the status of interactions created in a model, in the model which instances this model.
keywordBlock	A KeywordBlock object.
rootAssembly	An Assembly object.
amplitudes	A repository of Amplitude objects.
profiles	A repository of Profile objects.
boundaryConditions	A repository of BoundaryCondition objects.
constraints	A repository of ConstrainedSketchConstraint objects.
analyticalFields	A repository of AnalyticalField objects.
discreteFields	A repository of DiscreteField objects.
predefinedFields	A repository of PredefinedField objects.
interactions	A repository of Interaction objects.
interactionProperties	A repository of InteractionProperty objects.
contactControls	A repository of ContactControl objects.
contactInitializations	A repository of ContactInitialization objects.
contactStabilizations	A repository of ContactStabilization objects.
linkedInstances	A tuple of tuples of Strings specifying the linked child PartInstance name in the current model to the corresponding parent PartInstance name in a different model.
linkedParts	A tuple of tuples of Strings specifying the linked child Part name in the current model to the corresponding parent Part name in a different model.
loads	A repository of Load objects.
materials	A repository of Material objects.
calibrations	A repository of Calibration objects.
sections	A repository of Section objects.
remeshingRules	A repository of RemeshingRule objects.
sketches	A repository of ConstrainedSketch objects.
parts	A repository of Part objects.
steps	A repository of Step objects.
featureOptions	A FeatureOptions object.
adaptiveMeshConstraints	A repository of AdaptiveMeshConstraint objects.
adaptiveMeshControls	A repository of AdaptiveMeshControl objects.
timePoints	A repository of TimePoint objects.
filters	A repository of Filter objects.
integratedOutputSections	A repository of IntegratedOutputSection objects.
fieldOutputRequests	A repository of FieldOutputRequest objects.
historyOutputRequests	A repository of HistoryOutputRequest objects.
optimizationTasks	A repository of OptimizationTask objects.
tableCollections	A repository of TableCollection objects.
eventSeriesTypes	A repository of EventSeriesType objects.
eventSeriesDatas	A repository of EventSeriesData objects.

Public Methods:

ConstrainedSketch(name, sheetSize[, ...])

This method creates a ConstrainedSketch object.

Inherited from ModelBase

__init__(name[, description, ...])	This method creates a Model object.
ModelFromInputFile(name, inputFileName)	This method creates a Model object by reading the keywords in an input file and creating the corresponding Abaqus/CAE objects.
ModelFromOdbFile(name, odbFileName)	This method creates a Model object by reading an output database and creating any corresponding Abaqus/CAE objects.
ModelFromNastranFile(modelName, inputFileName)	This method creates a Model object by reading the keywords in a Nastran bulk data file or Nastran input file and creating any corresponding Abaqus/CAE objects.
setValues([description, noPartsInputFile, ...])	This method modifies the Model object.

---

ConstrainedSketch(name, sheetSize, gridSpacing=None, transform=())

This method creates a ConstrainedSketch object. If the sketch cannot be created, the method returns None.

Note

This function can be accessed by:

mdb.models[name].ConstrainedSketch

Note

Check ConstrainedSketch on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the repository key.

• sheetSize (float) – A Float specifying the sheet size.

• gridSpacing (Optional[float], default: None) – A Float specifying the spacing between gridlines. Possible values are Floats >> 0. The default value is approximately 2 percent of sheetSize.

• transform (tuple, default: ()) – A sequence of sequences of Floats specifying the three-dimensional orientation of the sketch. The sequence is a 3 × 4 transformation matrix specifying the axis of rotation and the translation vector. Possible values are any Floats.The default value for the axis of rotation is the identity matrix`(1.0, 0.0, 0.0), (0.0, 1.0, 0.0), (0.0, 0.0, 1.0)`The default value for the translation vector is`(0.0, 0.0, 0.0)`The default values position the sketch on the X - Y plane centered at the origin.

Returns:

sketch – A ConstrainedSketch object.

Return type:

ConstrainedSketch

Object features

ConstrainedSketch

class ConstrainedSketch(name: str, sheetSize: float, gridSpacing: Optional[float] = None, transform: tuple = ())

class ConstrainedSketch(name: str, objectToCopy: ConstrainedSketch)

Public Data Attributes:

Inherited from ConstrainedSketchBase

constraints	A repository of ConstrainedSketchConstraint objects.
dimensions	A repository of ConstrainedSketchDimension objects.
geometry	A ConstrainedSketchGeometryArray object specifying the sketch geometry, such as lines, arcs, circles, and splines.
parameters	A repository of ConstrainedSketchParameter objects specifying sketch parameters, which may be associated with dimensions.
sketchOptions	A ConstrainedSketchOptions object specifying the sketch option settings.
vertices	A ConstrainedSketchVertexArray object.
imageOptions	A ConstrainedSketchImageOptions object.

Public Methods:

__init__())
ConstrainedSketchFromGeometryFile(name, ...)	This method creates a ConstrainedSketch object and places it in the sketches repository.
print()	This method prints the following statistics about a sketch: - The sketch Id (a positive integer).
assignCenterline(line)	This method indicates the construction line that will be used as a centerline for revolved features.
assignCenterOfTwist(point)	This method indicates the isolated point that will be used as the center of twist when an extruded feature is created with twist.
autoDimension(objectList)	This method applies dimensions to the selected ConstrainedSketchGeometry objects in an effort to make the ConstrainedSketch well defined.
autoTrimCurve(curve1, point1, parameter1)	This method automatically trims a selected ConstrainedSketchGeometry object at the specified location.
breakCurve(curve1, point1, curve2, point2)	This method breaks a specified ConstrainedSketchGeometry object (curve1) using another specified ConstrainedSketchGeometry object (curve2).
copyMirror(mirrorLine, objectList)	This method creates copies of the given ConstrainedSketchGeometry objects, mirrors them about a selected line, and inserts them into the appropriate repositories of the ConstrainedSketch object.
copyMove(vector, objectList)	This method creates copies of the given ConstrainedSketchGeometry objects, moves them from their original position, and inserts them into the appropriate repositories of the ConstrainedSketch object.
copyRotate(centerPoint, angle, objectList)	This method creates copies of the given ConstrainedSketchGeometry objects, rotates them, and inserts them into the appropriate repositories of the ConstrainedSketch object.
copyScale(scaleValue, scaleCenter, objectList)	This method creates copies of the given ConstrainedSketchGeometry objects, scales them by the specified value about a selected point, and inserts them into the appropriate repositories of the ConstrainedSketch object.
delete(objectList)	This method deletes the given ConstrainedSketchGeometry, ConstrainedSketchDimension, or ConstrainedSketchConstraint objects.
deleteParameter(name)	The command deletes a specified parameter.
dragEntity(entity, points)	This method drags a specified ConstrainedSketchGeometry or ConstrainedSketchVertex object to a specific location.
linearPattern(number1, spacing1, angle1[, ...])	This method copies ConstrainedSketchGeometry objects in a linear pattern along one or two directions.
mergeVertices(value, vertexList)	This method merges the ConstrainedSketchVertex objects that lie within the specified distance of each other.
move(vector, objectList)	This method translates the given ConstrainedSketchGeometry objects by the given vector.
offset(distance, objectList, side[, ...])	This method creates copies of the selected ConstrainedSketchGeometry objects, offsets them by the specified distance in the specified direction, and inserts them into the ConstrainedSketch object's appropriate repositories.
radialPattern(number, totalAngle, centerPoint)	This method copies ConstrainedSketchGeometry objects in a radial pattern about a specified center point.
resetView()	This method resets the view to be perpendicular to the sketching plane.
rectangle(point1, point2)	This method creates four lines that form a rectangle with diagonal corners defined by the given points and inserts them into the geometry repository of the ConstrainedSketch object.
removeGapsAndOverlaps(tolerance, geomList)	This method removes gaps and overlaps between sketch geometries specified by the user.
repairShortEdges(geomList[, tolerance])	This method deletes the short edges specified, optionally selecting only those short edges whose lengths are smaller than the specified tolerance and healing the resultant gap in the sketch.
retrieveSketch(sketch)	This method copies all ConstrainedSketchGeometry, ConstrainedSketchDimension, ConstrainedSketchConstraint, and ConstrainedSketchParameter objects from the specified ConstrainedSketch object.
rotate(centerPoint, angle, objectList)	This method rotates the given ConstrainedSketchGeometry objects by the given angle and about the given point.
scale(scaleValue, scaleCenter, objectList)	This method scales the given ConstrainedSketchGeometry objects by the given scale factor and about the given point.
setPrimaryObject(option)	This method makes the ConstrainedSketch object the primary object in the current viewport.
trimExtendCurve(curve1, point1, curve2, point2)	This method trims or extends a specified ConstrainedSketchGeometry object (curve1) using another specified ConstrainedSketchGeometry object (curve2).
undo()	This method undoes the effects of the last ConstrainedSketch object method.
unsetPrimaryObject()	This method removes the ConstrainedSketch object from the current viewport, reversing the effects of the setPrimaryobject command.
writeAcisFile(fileName[, version])	This method exports the geometry of the sketch to a named file in ACIS format.
writeIgesFile(filename[, flavor])	This method exports the geometry of the sketch to a named file in IGES format.

Inherited from ConstrainedSketchConstraintModel

CoincidentConstraint(entity1, entity2)	This method creates a coincident constraint.
ConcentricConstraint(entity1, entity2)	This method creates a concentric constraint.
EqualLengthConstraint(entity1, entity2)	This method creates an equal length constraint.
EqualRadiusConstraint(entity1, entity2)	This method creates an equal radius constraint.
FixedConstraint(entity)	This method creates a fixed constraint.
HorizontalConstraint(entity)	This method creates a horizontal constraint.
VerticalConstraint(entity)	This method creates a vertical constraint.
ParallelConstraint(entity1, entity2)	This method creates a parallel constraint.
PerpendicularConstraint(entity1, entity2)	This method creates a perpendicular constraint.
EqualDistanceConstraint(entity1, entity2, ...)	This method creates an equal distance constraint.
TangentConstraint(entity1, entity2)	This method creates a tangent constraint.

Inherited from ConstrainedSketchDimensionModel

AngularDimension(line1, line2, textPoint[, ...])	This method constructs a ConstrainedSketchDimension object between two ConstrainedSketchGeometry objects, with the given angle between them.
HorizontalDimension(vertex1, vertex2, textPoint)	This method constructs a ConstrainedSketchDimension object between two vertices.
ObliqueDimension(vertex1, vertex2, textPoint)	This method constructs a ConstrainedSketchDimension object between two vertices.
RadialDimension(curve, textPoint[, value, ...])	This method constructs a ConstrainedSketchDimension object on a circular or elliptical arc.
VerticalDimension(vertex1, vertex2, textPoint)	This method constructs a ConstrainedSketchDimension between two vertices.
DistanceDimension(entity1, entity2, textPoint)	This method constructs a ConstrainedSketchDimension object between two ConstrainedSketchGeometry, or aConstrainedSketchVertex and ConstrainedSketchGeometry object.

Inherited from ConstrainedSketchGeometryModel

Arc3Points(point1, point2, point3)	This method constructs an arc using a two endpoints and an intermediate third point on the arc.
ArcByCenterEnds(center, point1, point2, ...)	This method constructs an arc using a center point and two vertices.
ArcByStartEndTangent(point1, point2, vector)	This method constructs an arc using two vertices.
CircleByCenterPerimeter(center, point1)	This method constructs a circle using a center point and a point on the perimeter.
ConstructionCircleByCenterPerimeter(center, ...)	This method constructs a construction circle using a center point and a point on the perimeter.
EllipseByCenterPerimeter(center, axisPoint1, ...)	This method constructs an ellipse using a center point, a major axis point, and a minor axis point.
FilletByRadius(radius, curve1, nearPoint1, ...)	This method constructs a fillet arc of a given radius between two curves.
Line(point1, point2)	This method creates a line between two given points.
ConstructionLine(point1, point2)	This method creates an oblique construction line that runs between two given points.
Spline(points[, constrainPoints])	This method creates a spline curve running through a sequence of points.
Spot(point)	This method creates a spot construction point located at the specified coordinates.
getVertices()	This method returns an list of ConstrainedSketchVertex objects which are a part of the given ConstrainedSketchGeometry object.
getSize()	This method returns the length of the given ConstrainedSketchGeometry object.
getPointAtDistance(point, distance[, percentage])	This method returns a point offset along the given ConstrainedSketchGeometry from the given end by a specified arc length distance or a percentage of the total length of the ConstrainedSketchGeometry object.

Inherited from ConstrainedSketchParameterModel

ConstrainedSketchParameter(name[, path, ...])

This method creates a parameter and optionally associates a dimension with this parameter.

Inherited from ConstrainedSketchVertexModel

Spot(point)

This method creates a spot construction point located at the specified coordinates.

---

AngularDimension(line1, line2, textPoint, value=None, reference=OFF)

This method constructs a ConstrainedSketchDimension object between two ConstrainedSketchGeometry objects, with the given angle between them.

Note

This function can be accessed by:

mdb.models[name].sketches[name].AngularDimension

Note

Check AngularDimension on help.3ds.com/0.1..

Parameters:

• line1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first line.

• line2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second line.

• textPoint (Tuple[float, ...]) – A pair of Floats specifying the location of the dimension text.

• value (Optional[float], default: None) – A Float specifying the angle between the two lines.

• reference (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the created dimension enforces the above value or if it simply measures the angle between two lines.

Returns:

A ConstrainedSketchDimension object

Return type:

dimension

Arc3Points(point1, point2, point3)

This method constructs an arc using a two endpoints and an intermediate third point on the arc.

Note

This function can be accessed by:

mdb.models[name].sketches[name].Arc3Points

Note

Check Arc3Points on help.3ds.com/0.1..

Parameters:

• point1 (Tuple[float, ...]) – A pair of Floats specifying the first endpoint of the arc.

• point2 (Tuple[float, ...]) – A pair of Floats specifying the second endpoint of the arc.

• point3 (Tuple[float, ...]) – A pair of Floats specifying the third point on the arc.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

ArcByCenterEnds(center, point1, point2, direction)

This method constructs an arc using a center point and two vertices. The Arc object is added to the geometry repository of the ConstrainedSketch object. The arc is created in a clockwise fashion from point1 to point2.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ArcByCenterEnds

Note

Check ArcByCenterEnds on help.3ds.com/0.1..

Parameters:

• center (Tuple[float, ...]) – A pair of Floats specifying the center point of the arc.

• point1 (Tuple[float, ...]) – A pair of Floats specifying the first endpoint of the arc.

• point2 (Tuple[float, ...]) – A pair of Floats specifying the second endpoint of the arc.

• direction (SymbolicConstant) – A SymbolicConstant specifying the direction of the arc. Possible values are CLOCKWISE and COUNTERCLOCKWISE.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

:raises If incompatible data are given`, :class:`the second endpoint is ignored:

ArcByStartEndTangent(point1, point2, vector)

This method constructs an arc using two vertices. The Arc object is added to the geometry repository of the ConstrainedSketch object.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ArcByStartEndTangent

Note

Check ArcByStartEndTangent on help.3ds.com/0.1..

Parameters:

• point1 (Tuple[float, ...]) – A pair of Floats specifying the first endpoint of the arc.

• point2 (Tuple[float, ...]) – A pair of Floats specifying the second endpoint of the arc.

• vector (tuple) – A sequence of two Floats specifying the start direction for constructing the arc.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

CircleByCenterPerimeter(center, point1)

This method constructs a circle using a center point and a point on the perimeter. The circle is added to the geometry repository of the ConstrainedSketch object.

Note

This function can be accessed by:

mdb.models[name].sketches[name].CircleByCenterPerimeter

Note

Check CircleByCenterPerimeter on help.3ds.com/0.1..

Parameters:

• center (Tuple[float, ...]) – A pair of Floats specifying the center point of the circle.

• point1 (Tuple[float, ...]) – A pair of Floats specifying a point on the perimeter of the circle.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

CoincidentConstraint(entity1, entity2)

This method creates a coincident constraint. This constraint applies to two vertices, to a vertex and a ConstrainedSketchGeometry object, or to two ConstrainedSketchGeometry objects of the same type and constrains them to be coincident.

Note

This function can be accessed by:

mdb.models[name].sketches[name].CoincidentConstraint

Note

Check CoincidentConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object or a ConstrainedSketchVertex object specifying the first object.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object or a ConstrainedSketchVertex object specifying the second object.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

ConcentricConstraint(entity1, entity2)

This method creates a concentric constraint. This constraint applies to any combination of circles, arcs, ellipses, and points and constrains them to be concentric. A concentric constraint implies that the center of ConstrainedSketchGeometry objects coincide.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ConcentricConstraint

Note

Check ConcentricConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first arc, circle, ellipse, or sketch vertex.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second arc, circle, ellipse, or sketch vertex.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

ConstrainedSketchFromGeometryFile(name, geometryFile)

This method creates a ConstrainedSketch object and places it in the sketches repository.

Note

This function can be accessed by:

mdb.models[name].ConstrainedSketchFromGeometryFile

Parameters:

• name (str) – A String specifying the repository key.

• geometryFile (AcisFile) – An AcisFile object specifying a file containing geometry. The geometry in the file is converted to two-dimensional sketch geometry in the X - Y plane.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

ConstrainedSketchParameter(name, path='', expression='', previousParameter='')

This method creates a parameter and optionally associates a dimension with this parameter.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ConstrainedSketchParameter

Note

Check ConstrainedSketchParameter on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the name of the ConstrainedSketchParameter object. No two parameters in the same ConstrainedSketch can have the same name.

• path (str, default: '') – A String specifying the ConstrainedSketchDimension object with which this parameter is associated.

• expression (str, default: '') – A String specifying the expression or value associated with the ConstrainedSketchParameter.

• previousParameter (str, default: '') – A String specifying the name of the previous ConstrainedSketchParameter, if it exists. The previousParameter argument implies an order among the parameters. No two parameters can reference the same parameter as the previous parameter.

Returns:

obj – A ConstrainedSketchParameter object

Return type:

ConstrainedSketchParameter

ConstructionCircleByCenterPerimeter(center, point1)

This method constructs a construction circle using a center point and a point on the perimeter. The circle is added to the geometry repository of the ConstrainedSketch object.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ConstructionCircleByCenterPerimeter

Note

Check ConstructionCircleByCenterPerimeter on help.3ds.com/0.1..

Parameters:

• center (Tuple[float, ...]) – A pair of Floats specifying the center point of the construction circle.

• point1 (Tuple[float, ...]) – A pair of Floats specifying a point on the perimeter of the construction circle.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

ConstructionLine(point1, point2)

This method creates an oblique construction line that runs between two given points.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ConstructionLine

Note

Check ConstructionLine on help.3ds.com/0.1..

Parameters:

• point1 (Tuple[float, ...]) – A pair of Floats specifying the first endpoint.

• point2 (Tuple[float, ...]) – A pair of Floats specifying the second endpoint.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

DistanceDimension(entity1, entity2, textPoint, value=None, reference=OFF)

This method constructs a ConstrainedSketchDimension object between two ConstrainedSketchGeometry, or aConstrainedSketchVertex and ConstrainedSketchGeometry object. A distance dimension specifies the shortest distance between two entities.

Note

This function can be accessed by:

mdb.models[name].sketches[name].DistanceDimension

Note

Check DistanceDimension on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object or ConstrainedSketchGeometry object.

• entity2 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object or ConstrainedSketchGeometry object.

• textPoint (Tuple[float, ...]) – A pair of Floats specifying the location of the dimension text.

• value (Optional[float], default: None) – A Float specifying the angle between the two lines.

• reference (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the created dimension enforces the above value or if it simply measures the angle between two lines.

Returns:

A ConstrainedSketchDimension object

Return type:

dimension

EllipseByCenterPerimeter(center, axisPoint1, axisPoint2)

This method constructs an ellipse using a center point, a major axis point, and a minor axis point. The ellipse is added to the geometry repository of the ConstrainedSketch object.

Note

This function can be accessed by:

mdb.models[name].sketches[name].EllipseByCenterPerimeter

Note

Check EllipseByCenterPerimeter on help.3ds.com/0.1..

Parameters:

• center (Tuple[float, ...]) – A pair of Floats specifying the center point of the ellipse.

• axisPoint1 (Tuple[float, ...]) – A pair of Floats specifying the major or minor axis point of the ellipse.

• axisPoint2 (Tuple[float, ...]) – A pair of Floats specifying the minor or major axis point of the ellipse.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

EqualDistanceConstraint(entity1, entity2, midpoint)

This method creates an equal distance constraint. This constraint can be applied between a midpoint ConstrainedSketchVertex object and any other two ConstrainedSketchVertex objects or between a midpoint ConstrainedSketchVertex object and two ConstrainedSketchGeometry objects that are lines. The equal distance constraint forces the midpoint vertex to remain at an equal distance from the two other vertices or lines.

Note

This function can be accessed by:

mdb.models[name].sketches[name].EqualDistanceConstraint

Note

Check EqualDistanceConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (str) – AConstrainedSketchGeometry object specifying the first line or ConstrainedSketchVertex object.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second line or ConstrainedSketchVertex object.

• midpoint (Vertex) – A ConstrainedSketchVertex object specifying the vertex that will be positioned an equal distance from entity1 and entity2.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

EqualLengthConstraint(entity1, entity2)

This method creates an equal length constraint. This constraint applies to lines and constrains them such that their lengths are equal.

Note

This function can be accessed by:

mdb.models[name].sketches[name].EqualLengthConstraint

Note

Check EqualLengthConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first line.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second line.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

EqualRadiusConstraint(entity1, entity2)

This method creates an equal radius constraint. This constraint applies to circles and arcs and constrains them such that their radii are equal.

Note

This function can be accessed by:

mdb.models[name].sketches[name].EqualRadiusConstraint

Note

Check EqualRadiusConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first arc or circle.

• entity2 (str) – A ConstrainedSketchGeometry specifying the second arc or circle.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

FilletByRadius(radius, curve1, nearPoint1, curve2, nearPoint2)

This method constructs a fillet arc of a given radius between two curves. The fillet is added to the geometry repository of the ConstrainedSketch object.

Note

This function can be accessed by:

mdb.models[name].sketches[name].FilletByRadius

Note

Check FilletByRadius on help.3ds.com/0.1..

Parameters:

• radius (float) – A Float specifying the radius of the fillet arc. Possible values are Floats > 0.

• curve1 (ConstrainedSketchGeometryModel) – A ConstrainedSketchGeometry object specifying the first curve.

• nearPoint1 (Tuple[float, ...]) – A pair of Floats specifying a point on the sketch near where the user wishes the fillet to intersect with curve1. This point does not need to be on*curve1*; it is used as a hint to draw the fillet.

• curve2 (ConstrainedSketchGeometryModel) – A ConstrainedSketchGeometry object specifying the second curve.

• nearPoint2 (Tuple[float, ...]) – A pair of Floats specifying a point on the sketch near where the user wishes the fillet to intersect with curve2. This point does not need to be on curve2; it is used as a hint to draw the fillet.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

Raises:

Range Error` – :class:`cannot construct the Fillet specified: If the radius given cannot be used to create a fillet between the two curves given.

FixedConstraint(entity)

This method creates a fixed constraint. This constraint applies to a ConstrainedSketchGeometry object or a ConstrainedSketchVertex object and constrains them to be fixed in space. Both the location and the shape of the sketch geometry is fixed.

Note

This function can be accessed by:

mdb.models[name].sketches[name].FixedConstraint

Note

Check FixedConstraint on help.3ds.com/0.1..

Parameters:

entity (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object or a ConstrainedSketchVertex object specifying the item to fix in space.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

HorizontalConstraint(entity)

This method creates a horizontal constraint. This constraint applies to a line and constrains it to be horizontal.

Note

This function can be accessed by:

mdb.models[name].sketches[name].HorizontalConstraint

Note

Check HorizontalConstraint on help.3ds.com/0.1..

Parameters:

entity (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the line to constrain.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

HorizontalDimension(vertex1, vertex2, textPoint, value=None, reference=OFF)

This method constructs a ConstrainedSketchDimension object between two vertices. A horizontal dimension indicates the horizontal distance along the X-axis between two vertices.

Note

This function can be accessed by:

mdb.models[name].sketches[name].HorizontalDimension

Note

Check HorizontalDimension on help.3ds.com/0.1..

Parameters:

• vertex1 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object specifying the first endpoint.

• vertex2 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object specifying the second endpoint.

• textPoint (Tuple[float, ...]) – A pair of Floats specifying the location of the dimension text.

• value (Optional[float], default: None) – A Float distance between the two vertices.

• reference (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the created dimension enforces the above value or if it simply measures the distance between the two vertices.

Returns:

A ConstrainedSketchDimension object

Return type:

dimension

Line(point1, point2)

This method creates a line between two given points.

Note

This function can be accessed by:

mdb.models[name].sketches[name].Line

Note

Check Line on help.3ds.com/0.1..

Parameters:

• point1 (Tuple[float, ...]) – A pair of Floats specifying the first endpoint.

• point2 (Tuple[float, ...]) – A pair of Floats specifying the second endpoint.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

ObliqueDimension(vertex1, vertex2, textPoint, value=None, reference=OFF)

This method constructs a ConstrainedSketchDimension object between two vertices. An oblique dimension indicates the distance between two vertices.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ObliqueDimension

Note

Check ObliqueDimension on help.3ds.com/0.1..

Parameters:

• vertex1 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object specifying the first endpoint.

• vertex2 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object specifying the second endpoint.

• textPoint (Tuple[float, ...]) – A pair of Floats specifying the location of the dimension text.

• value (Optional[float], default: None) – A Float specifying the distance between the two ConstrainedSketchVertex objects.

• reference (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the created dimension enforces the above value or if it simply measures the distance between the two vertices.

Returns:

A ConstrainedSketchDimension object

Return type:

dimension

ParallelConstraint(entity1, entity2)

This method creates a parallel constraint. This constraint applies to lines and constrains them to be parallel.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ParallelConstraint

Note

Check ParallelConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first line.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second line.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

PerpendicularConstraint(entity1, entity2)

This method creates a perpendicular constraint. This constraint applies to different types of ConstrainedSketchGeometry objects and constrains them to be perpendicular to each other.

Note

This function can be accessed by:

mdb.models[name].sketches[name].PerpendicularConstraint

Note

Check PerpendicularConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first object.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second object.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

RadialDimension(curve, textPoint, value=None, reference=OFF, majorRadius=None, minorRadius=None)

This method constructs a ConstrainedSketchDimension object on a circular or elliptical arc. A radial dimension indicates the radius of an arc or circle or the major or minor radius of an ellipse.

Note

This function can be accessed by:

mdb.models[name].sketches[name].RadialDimension

Note

Check RadialDimension on help.3ds.com/0.1..

Parameters:

• curve (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the circular or elliptical arc.

• textPoint (Tuple[float, ...]) – A pair of Floats specifying the location of the dimension text.

• value (Optional[float], default: None) – A Float specifying the radius of the arc, circle or ellipse.

• reference (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the created dimension enforces the above value or if it simply measures the angle between two lines.

• majorRadius (Optional[float], default: None) – A Float specifying the major Radius if curve is an ellipse. This is mutually exclusive with value and minorRadius.

• minorRadius (Optional[float], default: None) – A Float specifying the minor Radius if curve is an ellipse. This is mutually exclusive with value and majorRadius.

Returns:

A ConstrainedSketchDimension object

Return type:

dimension

Spline(points, constrainPoints=True)

This method creates a spline curve running through a sequence of points.

Note

This function can be accessed by:

mdb.models[name].sketches[name].Spline

Note

Check Spline on help.3ds.com/0.1..

Parameters:

• points (tuple) – A sequence of pairs of Floats specifying the points through which the spline passes.

• constrainPoints (Union[AbaqusBoolean, bool], default: True) – A Boolean that determines whether the points given are to constrained to always remain on the Spline. The default is True. For a large sequence of points, significant performance gains may be achieved by setting the value to False.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

Spot(point)

This method creates a spot construction point located at the specified coordinates. The spot is added to the vertex repository of the ConstrainedSketch object.

Note

This function can be accessed by:

mdb.models[name].sketches[name].Spot

Note

Check Spot on help.3ds.com/0.1..

Parameters:

point (Tuple[float, ...]) – A pair of Floats specifying the coordinates of the spot construction point.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

TangentConstraint(entity1, entity2)

This method creates a tangent constraint. This constraint applies to different types of ConstrainedSketchGeometry objects and constrains them to remain tangential.

Note

This function can be accessed by:

mdb.models[name].sketches[name].TangentConstraint

Note

Check TangentConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first object.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second object.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

VerticalConstraint(entity)

This method creates a vertical constraint. This constraint applies to a line and constrains it to be vertical.

Note

This function can be accessed by:

mdb.models[name].sketches[name].VerticalConstraint

Note

Check VerticalConstraint on help.3ds.com/0.1..

Parameters:

entity (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the line to constrain.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

VerticalDimension(vertex1, vertex2, textPoint, value=None, reference=OFF)

This method constructs a ConstrainedSketchDimension between two vertices. A vertical dimension controls the vertical distance along the Y-axis between two vertices.

Note

This function can be accessed by:

mdb.models[name].sketches[name].VerticalDimension

Note

Check VerticalDimension on help.3ds.com/0.1..

Parameters:

• vertex1 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object specifying the first endpoint.

• vertex2 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object specifying the second endpoint.

• textPoint (Tuple[float, ...]) – A pair of Floats specifying the location of the dimension text.

• value (Optional[float], default: None) – A Float specifying the angle between the two lines.

• reference (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the created dimension enforces the above value or if it simply measures the angle between two lines.

Returns:

A ConstrainedSketchDimension object

Return type:

dimension

assignCenterOfTwist(point)

This method indicates the isolated point that will be used as the center of twist when an extruded feature is created with twist.

Note

Check ConstrainedSketch.assignCenterOfTwist on help.3ds.com/0.1..

Parameters:

point (ConstrainedSketchVertex) – A ConstrainedSketchVertex object specifying an isolated point that indicates the center of twist for extruded features that use a twist angle.

assignCenterline(line)

This method indicates the construction line that will be used as a centerline for revolved features.

Note

Check ConstrainedSketch.assignCenterline on help.3ds.com/0.1..

Parameters:

line (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying a construction line that indicates the centerline of revolved features.

autoDimension(objectList)

This method applies dimensions to the selected ConstrainedSketchGeometry objects in an effort to make the ConstrainedSketch well defined.

Note

Check ConstrainedSketch.autoDimension on help.3ds.com/0.1..

Parameters:

objectList (tuple) – A sequence specifying the ConstrainedSketchGeometry objects to dimension.

autoTrimCurve(curve1, point1, parameter1)

This method automatically trims a selected ConstrainedSketchGeometry object at the specified location. If the object does not intersect other ConstrainedSketchGeometry objects, the entire selected object will be deleted.

Note

Check ConstrainedSketch.autoTrimCurve on help.3ds.com/0.1..

Parameters:

• curve1 (str) – The ConstrainedSketchGeometry object to be trimmed.

• point1 (Tuple[float, float]) – A pair of Floats specifying the location on ConstrainedSketchGeometry where the trimming should be applied. point1 and parameter1 are mutually exclusive.

• parameter1 (float) – A Float specifying the parameter location on the ConstrainedSketchGeometry where the trimming should be applied. point1 and parameter1 are mutually exclusive.

breakCurve(curve1, point1, curve2, point2)

This method breaks a specified ConstrainedSketchGeometry object (curve1) using another specified ConstrainedSketchGeometry object (curve2). If the selected ConstrainedSketchGeometry objects intersect, then only curve1 will be broken; curve2 is not affected by the operation. The location for the break is determined by the specified point values.

Note

Check ConstrainedSketch.breakCurve on help.3ds.com/0.1..

Parameters:

• curve1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the object to be broken.

• point1 (Tuple[float, float]) – A pair of Floats specifying the location on curve1 near where the break should be applied.

• curve2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying where curve1 should be broken.

• point2 (Tuple[float, float]) – A pair of Floats specifying the location on curve2 near where curve1 should be broken.

constraints: Dict[str, ConstrainedSketchConstraint] = {}

A repository of ConstrainedSketchConstraint objects.

copyMirror(mirrorLine, objectList)

This method creates copies of the given ConstrainedSketchGeometry objects, mirrors them about a selected line, and inserts them into the appropriate repositories of the ConstrainedSketch object.

Note

Check ConstrainedSketch.copyMirror on help.3ds.com/0.1..

Parameters:

• mirrorLine (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the line about which Abaqus will mirror the sketch.

• objectList (Tuple[ConstrainedSketchGeometry, ...]) – A sequence of ConstrainedSketchGeometry objects specifying the sketch to be copied and mirrored.

copyMove(vector, objectList)

This method creates copies of the given ConstrainedSketchGeometry objects, moves them from their original position, and inserts them into the appropriate repositories of the ConstrainedSketch object.

Note

Check ConstrainedSketch.copyMove on help.3ds.com/0.1..

Parameters:

• vector (tuple) – A sequence of two Floats specifying the translation vector.

• objectList (Tuple[ConstrainedSketchGeometry, ...]) – A sequence of ConstrainedSketchGeometry objects to be copied and moved.

copyRotate(centerPoint, angle, objectList)

This method creates copies of the given ConstrainedSketchGeometry objects, rotates them, and inserts them into the appropriate repositories of the ConstrainedSketch object.

Note

Check ConstrainedSketch.copyRotate on help.3ds.com/0.1..

Parameters:

• centerPoint (Tuple[float, float]) – A pair of Floats specifying the center of rotation.

• angle (float) – A Float specifying the angle of rotation in degrees.

• objectList (Tuple[ConstrainedSketchGeometry, ...]) – A sequence of ConstrainedSketchGeometry objects to be copied and moved.

copyScale(scaleValue, scaleCenter, objectList)

This method creates copies of the given ConstrainedSketchGeometry objects, scales them by the specified value about a selected point, and inserts them into the appropriate repositories of the ConstrainedSketch object.

Note

Check ConstrainedSketch.copyScale on help.3ds.com/0.1..

Parameters:

• scaleValue (float) – A Float specifying the value for scaling.

• scaleCenter (Tuple[float, float]) – A pair of Floats specifying the center of scaling.

• objectList (Tuple[ConstrainedSketchGeometry, ...]) – A sequence of ConstrainedSketchGeometry objects to be copied and scaled.

delete(objectList)

This method deletes the given ConstrainedSketchGeometry, ConstrainedSketchDimension, or ConstrainedSketchConstraint objects.

Note

Check ConstrainedSketch.delete on help.3ds.com/0.1..

Parameters:

objectList (tuple) – A sequence of ConstrainedSketchGeometry, ConstrainedSketchDimension, or ConstrainedSketchConstraint objects to be deleted.

deleteParameter(name)

The command deletes a specified parameter.

Note

Check ConstrainedSketch.deleteParameter on help.3ds.com/0.1..

Parameters:

name (str) – A String specifying the name of the parameter to delete.

dimensions: Dict[str, ConstrainedSketchDimension] = {}

A repository of ConstrainedSketchDimension objects.

dragEntity(entity, points)

This method drags a specified ConstrainedSketchGeometry or ConstrainedSketchVertex object to a specific location.

Note

Check ConstrainedSketch.dragEntity on help.3ds.com/0.1..

Parameters:

• entity (str) – A ConstrainedSketchGeometry or ConstrainedSketchVertex object specifying the object to drag.

• points (tuple) – A sequence of sequences of three Floats specifying a sequence of points along which to drag the entity. The order of points in the sequence defines a path that determines the solution.

geometry: ConstrainedSketchGeometryArray = []

A ConstrainedSketchGeometryArray object specifying the sketch geometry, such as lines, arcs, circles, and splines.

getPointAtDistance(point, distance, percentage=OFF)

This method returns a point offset along the given ConstrainedSketchGeometry from the given end by a specified arc length distance or a percentage of the total length of the ConstrainedSketchGeometry object.

Note

Check ConstrainedSketchGeometryModel.getPointAtDistance on help.3ds.com/0.1..

Parameters:

• point (Tuple[float, ...]) – A pair of Floats specifying the point from which the distance is to be measured.

• distance (str) – A float specifying the arc length distance along the ConstrainedSketchGeometry from the point at which the required point is situated.

• percentage (Union[AbaqusBoolean, bool], default: OFF) – A Boolean that specifies if the distance is an absolute distance or is a fraction relative to the length of the ConstrainedSketchGeometry object.

Returns:

points – A pair of floats representing the point along the edge

Return type:

Tuple[float, ]

getSize()

This method returns the length of the given ConstrainedSketchGeometry object.

Returns:

length – The length of the given ConstrainedSketchGeometry

Return type:

int

getVertices()

This method returns an list of ConstrainedSketchVertex objects which are a part of the given ConstrainedSketchGeometry object.

Returns:

vertices – A list of ConstrainedSketchVertex objects

Return type:

List[ConstrainedSketchVertex]

imageOptions: ConstrainedSketchImageOptions = <abaqus.Sketcher.ConstrainedSketchOptions.ConstrainedSketchImageOptions.ConstrainedSketchImageOptions object>

A ConstrainedSketchImageOptions object.

linearPattern(number1, spacing1, angle1, vertexList=(), geomList=(), number2=1, spacing2=None, angle2=None)

This method copies ConstrainedSketchGeometry objects in a linear pattern along one or two directions. This method also copies any associated dimension or constraint objects that exist between the given objects.

Note

Check ConstrainedSketch.linearPattern on help.3ds.com/0.1..

Parameters:

• number1 (int) – An Integer specifying the total number of copies, including the original objects, that appear along the first direction in the pattern. Possible values are 1 ≤ number1 ≤ 1000.

• spacing1 (float) – A Float specifying the spacing between copies along the first direction in the pattern. Possible values are 0.0 ≤ spacing1 .

• angle1 (float) – A Float specifying the angle in degrees of the first direction in the pattern. Possible values are -360.0 ≤ angle1 ≤ 360.0.

• vertexList (Tuple[ConstrainedSketchVertex, ...], default: ()) – A sequence of ConstrainedSketchVertex objects to copy.

• geomList (Tuple[ConstrainedSketchGeometry, ...], default: ()) – A sequence of ConstrainedSketchGeometry objects to copy.

• number2 (int, default: 1) – An integer specifying the total number of copies, including the original objects, that appear along the second direction in the pattern. Possible values are 1 ≤ number2 ≤ 1000. The default value is 1. The value of either number1 or number2 must be greater than one.

• spacing2 (Optional[float], default: None) – A Float specifying the spacing between copies along the first direction in the pattern. Possible values are 0.0 ≤ spacing2. The default value is spacing1.

• angle2 (Optional[float], default: None) – A Float specifying the angle in degrees of the first direction in the pattern. Possible values are -360.0 ≤ angle2 ≤ 360.0. The default value is 90° beyond the value of angle1.

Return type:

None.

Raises:

AbaqusException – Number must be greater than 1 for at least one direction

mergeVertices(value, vertexList)

This method merges the ConstrainedSketchVertex objects that lie within the specified distance of each other. If only one ConstrainedSketchVertex object is selected, it will merge all ConstrainedSketchVertex objects that lie within the specified distance of that vertex. If more than one vertex is selected, the search will be restricted to only the selected ConstrainedSketchVertex objects.

Note

Check ConstrainedSketch.mergeVertices on help.3ds.com/0.1..

Parameters:

• value (float) – A Float specifying the search radius.

• vertexList (Tuple[ConstrainedSketchVertex, ...]) – A sequence of ConstrainedSketchVertex objects to be merged.

move(vector, objectList)

This method translates the given ConstrainedSketchGeometry objects by the given vector.

Note

Check ConstrainedSketch.move on help.3ds.com/0.1..

Parameters:

• vector (tuple) – A sequence of two Floats specifying the translation vector.

• objectList (Tuple[ConstrainedSketchGeometry, ...]) – A sequence of ConstrainedSketchGeometry objects specifying the objects to be translated.

offset(distance, objectList, side, filletCorners=OFF)

This method creates copies of the selected ConstrainedSketchGeometry objects, offsets them by the specified distance in the specified direction, and inserts them into the ConstrainedSketch object’s appropriate repositories. If connected objects are selected, trim or extend is carried out to complete the offset.

Note

Check ConstrainedSketch.offset on help.3ds.com/0.1..

Parameters:

• distance (float) – A Float specifying the distance to be offset.

• objectList (Tuple[ConstrainedSketchGeometry, ...]) – A sequence of ConstrainedSketchGeometry objects to be copied and offset.

• side (Literal[LEFT, RIGHT]) – A SymbolicConstant specifying which side the offset should occur. Possible values are LEFT and RIGHT.

• filletCorners (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the corners need to be rounded instead of being extended.

parameters: Dict[str, ConstrainedSketchParameter] = {}

A repository of ConstrainedSketchParameter objects specifying sketch parameters, which may be associated with dimensions.

print()

This method prints the following statistics about a sketch: - The sketch Id (a positive integer). - The number of geometry curves (the number of ConstrainedSketchGeometry objects). - The number of dimensions (the number of ConstrainedSketchDimension objects). - The number of vertices (the number of ConstrainedSketchVertex objects).

radialPattern(number, totalAngle, centerPoint, vertexList=(), geomList=())

This method copies ConstrainedSketchGeometry objects in a radial pattern about a specified center point.

Note

Check ConstrainedSketch.radialPattern on help.3ds.com/0.1..

Parameters:

• number (int) – An Int specifying the total number of copies, including the original objects, that appear in the radial pattern. Possible values are 2 ≤ number2 ≤ 1000.

• totalAngle (float) – A Float specifying the total angle in degrees between the first and last instance in the pattern. A positive angle corresponds to a counter-clockwise direction. The values 360° and -360° represent a special case where the pattern makes a full circle. In this case, because the copy would overlay the original, the copy is not placed at the last position. Possible values are -360.0 ≤ totalAngle ≤ 360.0.

• centerPoint (Tuple[float, float]) – A pair of Floats specifying the center of the radial pattern.

• vertexList (Tuple[ConstrainedSketchVertex, ...], default: ()) – A sequence of ConstrainedSketchVertex objects to copy.

• geomList (Tuple[ConstrainedSketchGeometry, ...], default: ()) – A sequence of ConstrainedSketchGeometry objects to copy.

rectangle(point1, point2)

This method creates four lines that form a rectangle with diagonal corners defined by the given points and inserts them into the geometry repository of the ConstrainedSketch object.

Note

Check ConstrainedSketch.rectangle on help.3ds.com/0.1..

Parameters:

• point1 (Tuple[float, float]) – A pair of Floats specifying the first corner of the rectangle.

• point2 (Tuple[float, float]) – A pair of Floats specifying the second corner of the rectangle.

Returns:

success – An Int specifying the success or failure of the method. A value of 0 indicates failure

Return type:

int

removeGapsAndOverlaps(tolerance, geomList)

This method removes gaps and overlaps between sketch geometries specified by the user. This method is particularly useful when cleaning up imported sketches

Note

Check ConstrainedSketch.removeGapsAndOverlaps on help.3ds.com/0.1..

Parameters:

• tolerance (str) – A float value which specifies the largest size of the gap or overlap between entities that is to be removed. Typically this value is small and is used to close gaps and overlaps which may not exist in the originating program but exist in the sketch because of mismatched tolerances between the two programs.

• geomList (Tuple[ConstrainedSketchGeometry, ...]) – A sequence of ConstrainedSketchGeometry objects where the gaps and overlaps are to be removed.

repairShortEdges(geomList, tolerance='')

This method deletes the short edges specified, optionally selecting only those short edges whose lengths are smaller than the specified tolerance and healing the resultant gap in the sketch. This method is particularly useful in conjunction with removeGapsAndOverlap when cleaning up imported sketches.

Note

Check ConstrainedSketch.repairShortEdges on help.3ds.com/0.1..

Parameters:

• geomList (Tuple[ConstrainedSketchGeometry, ...]) – A sequence of ConstrainedSketchGeometry objects where the short edges are to be removed.

• tolerance (str, default: '') – A float value that is used to select and delete only those edges specified in geomList whose lengths are smaller than the given value. The default value is -1.0. This value implies that all edges specified in geomList will be removed and the sketch healed to remove gaps left by their removal.

resetView()

This method resets the view to be perpendicular to the sketching plane.

retrieveSketch(sketch)

This method copies all ConstrainedSketchGeometry, ConstrainedSketchDimension, ConstrainedSketchConstraint, and ConstrainedSketchParameter objects from the specified ConstrainedSketch object. The new objects are added to the existing objects (if any). The objects in the specified ConstrainedSketch object are not modified by the retrieve operation.

Note

Check ConstrainedSketch.retrieveSketch on help.3ds.com/0.1..

Parameters:

sketch (ConstrainedSketch) – A ConstrainedSketch object specifying the object from which to copy.

rotate(centerPoint, angle, objectList)

This method rotates the given ConstrainedSketchGeometry objects by the given angle and about the given point.

Note

Check ConstrainedSketch.rotate on help.3ds.com/0.1..

Parameters:

• centerPoint (Tuple[float, float]) – A pair of Floats specifying the center of rotation.

• angle (float) – A Float specifying the angle of rotation in degrees.

• objectList (tuple) – A sequence of ConstrainedSketchGeometry specifying the objects to be rotated.

scale(scaleValue, scaleCenter, objectList)

This method scales the given ConstrainedSketchGeometry objects by the given scale factor and about the given point.

Note

Check ConstrainedSketch.scale on help.3ds.com/0.1..

Parameters:

• scaleValue (float) – A Float specifying the value of scale.

• scaleCenter (Tuple[float, float]) – A pair of Floats specifying the center of scale.

• objectList (Tuple[ConstrainedSketchGeometry, ...]) – A sequence of ConstrainedSketchGeometry objects specifying the objects to be scaled.

setPrimaryObject(option)

This method makes the ConstrainedSketch object the primary object in the current viewport. The sketch remains the primary object in the current viewport until an unsetPrimaryobject command is issued.

Note

Check ConstrainedSketch.setPrimaryObject on help.3ds.com/0.1..

Parameters:

option (Literal[STANDALONE, SUPERIMPOSE]) – A SymbolicConstant specifying how the sketch is displayed. Possible values are: STANDALONE: Indicates a new stand-alone sketch. The current viewport is cleared and is replaced by the stand-alone sketch. The view direction is set to −ZZ. SUPERIMPOSE: Indicates that the sketch is superimposed on the current viewport. The view direction is changed to be perpendicular to the sketch plane. The change is effected smoothly as an animated sequence of many small viewing steps.

sketchOptions: ConstrainedSketchOptions = <abaqus.Sketcher.ConstrainedSketchOptions.ConstrainedSketchOptions.ConstrainedSketchOptions object>

A ConstrainedSketchOptions object specifying the sketch option settings.

trimExtendCurve(curve1, point1, curve2, point2)

This method trims or extends a specified ConstrainedSketchGeometry object (curve1) using another specified ConstrainedSketchGeometry object (curve2). curve2 is not affected by the operation. The location for the trim or extend is determined by the specified point values.

Note

Check ConstrainedSketch.trimExtendCurve on help.3ds.com/0.1..

Parameters:

• curve1 (str) – The ConstrainedSketchGeometry object specifying the object to be trimmed or extended.

• point1 (Tuple[float, float]) – A pair of Floats specifying the location on curve1 where trim or extend should be applied.

• curve2 (str) – The ConstrainedSketchGeometry object specifying the object to which curve1 is trimmed or extended. curve2 is not trimmed or extended.

• point2 (Tuple[float, float]) – A pair of Floats specifying the location on curve2 near where curve1 should be trimmed or extended.

undo()

This method undoes the effects of the last ConstrainedSketch object method.

unsetPrimaryObject()

This method removes the ConstrainedSketch object from the current viewport, reversing the effects of the setPrimaryobject command. If the option argument was set to SUPERIMPOSE, the viewport will be returned to the view orientation that was in place when the setPrimaryobject command was issued. If the option argument was set to STANDALONE, the viewport will be left empty.

vertices: ConstrainedSketchVertexArray = []

A ConstrainedSketchVertexArray object.

writeAcisFile(fileName, version=None)

This method exports the geometry of the sketch to a named file in ACIS format.

Note

Check ConstrainedSketch.writeAcisFile on help.3ds.com/0.1..

Parameters:

• fileName (str) –

  A String specifying the name of the file to which to write. The file name’s extension is used to determine whether a part or assembly is written. Use the file extension .asat for the assembly format.

  Changed in version 2018: Add description for thr file name’s extension.

• version (Optional[float], default: None) – A Float specifying the ACIS version. For example, the Float 12.0 corresponds to ACIS Version 12.0. The default value is the current version of ACIS.

writeIgesFile(filename, flavor=Ellipsis)

This method exports the geometry of the sketch to a named file in IGES format.

Note

Check ConstrainedSketch.writeIgesFile on help.3ds.com/0.1..

Parameters:

• filename (str) – A String specifying the file name.

• flavor (Literal[STANDARD, AUTOCAD, SOLIDWORKS, JAMA, MSBO], default: Ellipsis) – A SymbolicConstant specifying a particular flavor of IGES to export. Possible values are STANDARD, AUTOCAD, SOLIDWORKS, JAMA, and MSBO.

ConstrainedSketchConstraintModel

class ConstrainedSketchConstraintModel

A ConstrainedSketch object contains the entities that are used to create a sketch. The objects include ConstrainedSketchGeometry objects contained in the ConstrainedSketchGeometry Repository, such as Line, Arc, and Spline. ConstrainedSketchVertex, ConstrainedSketchDimension, ConstrainedSketchConstraint, and ConstrainedSketchParameter objects are contained in their respective repositories.

Note

This object can be accessed by:

import sketch
mdb.models[name].sketches[name]

Note

Check ConstrainedSketchConstraintModel on help.3ds.com/0.1..

Public Data Attributes:

Inherited from ConstrainedSketchBase

constraints	A repository of ConstrainedSketchConstraint objects.
dimensions	A repository of ConstrainedSketchDimension objects.
geometry	A ConstrainedSketchGeometryArray object specifying the sketch geometry, such as lines, arcs, circles, and splines.
parameters	A repository of ConstrainedSketchParameter objects specifying sketch parameters, which may be associated with dimensions.
sketchOptions	A ConstrainedSketchOptions object specifying the sketch option settings.
vertices	A ConstrainedSketchVertexArray object.
imageOptions	A ConstrainedSketchImageOptions object.

Public Methods:

CoincidentConstraint(entity1, entity2)	This method creates a coincident constraint.
ConcentricConstraint(entity1, entity2)	This method creates a concentric constraint.
EqualLengthConstraint(entity1, entity2)	This method creates an equal length constraint.
EqualRadiusConstraint(entity1, entity2)	This method creates an equal radius constraint.
FixedConstraint(entity)	This method creates a fixed constraint.
HorizontalConstraint(entity)	This method creates a horizontal constraint.
VerticalConstraint(entity)	This method creates a vertical constraint.
ParallelConstraint(entity1, entity2)	This method creates a parallel constraint.
PerpendicularConstraint(entity1, entity2)	This method creates a perpendicular constraint.
EqualDistanceConstraint(entity1, entity2, ...)	This method creates an equal distance constraint.
TangentConstraint(entity1, entity2)	This method creates a tangent constraint.

---

CoincidentConstraint(entity1, entity2)

This method creates a coincident constraint. This constraint applies to two vertices, to a vertex and a ConstrainedSketchGeometry object, or to two ConstrainedSketchGeometry objects of the same type and constrains them to be coincident.

Note

This function can be accessed by:

mdb.models[name].sketches[name].CoincidentConstraint

Note

Check CoincidentConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object or a ConstrainedSketchVertex object specifying the first object.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object or a ConstrainedSketchVertex object specifying the second object.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

ConcentricConstraint(entity1, entity2)

This method creates a concentric constraint. This constraint applies to any combination of circles, arcs, ellipses, and points and constrains them to be concentric. A concentric constraint implies that the center of ConstrainedSketchGeometry objects coincide.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ConcentricConstraint

Note

Check ConcentricConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first arc, circle, ellipse, or sketch vertex.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second arc, circle, ellipse, or sketch vertex.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

EqualDistanceConstraint(entity1, entity2, midpoint)

This method creates an equal distance constraint. This constraint can be applied between a midpoint ConstrainedSketchVertex object and any other two ConstrainedSketchVertex objects or between a midpoint ConstrainedSketchVertex object and two ConstrainedSketchGeometry objects that are lines. The equal distance constraint forces the midpoint vertex to remain at an equal distance from the two other vertices or lines.

Note

This function can be accessed by:

mdb.models[name].sketches[name].EqualDistanceConstraint

Note

Check EqualDistanceConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (str) – AConstrainedSketchGeometry object specifying the first line or ConstrainedSketchVertex object.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second line or ConstrainedSketchVertex object.

• midpoint (Vertex) – A ConstrainedSketchVertex object specifying the vertex that will be positioned an equal distance from entity1 and entity2.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

EqualLengthConstraint(entity1, entity2)

This method creates an equal length constraint. This constraint applies to lines and constrains them such that their lengths are equal.

Note

This function can be accessed by:

mdb.models[name].sketches[name].EqualLengthConstraint

Note

Check EqualLengthConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first line.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second line.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

EqualRadiusConstraint(entity1, entity2)

This method creates an equal radius constraint. This constraint applies to circles and arcs and constrains them such that their radii are equal.

Note

This function can be accessed by:

mdb.models[name].sketches[name].EqualRadiusConstraint

Note

Check EqualRadiusConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first arc or circle.

• entity2 (str) – A ConstrainedSketchGeometry specifying the second arc or circle.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

FixedConstraint(entity)

This method creates a fixed constraint. This constraint applies to a ConstrainedSketchGeometry object or a ConstrainedSketchVertex object and constrains them to be fixed in space. Both the location and the shape of the sketch geometry is fixed.

Note

This function can be accessed by:

mdb.models[name].sketches[name].FixedConstraint

Note

Check FixedConstraint on help.3ds.com/0.1..

Parameters:

entity (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object or a ConstrainedSketchVertex object specifying the item to fix in space.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

HorizontalConstraint(entity)

This method creates a horizontal constraint. This constraint applies to a line and constrains it to be horizontal.

Note

This function can be accessed by:

mdb.models[name].sketches[name].HorizontalConstraint

Note

Check HorizontalConstraint on help.3ds.com/0.1..

Parameters:

entity (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the line to constrain.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

ParallelConstraint(entity1, entity2)

This method creates a parallel constraint. This constraint applies to lines and constrains them to be parallel.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ParallelConstraint

Note

Check ParallelConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first line.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second line.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

PerpendicularConstraint(entity1, entity2)

This method creates a perpendicular constraint. This constraint applies to different types of ConstrainedSketchGeometry objects and constrains them to be perpendicular to each other.

Note

This function can be accessed by:

mdb.models[name].sketches[name].PerpendicularConstraint

Note

Check PerpendicularConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first object.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second object.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

TangentConstraint(entity1, entity2)

This method creates a tangent constraint. This constraint applies to different types of ConstrainedSketchGeometry objects and constrains them to remain tangential.

Note

This function can be accessed by:

mdb.models[name].sketches[name].TangentConstraint

Note

Check TangentConstraint on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first object.

• entity2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second object.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

VerticalConstraint(entity)

This method creates a vertical constraint. This constraint applies to a line and constrains it to be vertical.

Note

This function can be accessed by:

mdb.models[name].sketches[name].VerticalConstraint

Note

Check VerticalConstraint on help.3ds.com/0.1..

Parameters:

entity (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the line to constrain.

Returns:

sketch – A ConstrainedSketch object

Return type:

ConstrainedSketch

ConstrainedSketchDimensionModel

class ConstrainedSketchDimensionModel

A ConstrainedSketch object contains the entities that are used to create a sketch. The objects include ConstrainedSketchGeometry objects contained in the ConstrainedSketchGeometry Repository, such as Line, Arc, and Spline. ConstrainedSketchVertex, ConstrainedSketchDimension, ConstrainedSketchConstraint, and ConstrainedSketchParameter objects are contained in their respective repositories.

Note

This object can be accessed by:

import sketch
mdb.models[name].sketches[name]

Note

Check ConstrainedSketchDimensionModel on help.3ds.com/0.1..

Public Data Attributes:

Inherited from ConstrainedSketchBase

constraints	A repository of ConstrainedSketchConstraint objects.
dimensions	A repository of ConstrainedSketchDimension objects.
geometry	A ConstrainedSketchGeometryArray object specifying the sketch geometry, such as lines, arcs, circles, and splines.
parameters	A repository of ConstrainedSketchParameter objects specifying sketch parameters, which may be associated with dimensions.
sketchOptions	A ConstrainedSketchOptions object specifying the sketch option settings.
vertices	A ConstrainedSketchVertexArray object.
imageOptions	A ConstrainedSketchImageOptions object.

Public Methods:

AngularDimension(line1, line2, textPoint[, ...])	This method constructs a ConstrainedSketchDimension object between two ConstrainedSketchGeometry objects, with the given angle between them.
HorizontalDimension(vertex1, vertex2, textPoint)	This method constructs a ConstrainedSketchDimension object between two vertices.
ObliqueDimension(vertex1, vertex2, textPoint)	This method constructs a ConstrainedSketchDimension object between two vertices.
RadialDimension(curve, textPoint[, value, ...])	This method constructs a ConstrainedSketchDimension object on a circular or elliptical arc.
VerticalDimension(vertex1, vertex2, textPoint)	This method constructs a ConstrainedSketchDimension between two vertices.
DistanceDimension(entity1, entity2, textPoint)	This method constructs a ConstrainedSketchDimension object between two ConstrainedSketchGeometry, or aConstrainedSketchVertex and ConstrainedSketchGeometry object.

---

AngularDimension(line1, line2, textPoint, value=None, reference=OFF)

This method constructs a ConstrainedSketchDimension object between two ConstrainedSketchGeometry objects, with the given angle between them.

Note

This function can be accessed by:

mdb.models[name].sketches[name].AngularDimension

Note

Check AngularDimension on help.3ds.com/0.1..

Parameters:

• line1 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the first line.

• line2 (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the second line.

• textPoint (Tuple[float, ...]) – A pair of Floats specifying the location of the dimension text.

• value (Optional[float], default: None) – A Float specifying the angle between the two lines.

• reference (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the created dimension enforces the above value or if it simply measures the angle between two lines.

Returns:

A ConstrainedSketchDimension object

Return type:

dimension

DistanceDimension(entity1, entity2, textPoint, value=None, reference=OFF)

This method constructs a ConstrainedSketchDimension object between two ConstrainedSketchGeometry, or aConstrainedSketchVertex and ConstrainedSketchGeometry object. A distance dimension specifies the shortest distance between two entities.

Note

This function can be accessed by:

mdb.models[name].sketches[name].DistanceDimension

Note

Check DistanceDimension on help.3ds.com/0.1..

Parameters:

• entity1 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object or ConstrainedSketchGeometry object.

• entity2 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object or ConstrainedSketchGeometry object.

• textPoint (Tuple[float, ...]) – A pair of Floats specifying the location of the dimension text.

• value (Optional[float], default: None) – A Float specifying the angle between the two lines.

• reference (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the created dimension enforces the above value or if it simply measures the angle between two lines.

Returns:

A ConstrainedSketchDimension object

Return type:

dimension

HorizontalDimension(vertex1, vertex2, textPoint, value=None, reference=OFF)

This method constructs a ConstrainedSketchDimension object between two vertices. A horizontal dimension indicates the horizontal distance along the X-axis between two vertices.

Note

This function can be accessed by:

mdb.models[name].sketches[name].HorizontalDimension

Note

Check HorizontalDimension on help.3ds.com/0.1..

Parameters:

• vertex1 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object specifying the first endpoint.

• vertex2 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object specifying the second endpoint.

• textPoint (Tuple[float, ...]) – A pair of Floats specifying the location of the dimension text.

• value (Optional[float], default: None) – A Float distance between the two vertices.

• reference (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the created dimension enforces the above value or if it simply measures the distance between the two vertices.

Returns:

A ConstrainedSketchDimension object

Return type:

dimension

ObliqueDimension(vertex1, vertex2, textPoint, value=None, reference=OFF)

This method constructs a ConstrainedSketchDimension object between two vertices. An oblique dimension indicates the distance between two vertices.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ObliqueDimension

Note

Check ObliqueDimension on help.3ds.com/0.1..

Parameters:

• vertex1 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object specifying the first endpoint.

• vertex2 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object specifying the second endpoint.

• textPoint (Tuple[float, ...]) – A pair of Floats specifying the location of the dimension text.

• value (Optional[float], default: None) – A Float specifying the distance between the two ConstrainedSketchVertex objects.

• reference (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the created dimension enforces the above value or if it simply measures the distance between the two vertices.

Returns:

A ConstrainedSketchDimension object

Return type:

dimension

RadialDimension(curve, textPoint, value=None, reference=OFF, majorRadius=None, minorRadius=None)

This method constructs a ConstrainedSketchDimension object on a circular or elliptical arc. A radial dimension indicates the radius of an arc or circle or the major or minor radius of an ellipse.

Note

This function can be accessed by:

mdb.models[name].sketches[name].RadialDimension

Note

Check RadialDimension on help.3ds.com/0.1..

Parameters:

• curve (ConstrainedSketchGeometry) – A ConstrainedSketchGeometry object specifying the circular or elliptical arc.

• textPoint (Tuple[float, ...]) – A pair of Floats specifying the location of the dimension text.

• value (Optional[float], default: None) – A Float specifying the radius of the arc, circle or ellipse.

• reference (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the created dimension enforces the above value or if it simply measures the angle between two lines.

• majorRadius (Optional[float], default: None) – A Float specifying the major Radius if curve is an ellipse. This is mutually exclusive with value and minorRadius.

• minorRadius (Optional[float], default: None) – A Float specifying the minor Radius if curve is an ellipse. This is mutually exclusive with value and majorRadius.

Returns:

A ConstrainedSketchDimension object

Return type:

dimension

VerticalDimension(vertex1, vertex2, textPoint, value=None, reference=OFF)

This method constructs a ConstrainedSketchDimension between two vertices. A vertical dimension controls the vertical distance along the Y-axis between two vertices.

Note

This function can be accessed by:

mdb.models[name].sketches[name].VerticalDimension

Note

Check VerticalDimension on help.3ds.com/0.1..

Parameters:

• vertex1 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object specifying the first endpoint.

• vertex2 (ConstrainedSketchVertex) – A ConstrainedSketchVertex object specifying the second endpoint.

• textPoint (Tuple[float, ...]) – A pair of Floats specifying the location of the dimension text.

• value (Optional[float], default: None) – A Float specifying the angle between the two lines.

• reference (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the created dimension enforces the above value or if it simply measures the angle between two lines.

Returns:

A ConstrainedSketchDimension object

Return type:

dimension

ConstrainedSketchGeometryModel

class ConstrainedSketchGeometryModel

A ConstrainedSketch object contains the entities that are used to create a sketch. The objects include ConstrainedSketchGeometry objects contained in the ConstrainedSketchGeometry Repository, such as Line, Arc, and Spline. ConstrainedSketchVertex, ConstrainedSketchDimension, ConstrainedSketchConstraint, and ConstrainedSketchParameter objects are contained in their respective repositories.

Note

This object can be accessed by:

import sketch
mdb.models[name].sketches[name]

Note

Check ConstrainedSketchGeometryModel on help.3ds.com/0.1..

Public Data Attributes:

Inherited from ConstrainedSketchBase

constraints	A repository of ConstrainedSketchConstraint objects.
dimensions	A repository of ConstrainedSketchDimension objects.
geometry	A ConstrainedSketchGeometryArray object specifying the sketch geometry, such as lines, arcs, circles, and splines.
parameters	A repository of ConstrainedSketchParameter objects specifying sketch parameters, which may be associated with dimensions.
sketchOptions	A ConstrainedSketchOptions object specifying the sketch option settings.
vertices	A ConstrainedSketchVertexArray object.
imageOptions	A ConstrainedSketchImageOptions object.

Public Methods:

Arc3Points(point1, point2, point3)	This method constructs an arc using a two endpoints and an intermediate third point on the arc.
ArcByCenterEnds(center, point1, point2, ...)	This method constructs an arc using a center point and two vertices.
ArcByStartEndTangent(point1, point2, vector)	This method constructs an arc using two vertices.
CircleByCenterPerimeter(center, point1)	This method constructs a circle using a center point and a point on the perimeter.
ConstructionCircleByCenterPerimeter(center, ...)	This method constructs a construction circle using a center point and a point on the perimeter.
EllipseByCenterPerimeter(center, axisPoint1, ...)	This method constructs an ellipse using a center point, a major axis point, and a minor axis point.
FilletByRadius(radius, curve1, nearPoint1, ...)	This method constructs a fillet arc of a given radius between two curves.
Line(point1, point2)	This method creates a line between two given points.
ConstructionLine(point1, point2)	This method creates an oblique construction line that runs between two given points.
Spline(points[, constrainPoints])	This method creates a spline curve running through a sequence of points.
Spot(point)	This method creates a spot construction point located at the specified coordinates.
getVertices()	This method returns an list of ConstrainedSketchVertex objects which are a part of the given ConstrainedSketchGeometry object.
getSize()	This method returns the length of the given ConstrainedSketchGeometry object.
getPointAtDistance(point, distance[, percentage])	This method returns a point offset along the given ConstrainedSketchGeometry from the given end by a specified arc length distance or a percentage of the total length of the ConstrainedSketchGeometry object.

---

Arc3Points(point1, point2, point3)

This method constructs an arc using a two endpoints and an intermediate third point on the arc.

Note

This function can be accessed by:

mdb.models[name].sketches[name].Arc3Points

Note

Check Arc3Points on help.3ds.com/0.1..

Parameters:

• point1 (Tuple[float, ...]) – A pair of Floats specifying the first endpoint of the arc.

• point2 (Tuple[float, ...]) – A pair of Floats specifying the second endpoint of the arc.

• point3 (Tuple[float, ...]) – A pair of Floats specifying the third point on the arc.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

ArcByCenterEnds(center, point1, point2, direction)

This method constructs an arc using a center point and two vertices. The Arc object is added to the geometry repository of the ConstrainedSketch object. The arc is created in a clockwise fashion from point1 to point2.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ArcByCenterEnds

Note

Check ArcByCenterEnds on help.3ds.com/0.1..

Parameters:

• center (Tuple[float, ...]) – A pair of Floats specifying the center point of the arc.

• point1 (Tuple[float, ...]) – A pair of Floats specifying the first endpoint of the arc.

• point2 (Tuple[float, ...]) – A pair of Floats specifying the second endpoint of the arc.

• direction (SymbolicConstant) – A SymbolicConstant specifying the direction of the arc. Possible values are CLOCKWISE and COUNTERCLOCKWISE.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

:raises If incompatible data are given`, :class:`the second endpoint is ignored:

ArcByStartEndTangent(point1, point2, vector)

This method constructs an arc using two vertices. The Arc object is added to the geometry repository of the ConstrainedSketch object.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ArcByStartEndTangent

Note

Check ArcByStartEndTangent on help.3ds.com/0.1..

Parameters:

• point1 (Tuple[float, ...]) – A pair of Floats specifying the first endpoint of the arc.

• point2 (Tuple[float, ...]) – A pair of Floats specifying the second endpoint of the arc.

• vector (tuple) – A sequence of two Floats specifying the start direction for constructing the arc.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

CircleByCenterPerimeter(center, point1)

This method constructs a circle using a center point and a point on the perimeter. The circle is added to the geometry repository of the ConstrainedSketch object.

Note

This function can be accessed by:

mdb.models[name].sketches[name].CircleByCenterPerimeter

Note

Check CircleByCenterPerimeter on help.3ds.com/0.1..

Parameters:

• center (Tuple[float, ...]) – A pair of Floats specifying the center point of the circle.

• point1 (Tuple[float, ...]) – A pair of Floats specifying a point on the perimeter of the circle.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

ConstructionCircleByCenterPerimeter(center, point1)

This method constructs a construction circle using a center point and a point on the perimeter. The circle is added to the geometry repository of the ConstrainedSketch object.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ConstructionCircleByCenterPerimeter

Note

Check ConstructionCircleByCenterPerimeter on help.3ds.com/0.1..

Parameters:

• center (Tuple[float, ...]) – A pair of Floats specifying the center point of the construction circle.

• point1 (Tuple[float, ...]) – A pair of Floats specifying a point on the perimeter of the construction circle.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

ConstructionLine(point1, point2)

This method creates an oblique construction line that runs between two given points.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ConstructionLine

Note

Check ConstructionLine on help.3ds.com/0.1..

Parameters:

• point1 (Tuple[float, ...]) – A pair of Floats specifying the first endpoint.

• point2 (Tuple[float, ...]) – A pair of Floats specifying the second endpoint.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

EllipseByCenterPerimeter(center, axisPoint1, axisPoint2)

This method constructs an ellipse using a center point, a major axis point, and a minor axis point. The ellipse is added to the geometry repository of the ConstrainedSketch object.

Note

This function can be accessed by:

mdb.models[name].sketches[name].EllipseByCenterPerimeter

Note

Check EllipseByCenterPerimeter on help.3ds.com/0.1..

Parameters:

• center (Tuple[float, ...]) – A pair of Floats specifying the center point of the ellipse.

• axisPoint1 (Tuple[float, ...]) – A pair of Floats specifying the major or minor axis point of the ellipse.

• axisPoint2 (Tuple[float, ...]) – A pair of Floats specifying the minor or major axis point of the ellipse.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

FilletByRadius(radius, curve1, nearPoint1, curve2, nearPoint2)

This method constructs a fillet arc of a given radius between two curves. The fillet is added to the geometry repository of the ConstrainedSketch object.

Note

This function can be accessed by:

mdb.models[name].sketches[name].FilletByRadius

Note

Check FilletByRadius on help.3ds.com/0.1..

Parameters:

• radius (float) – A Float specifying the radius of the fillet arc. Possible values are Floats > 0.

• curve1 (ConstrainedSketchGeometryModel) – A ConstrainedSketchGeometry object specifying the first curve.

• nearPoint1 (Tuple[float, ...]) – A pair of Floats specifying a point on the sketch near where the user wishes the fillet to intersect with curve1. This point does not need to be on*curve1*; it is used as a hint to draw the fillet.

• curve2 (ConstrainedSketchGeometryModel) – A ConstrainedSketchGeometry object specifying the second curve.

• nearPoint2 (Tuple[float, ...]) – A pair of Floats specifying a point on the sketch near where the user wishes the fillet to intersect with curve2. This point does not need to be on curve2; it is used as a hint to draw the fillet.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

Raises:

Range Error` – :class:`cannot construct the Fillet specified: If the radius given cannot be used to create a fillet between the two curves given.

Line(point1, point2)

This method creates a line between two given points.

Note

This function can be accessed by:

mdb.models[name].sketches[name].Line

Note

Check Line on help.3ds.com/0.1..

Parameters:

• point1 (Tuple[float, ...]) – A pair of Floats specifying the first endpoint.

• point2 (Tuple[float, ...]) – A pair of Floats specifying the second endpoint.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

Spline(points, constrainPoints=True)

This method creates a spline curve running through a sequence of points.

Note

This function can be accessed by:

mdb.models[name].sketches[name].Spline

Note

Check Spline on help.3ds.com/0.1..

Parameters:

• points (tuple) – A sequence of pairs of Floats specifying the points through which the spline passes.

• constrainPoints (Union[AbaqusBoolean, bool], default: True) – A Boolean that determines whether the points given are to constrained to always remain on the Spline. The default is True. For a large sequence of points, significant performance gains may be achieved by setting the value to False.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

Spot(point)

This method creates a spot construction point located at the specified coordinates. The spot is added to the vertex repository of the ConstrainedSketch object.

Note

This function can be accessed by:

mdb.models[name].sketches[name].Spot

Note

Check Spot on help.3ds.com/0.1..

Parameters:

point (Tuple[float, ...]) – A pair of Floats specifying the coordinates of the spot construction point.

Returns:

geometry – A ConstrainedSketchGeometry object

Return type:

ConstrainedSketchGeometry

getPointAtDistance(point, distance, percentage=OFF)

This method returns a point offset along the given ConstrainedSketchGeometry from the given end by a specified arc length distance or a percentage of the total length of the ConstrainedSketchGeometry object.

Note

Check ConstrainedSketchGeometryModel.getPointAtDistance on help.3ds.com/0.1..

Parameters:

• point (Tuple[float, ...]) – A pair of Floats specifying the point from which the distance is to be measured.

• distance (str) – A float specifying the arc length distance along the ConstrainedSketchGeometry from the point at which the required point is situated.

• percentage (Union[AbaqusBoolean, bool], default: OFF) – A Boolean that specifies if the distance is an absolute distance or is a fraction relative to the length of the ConstrainedSketchGeometry object.

Returns:

points – A pair of floats representing the point along the edge

Return type:

Tuple[float, ]

getSize()

This method returns the length of the given ConstrainedSketchGeometry object.

Returns:

length – The length of the given ConstrainedSketchGeometry

Return type:

int

getVertices()

This method returns an list of ConstrainedSketchVertex objects which are a part of the given ConstrainedSketchGeometry object.

Returns:

vertices – A list of ConstrainedSketchVertex objects

Return type:

List[ConstrainedSketchVertex]

ConstrainedSketchParameterModel

class ConstrainedSketchParameterModel

A ConstrainedSketch object contains the entities that are used to create a sketch. The objects include ConstrainedSketchGeometry objects contained in the ConstrainedSketchGeometry Repository, such as Line, Arc, and Spline. ConstrainedSketchVertex, ConstrainedSketchDimension, ConstrainedSketchConstraint, and ConstrainedSketchParameter objects are contained in their respective repositories.

Note

This object can be accessed by:

import sketch
mdb.models[name].sketches[name]

Note

Check ConstrainedSketchParameterModel on help.3ds.com/0.1..

Public Data Attributes:

Inherited from ConstrainedSketchBase

constraints	A repository of ConstrainedSketchConstraint objects.
dimensions	A repository of ConstrainedSketchDimension objects.
geometry	A ConstrainedSketchGeometryArray object specifying the sketch geometry, such as lines, arcs, circles, and splines.
parameters	A repository of ConstrainedSketchParameter objects specifying sketch parameters, which may be associated with dimensions.
sketchOptions	A ConstrainedSketchOptions object specifying the sketch option settings.
vertices	A ConstrainedSketchVertexArray object.
imageOptions	A ConstrainedSketchImageOptions object.

Public Methods:

ConstrainedSketchParameter(name[, path, ...])

This method creates a parameter and optionally associates a dimension with this parameter.

---

ConstrainedSketchParameter(name, path='', expression='', previousParameter='')

This method creates a parameter and optionally associates a dimension with this parameter.

Note

This function can be accessed by:

mdb.models[name].sketches[name].ConstrainedSketchParameter

Note

Check ConstrainedSketchParameter on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the name of the ConstrainedSketchParameter object. No two parameters in the same ConstrainedSketch can have the same name.

• path (str, default: '') – A String specifying the ConstrainedSketchDimension object with which this parameter is associated.

• expression (str, default: '') – A String specifying the expression or value associated with the ConstrainedSketchParameter.

• previousParameter (str, default: '') – A String specifying the name of the previous ConstrainedSketchParameter, if it exists. The previousParameter argument implies an order among the parameters. No two parameters can reference the same parameter as the previous parameter.

Returns:

obj – A ConstrainedSketchParameter object

Return type:

ConstrainedSketchParameter

ConstrainedSketchVertexModel

class ConstrainedSketchVertexModel

A ConstrainedSketch object contains the entities that are used to create a sketch. The objects include ConstrainedSketchGeometry objects contained in the ConstrainedSketchGeometry Repository, such as Line, Arc, and Spline. ConstrainedSketchVertex, ConstrainedSketchDimension, ConstrainedSketchConstraint, and ConstrainedSketchParameter objects are contained in their respective repositories.

Note

This object can be accessed by:

import sketch
mdb.models[name].sketches[name]

Note

Check ConstrainedSketchVertexModel on help.3ds.com/0.1..

Public Data Attributes:

Inherited from ConstrainedSketchBase

constraints	A repository of ConstrainedSketchConstraint objects.
dimensions	A repository of ConstrainedSketchDimension objects.
geometry	A ConstrainedSketchGeometryArray object specifying the sketch geometry, such as lines, arcs, circles, and splines.
parameters	A repository of ConstrainedSketchParameter objects specifying sketch parameters, which may be associated with dimensions.
sketchOptions	A ConstrainedSketchOptions object specifying the sketch option settings.
vertices	A ConstrainedSketchVertexArray object.
imageOptions	A ConstrainedSketchImageOptions object.

Public Methods:

Spot(point)

This method creates a spot (construction point) located at the specified coordinates.

---

Spot(point)

This method creates a spot (construction point) located at the specified coordinates.

Note

This function can be accessed by:

mdb.models[name].sketches[name].Spot

Note

Check Spot on help.3ds.com/0.1..

Parameters:

point (Tuple[float, ...]) – A pair of Floats specifying the coordinates of the construction point.

Returns:

vertex – A ConstrainedSketchVertex object (None if the spot cannot be created)

Return type:

ConstrainedSketchVertex

CoincidentConstraint

class CoincidentConstraint(entity1, entity2)

Public Methods:

__init__(entity1, entity2)

This method creates a coincident constraint.

---

ConcentricConstraint

class ConcentricConstraint(entity1, entity2)

Public Methods:

__init__(entity1, entity2)

This method creates a concentric constraint.

---

ConstrainedSketchConstraint

class ConstrainedSketchConstraint

The ConstrainedSketchConstraint object stores the constraints associated with a sketch.

Note

This object can be accessed by:

import sketch
mdb.models[name].sketches[name].constraints[i]

Note

Check ConstrainedSketchConstraint on help.3ds.com/0.1..

---

EqualDistanceConstraint

class EqualDistanceConstraint(entity1, entity2, midpoint)

Public Methods:

__init__(entity1, entity2, midpoint)

This method creates an equal distance constraint.

---

EqualLengthConstraint

class EqualLengthConstraint(entity1, entity2)

Public Methods:

__init__(entity1, entity2)

This method creates an equal length constraint.

---

EqualRadiusConstraint

class EqualRadiusConstraint(entity1, entity2)

Public Methods:

__init__(entity1, entity2)

This method creates an equal radius constraint.

---

FixedConstraint

class FixedConstraint(entity)

Public Methods:

__init__(entity)

This method creates a fixed constraint.

---

HorizontalConstraint

class HorizontalConstraint(entity)

Public Methods:

__init__(entity)

This method creates a horizontal constraint.

---

ParallelConstraint

class ParallelConstraint(entity1, entity2)

Public Methods:

__init__(entity1, entity2)

This method creates a parallel constraint.

---

PerpendicularConstraint

class PerpendicularConstraint(entity1, entity2)

Public Methods:

__init__(entity1, entity2)

This method creates a perpendicular constraint.

---

TangentConstraint

class TangentConstraint(entity1, entity2)

Public Methods:

__init__(entity1, entity2)

This method creates a tangent constraint.

---

VerticalConstraint

class VerticalConstraint(entity)

Public Methods:

__init__(entity)

This method creates a vertical constraint.

---

AngularDimension

class AngularDimension(line1, line2, textPoint, value=None, reference=OFF)

Public Methods:

__init__(line1, line2, textPoint[, value, ...])

This method constructs a ConstrainedSketchDimension object between two ConstrainedSketchGeometry objects, with the given angle between them.

---

DistanceDimension

class DistanceDimension(entity1, entity2, textPoint, value=None, reference=OFF)

Public Methods:

__init__(entity1, entity2, textPoint[, ...])

This method constructs a ConstrainedSketchDimension object between two ConstrainedSketchGeometry, or aConstrainedSketchVertex and ConstrainedSketchGeometry object.

---

HorizontalDimension

class HorizontalDimension(vertex1, vertex2, textPoint, value=None, reference=OFF)

Public Methods:

__init__(vertex1, vertex2, textPoint[, ...])

This method constructs a ConstrainedSketchDimension object between two vertices.

---

ObliqueDimension

class ObliqueDimension(vertex1, vertex2, textPoint, value=None, reference=OFF)

Public Methods:

__init__(vertex1, vertex2, textPoint[, ...])

This method constructs a ConstrainedSketchDimension object between two vertices.

---

RadialDimension

class RadialDimension(curve, textPoint, value=None, reference=OFF, majorRadius=None, minorRadius=None)

Public Methods:

__init__(curve, textPoint[, value, ...])

This method constructs a ConstrainedSketchDimension object on a circular or elliptical arc.

---

VerticalDimension

class VerticalDimension(vertex1, vertex2, textPoint, value=None, reference=OFF)

Public Methods:

__init__(vertex1, vertex2, textPoint[, ...])

This method constructs a ConstrainedSketchDimension between two vertices.

---

ConstrainedSketchGeometry

class ConstrainedSketchGeometry

The ConstrainedSketchGeometry object stores the geometry of a sketch, such as lines, circles, arcs, and construction lines.

Note

This object can be accessed by:

import sketch
mdb.models[name].sketches[name].geometry[i]
mdb.models[name].sketches[name].geometry[i][i]

Note

Check ConstrainedSketchGeometry on help.3ds.com/0.1..

Public Data Attributes:

id	An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.
curveType	A SymbolicConstant specifying the geometry of the sketch entity.
type	A SymbolicConstant specifying the type of sketch entity.
pointOn	A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

---

curveType: Optional[SymbolicConstant] = None

A SymbolicConstant specifying the geometry of the sketch entity. Possible values are ARC, CIRCLE, ELLIPSE, LINE, and SPLINE.

id: Optional[int] = None

An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.

pointOn: Optional[float] = None

A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

type: Optional[SymbolicConstant] = None

A SymbolicConstant specifying the type of sketch entity. Possible values are REGULAR, REFERENCE, and CONSTRUCTION.

ConstrainedSketchGeometryArray

class ConstrainedSketchGeometryArray(iterable=(), /)

The ConstrainedSketchGeometryArray is a sequence of ConstrainedSketchGeometry objects.

Note

This object can be accessed by:

import sketch
mdb.models[name].sketches[name].geometry[i]

Note

Check ConstrainedSketchGeometryArray on help.3ds.com/0.1..

Public Methods:

findAt(coordinates[, printWarning])

This method returns the ConstrainedSketchGeometry object located at the given coordinates.

Inherited from list

__repr__()	Return repr(self).
__getattribute__(name, /)	Return getattr(self, name).
__lt__(value, /)	Return self<value.
__le__(value, /)	Return self<=value.
__eq__(value, /)	Return self==value.
__ne__(value, /)	Return self!=value.
__gt__(value, /)	Return self>value.
__ge__(value, /)	Return self>=value.
__iter__()	Implement iter(self).
__init__(*args, **kwargs)
__len__()	Return len(self).
__getitem__	x.__getitem__(y) <==> x[y]
__setitem__(key, value, /)	Set self[key] to value.
__delitem__(key, /)	Delete self[key].
__add__(value, /)	Return self+value.
__mul__(value, /)	Return self*value.
__rmul__(value, /)	Return value*self.
__contains__(key, /)	Return key in self.
__iadd__(value, /)	Implement self+=value.
__imul__(value, /)	Implement self*=value.
__reversed__()	Return a reverse iterator over the list.
__sizeof__()	Return the size of the list in memory, in bytes.
clear()	Remove all items from list.
copy()	Return a shallow copy of the list.
append(object, /)	Append object to the end of the list.
insert(index, object, /)	Insert object before index.
extend(iterable, /)	Extend list by appending elements from the iterable.
pop([index])	Remove and return item at index (default last).
remove(value, /)	Remove first occurrence of value.
index(value[, start, stop])	Return first index of value.
count(value, /)	Return number of occurrences of value.
reverse()	Reverse IN PLACE.
sort(*[, key, reverse])	Sort the list in ascending order and return None.
__class_getitem__	See PEP 585

Inherited from Generic

__class_getitem__	See PEP 585
__init_subclass__(*args, **kwargs)	This method is called when a class is subclassed.

Private Data Attributes:

Inherited from Generic

_is_protocol

---

findAt(coordinates, printWarning=True)

This method returns the ConstrainedSketchGeometry object located at the given coordinates.

Note

Check ConstrainedSketchGeometryArray.findAt on help.3ds.com/0.1..

Parameters:

• coordinates (tuple) – A sequence of Floats specifying the X- and Y-coordinates of the object to find.

• printWarning (Union[AbaqusBoolean, bool], default: True) – A Boolean specifying whether a message is to be printed to the CLI if no entity is found at the specified location. The default value is True.

Returns:

A ConstrainedSketchGeometry object.

Return type:

ConstrainedSketchGeometry

Arc3Points

class Arc3Points(point1, point2, point3)

Public Data Attributes:

Inherited from ConstrainedSketchGeometry

id	An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.
curveType	A SymbolicConstant specifying the geometry of the sketch entity.
type	A SymbolicConstant specifying the type of sketch entity.
pointOn	A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

Public Methods:

__init__(point1, point2, point3)

This method constructs an arc using a two endpoints and an intermediate third point on the arc.

---

ArcByCenterEnds

class ArcByCenterEnds(center, point1, point2, direction)

Public Data Attributes:

Inherited from ConstrainedSketchGeometry

id	An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.
curveType	A SymbolicConstant specifying the geometry of the sketch entity.
type	A SymbolicConstant specifying the type of sketch entity.
pointOn	A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

Public Methods:

__init__(center, point1, point2, direction)

This method constructs an arc using a center point and two vertices.

---

ArcByStartEndTangent

class ArcByStartEndTangent(point1, point2, vector)

Public Data Attributes:

Inherited from ConstrainedSketchGeometry

id	An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.
curveType	A SymbolicConstant specifying the geometry of the sketch entity.
type	A SymbolicConstant specifying the type of sketch entity.
pointOn	A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

Public Methods:

__init__(point1, point2, vector)

This method constructs an arc using two vertices.

---

CircleByCenterPerimeter

class CircleByCenterPerimeter(center, point1)

Public Data Attributes:

Inherited from ConstrainedSketchGeometry

id	An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.
curveType	A SymbolicConstant specifying the geometry of the sketch entity.
type	A SymbolicConstant specifying the type of sketch entity.
pointOn	A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

Public Methods:

__init__(center, point1)

This method constructs a circle using a center point and a point on the perimeter.

---

ConstructionCircleByCenterPerimeter

class ConstructionCircleByCenterPerimeter(center, point1)

Public Data Attributes:

Inherited from ConstrainedSketchGeometry

id	An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.
curveType	A SymbolicConstant specifying the geometry of the sketch entity.
type	A SymbolicConstant specifying the type of sketch entity.
pointOn	A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

Public Methods:

__init__(center, point1)

This method constructs a construction circle using a center point and a point on the perimeter.

---

ConstructionLine

class ConstructionLine(point1, point2)

Public Data Attributes:

Inherited from ConstrainedSketchGeometry

id	An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.
curveType	A SymbolicConstant specifying the geometry of the sketch entity.
type	A SymbolicConstant specifying the type of sketch entity.
pointOn	A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

Public Methods:

__init__(point1, point2)

This method creates an oblique construction line that runs between two given points.

---

EllipseByCenterPerimeter

class EllipseByCenterPerimeter(center, axisPoint1, axisPoint2)

Public Data Attributes:

Inherited from ConstrainedSketchGeometry

id	An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.
curveType	A SymbolicConstant specifying the geometry of the sketch entity.
type	A SymbolicConstant specifying the type of sketch entity.
pointOn	A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

Public Methods:

__init__(center, axisPoint1, axisPoint2)

This method constructs an ellipse using a center point, a major axis point, and a minor axis point.

---

FilletByRadius

class FilletByRadius(radius, curve1, nearPoint1, curve2, nearPoint2)

Public Data Attributes:

Inherited from ConstrainedSketchGeometry

id	An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.
curveType	A SymbolicConstant specifying the geometry of the sketch entity.
type	A SymbolicConstant specifying the type of sketch entity.
pointOn	A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

Public Methods:

__init__(radius, curve1, nearPoint1, curve2, ...)

This method constructs a fillet arc of a given radius between two curves.

---

getPointAtDistance

class getPointAtDistance(point, distance, percentage=OFF)

Public Data Attributes:

Inherited from ConstrainedSketchGeometry

id	An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.
curveType	A SymbolicConstant specifying the geometry of the sketch entity.
type	A SymbolicConstant specifying the type of sketch entity.
pointOn	A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

Public Methods:

__init__(point, distance[, percentage])

This method returns a point offset along the given ConstrainedSketchGeometry from the given end by a specified arc length distance or a percentage of the total length of the ConstrainedSketchGeometry object.

---

Line

class Line(point1, point2)

Public Data Attributes:

Inherited from ConstrainedSketchGeometry

id	An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.
curveType	A SymbolicConstant specifying the geometry of the sketch entity.
type	A SymbolicConstant specifying the type of sketch entity.
pointOn	A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

Public Methods:

__init__(point1, point2)

This method creates a line between two given points.

---

Spline

class Spline(points, constrainPoints=True)

Public Data Attributes:

Inherited from ConstrainedSketchGeometry

id	An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.
curveType	A SymbolicConstant specifying the geometry of the sketch entity.
type	A SymbolicConstant specifying the type of sketch entity.
pointOn	A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

Public Methods:

__init__(points[, constrainPoints])

This method creates a spline curve running through a sequence of points.

---

Spot

class Spot(point)

Public Data Attributes:

Inherited from ConstrainedSketchGeometry

id	An Int specifying the index of the sketch entity in the ConstrainedSketchGeometryArray.
curveType	A SymbolicConstant specifying the geometry of the sketch entity.
type	A SymbolicConstant specifying the type of sketch entity.
pointOn	A tuple of Floats specifying the X- and*Y*-coordinates of a point located on the geometry.

Public Methods:

__init__(point)

This method creates a spot construction point located at the specified coordinates.

---

ConstrainedSketcherOptions

class ConstrainedSketcherOptions

The ConstrainedSketcherOptions object is used to store values and attributes which will be applied to all sketches used in the current session. The ConstrainedSketcherOptions object has no constructor.

Note

This object can be accessed by:

import sketch
session.sketcherOptions

Note

Check ConstrainedSketcherOptions on help.3ds.com/0.1..

Public Methods:

setValues([constructionGeometry, gridSnap, ...])

This method modifies the ConstrainedSketchOptions object.

---

setValues(constructionGeometry=ON, gridSnap=ON, preselection=ON, addImpliedConstraints=ON, maxCoplanarEntities=300, autoConstrainAngularTolerance=0, autoConstrainLinearTolerance=None, autoConstrainOptions=None, dragMethod=abaqusConstants.MINIMUM_MOVE, editMethod=abaqusConstants.STANDARD)

This method modifies the ConstrainedSketchOptions object.

Note

Check ConstrainedSketcherOptions.setValues on help.3ds.com/0.1..

Parameters:

• constructionGeometry (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether construction geometry is shown. The default value is ON.

• gridSnap (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether the cursor snaps to the grid. The default value is ON.

• preselection (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether geometry will be preselected. The default value is ON.

• addImpliedConstraints (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying if implied constraints are added during sketching. The default value is ON.

• maxCoplanarEntities (int, default: 300) – An Int specifying the maximum number of coplanar entities which should be automatically projected from the background, when a sketch based feature is created or edited. When this value is exceeded no entities are automatically projected and a warning issued. Possible values are maxCoplanarEntities >> 0. The default value is 300.

• autoConstrainAngularTolerance (float, default: 0) – A Float specifying the angular tolerance in degrees which is used to determine parallel and tangential conditions during the auto-constrain operation. For example any two lines which have an angle smaller than the given autoConstrainAngularTolerance will be assumed to be parallel, and a parallel constrain may be added during the auto-constrain operation. The default value is 0.01.

• autoConstrainLinearTolerance (Optional[float], default: None) – A Float specifying the linear tolerance which is used to determine when two points or geometries are coincident during the auto-constrain operation. The default value is 10-6.

• autoConstrainOptions (Optional[SymbolicConstant], default: None) – A sequence of SymbolicConstants specifying which type of constraints may be added by the auto-constraint tool. Possible values are PARALLEL, PERPENDICULAR, IDENTICAL, TANGENT, CONCENTRIC, and EQUALRADIUS. The default value is (PARALLEL,, PERPENDICULAR,, IDENTICAL,, TANGENT,, CONCENTRIC,, EQUALRADIUS).

• dragMethod (SymbolicConstant, default: MINIMUM_MOVE) – A SymbolicConstant specifying the constraint solving mode used by the sketcher during drag operation. Possible values are MINIMUM_MOVE, STANDARD, WEIGHTED, and RELAXATION. The default value is MINIMUM_MOVE.

• editMethod (SymbolicConstant, default: STANDARD) – A SymbolicConstant specifying the constraint solving mode used by the sketcher during regular sketch editing and adding new constraints and dimensions. Possible values are MINIMUM_MOVE, STANDARD, WEIGHTED, and RELAXATION. The default value is STANDARD.

Raises:

RangeError –

ConstrainedSketchImageOptions

class ConstrainedSketchImageOptions

The ConstrainedSketchImageOptions object is used to store values and attributes associated with the background image for a particular sketch. The ConstrainedSketchImageOptions object has no constructor.

Note

This object can be accessed by:

import sketch
mdb.models[name].sketches[name].imageOptions

Note

Check ConstrainedSketchImageOptions on help.3ds.com/0.1..

Public Methods:

setValues([imageName, showImage, origin, ...])

This method modifies the ConstrainedSketchOptions object.

---

setValues(imageName='', showImage=OFF, origin=(), xScale=1, yScale=1, translucency=1)

This method modifies the ConstrainedSketchOptions object.

Note

Check ConstrainedSketchImageOptions.setValues on help.3ds.com/0.1..

Parameters:

• imageName (str, default: '') – A String specifying the name of the image. A list of valid image names is in the images repository in the session object.

• showImage (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether an image should be displayed in the sketcher background. The default value is OFF.

• origin (Tuple[float, ...], default: ()) – A pair of Floats specifying the X- and Y-offsets in millimeters from the lower-left corner of the viewport. The default value is (0, 0).

• xScale (float, default: 1) – A Float specifying the scale applied to the image width. The default value is 1.0.When xScale is negative, the image is mirrored about its y-axis but its position is not affected.

• yScale (float, default: 1) – A Float specifying the scale applied to the image height. The default value is 1.0.When yScale is negative, the image is mirrored about its x-axis but its position is not affected.

• translucency (float, default: 1) – A Float specifying the translucency factor to use when displaying the image. Possible values are 0.0 ≤ translucency ≤ 1.0 with 0.0 being invisible and 1.0 being opaque. The default value is 1.0.

Raises:

RangeError –

ConstrainedSketchOptions

class ConstrainedSketchOptions

The ConstrainedSketchOptions object is used to store values and attributes associated with a particular sketch. The ConstrainedSketchOptions object has no constructor.

Note

This object can be accessed by:

import sketch
mdb.models[name].sketches[name].sketchOptions

Note

Check ConstrainedSketchOptions on help.3ds.com/0.1..

Public Methods:

setValues([sheetSize, gridSpacing, grid, ...])

This method modifies the ConstrainedSketchOptions object.

---

setValues(sheetSize=None, gridSpacing=None, grid=ON, gridFrequency=1, dimensionTextHeight=12, decimalPlaces=None, constructionGeometry=ON, gridSnap=ON, preselection=ON, sheetAuto=ON, gridOrigin=(), gridAngle=0, viewStyle=abaqusConstants.REGULAR, addImpliedConstraints=ON, maxCoplanarEntities=300, autoConstrainAngularTolerance=0, autoConstrainLinearTolerance=None, autoConstrainOptions=None, dragMethod=abaqusConstants.MINIMUM_MOVE, editMethod=abaqusConstants.STANDARD)

This method modifies the ConstrainedSketchOptions object.

Note

Check ConstrainedSketchOptions.setValues on help.3ds.com/0.1..

Parameters:

• sheetSize (Optional[float], default: None) – A Float specifying the sheet size. Possible values are Floats >> 0. The default value is the sheetSize specified with the Sketch method.

• gridSpacing (Optional[float], default: None) – A Float specifying the spacing between gridlines. Possible values are Floats >> 0. The default value is approximately 2.5% of sheetSize.

• grid (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether the grid is shown. The default value is ON.

• gridFrequency (int, default: 1) – An Int specifying how often gridlines are shown. Possible values are gridFrequency >> 0. The default value is 1.

• dimensionTextHeight (float, default: 12) – A Float specifying the height of the dimension text in points. Possible values are Floats >> 0. The default value is 12.0.

• decimalPlaces (Optional[int], default: None) – An Int specifying how many decimal places are shown in dimensions. Possible values are 0 ≤ decimalPlaces ≤ 6. The initial value depends on the value of sheetSize.

• constructionGeometry (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether construction geometry is shown. The default value is ON.

• gridSnap (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether the cursor snaps to the grid. The default value is ON.

• preselection (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying whether geometry will be preselected. The default value is ON.

• sheetAuto (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying if the sheet size and the grid spacing are automatically computed. The default value is ON.

• gridOrigin (tuple, default: ()) – A sequence of Floats specifying the X - Y coordinates for the origin of the grid. The default value is (0, 0).

• gridAngle (float, default: 0) – A Float specifying the angle of the grid relative to the computer screen. The default value is 0.0.

• viewStyle (SymbolicConstant, default: REGULAR) – A SymbolicConstant specifying the type of sketch displayed in the viewport. Possible values are REGULAR and AXISYM. The default value is REGULAR.

• addImpliedConstraints (Union[AbaqusBoolean, bool], default: ON) – A Boolean specifying if implied constraints are added during sketching. The default value is ON.

• maxCoplanarEntities (int, default: 300) – An Int specifying the maximum number of coplanar entities which should be automatically projected from the background, when a sketch based feature is created or edited. When this value is exceeded no entities are automatically projected and a warning issued. Possible values are maxCoplanarEntities >> 0. The default value is 300.

• autoConstrainAngularTolerance (float, default: 0) – A Float specifying the angular tolerance in degrees which is used to determine parallel and tangential conditions during the auto-constrain operation. For example any two lines which have an angle smaller than the given autoConstrainAngularTolerance will be assumed to be parallel, and a parallel constrain may be added during the auto-constrain operation. The default value is 0.01.

• autoConstrainLinearTolerance (Optional[float], default: None) – A Float specifying the linear tolerance which is used to determine when two points or geometries are coincident during the auto-constrain operation. The default value is 10-6.

• autoConstrainOptions (Optional[SymbolicConstant], default: None) – A sequence of SymbolicConstants specifying which type of constraints may be added by the auto-constraint tool. Possible values are PARALLEL, PERPENDICULAR, IDENTICAL, TANGENT, CONCENTRIC, and EQUALRADIUS. The default value is (PARALLEL,, PERPENDICULAR,, IDENTICAL,, TANGENT,, CONCENTRIC,, EQUALRADIUS).

• dragMethod (SymbolicConstant, default: MINIMUM_MOVE) – A SymbolicConstant specifying the constraint solving mode used by the sketcher during drag operation. Possible values are MINIMUM_MOVE, STANDARD, WEIGHTED, and RELAXATION. The default value is MINIMUM_MOVE.

• editMethod (SymbolicConstant, default: STANDARD) – A SymbolicConstant specifying the constraint solving mode used by the sketcher during regular sketch editing and adding new constraints and dimensions. Possible values are MINIMUM_MOVE, STANDARD, WEIGHTED, and RELAXATION. The default value is STANDARD.

Raises:

RangeError –

Parameter

class Parameter(name, path='', expression='', previous='')

Public Data Attributes:

Inherited from ConstrainedSketchParameter

name	A String specifying the name of the ConstrainedSketchParameter object.
path	A String specifying the path to the ConstrainedSketchDimension that depends on this ConstrainedSketchParameter.
expression	A String specifying an expression or value associated with this ConstrainedSketchParameter.
previousParameter	A String specifying the name of the ConstrainedSketchParameter that appears before this one in the ordered list.

Public Methods:

__init__(name[, path, expression, previous])

This method creates a parameter and optionally associates a dimension with this parameter.

Inherited from ConstrainedSketchParameter

Parameter(name[, path, expression, ...])

This method creates a parameter and optionally associates a dimension with this parameter.

---

ConstrainedSketchVertex

class ConstrainedSketchVertex

The ConstrainedSketchVertex object stores the vertex position.

Note

This object can be accessed by:

import sketch
mdb.models[name].sketches[name].vertices[i]
mdb.models[name].sketches[name].vertices[i][i]

Note

Check ConstrainedSketchVertex on help.3ds.com/0.1..

Public Data Attributes:

coords

A tuple of Floats specifying the*X*-, Y-, and Z-coordinates of the sketch vertex.

Public Methods:

Spot(point)

This method creates a spot (construction point) located at the specified coordinates.

---

Spot(point)

This method creates a spot (construction point) located at the specified coordinates.

Note

This function can be accessed by:

mdb.models[name].sketches[name].Spot

Note

Check Spot on help.3ds.com/0.1..

Parameters:

point (Tuple[float, ...]) – A pair of Floats specifying the coordinates of the construction point.

Returns:

A ConstrainedSketchVertex object (None if the spot cannot be created).

Return type:

ConstrainedSketchVertex

coords: Optional[float] = None

A tuple of Floats specifying the*X*-, Y-, and Z-coordinates of the sketch vertex.

ConstrainedSketchVertexArray

class ConstrainedSketchVertexArray(iterable=(), /)

The ConstrainedSketchVertexArray is a sequence of ConstrainedSketchVertex objects.

Note

This object can be accessed by:

import sketch
mdb.models[name].sketches[name].vertices[i]

Note

Check ConstrainedSketchVertexArray on help.3ds.com/0.1..

Public Methods:

findAt(coordinates[, printWarning])

This method returns the ConstrainedSketchVertex located at the given coordinates.

Inherited from list

__repr__()	Return repr(self).
__getattribute__(name, /)	Return getattr(self, name).
__lt__(value, /)	Return self<value.
__le__(value, /)	Return self<=value.
__eq__(value, /)	Return self==value.
__ne__(value, /)	Return self!=value.
__gt__(value, /)	Return self>value.
__ge__(value, /)	Return self>=value.
__iter__()	Implement iter(self).
__init__(*args, **kwargs)
__len__()	Return len(self).
__getitem__	x.__getitem__(y) <==> x[y]
__setitem__(key, value, /)	Set self[key] to value.
__delitem__(key, /)	Delete self[key].
__add__(value, /)	Return self+value.
__mul__(value, /)	Return self*value.
__rmul__(value, /)	Return value*self.
__contains__(key, /)	Return key in self.
__iadd__(value, /)	Implement self+=value.
__imul__(value, /)	Implement self*=value.
__reversed__()	Return a reverse iterator over the list.
__sizeof__()	Return the size of the list in memory, in bytes.
clear()	Remove all items from list.
copy()	Return a shallow copy of the list.
append(object, /)	Append object to the end of the list.
insert(index, object, /)	Insert object before index.
extend(iterable, /)	Extend list by appending elements from the iterable.
pop([index])	Remove and return item at index (default last).
remove(value, /)	Remove first occurrence of value.
index(value[, start, stop])	Return first index of value.
count(value, /)	Return number of occurrences of value.
reverse()	Reverse IN PLACE.
sort(*[, key, reverse])	Sort the list in ascending order and return None.
__class_getitem__	See PEP 585

Inherited from Generic

__class_getitem__	See PEP 585
__init_subclass__(*args, **kwargs)	This method is called when a class is subclassed.

Private Data Attributes:

Inherited from Generic

_is_protocol

---

findAt(coordinates, printWarning=True)

This method returns the ConstrainedSketchVertex located at the given coordinates.

Note

Check ConstrainedSketchVertexArray.findAt on help.3ds.com/0.1..

Parameters:

• coordinates (tuple) – A sequence of Floats specifying the X- and Y-coordinates of the object to find.

• printWarning (Union[AbaqusBoolean, bool], default: True) – A Boolean specifying whether a message is to be printed to the CLI if no entity is found at the specified location. The default value is True.

Returns:

A ConstrainedSketchVertex object.

Return type:

ConstrainedSketchVertex

Spot

class Spot(point)

Public Data Attributes:

Inherited from ConstrainedSketchVertex

coords

A tuple of Floats specifying the*X*-, Y-, and Z-coordinates of the sketch vertex.

Public Methods:

__init__(point)

This method creates a spot (construction point) located at the specified coordinates.

Inherited from ConstrainedSketchVertex

Spot(point)

This method creates a spot (construction point) located at the specified coordinates.

---