Documentation

Support

Asset Transformer SDK

Version:

User Manual

Python API

C# API

Changelog

Discussions

Asset Transformer SDK

Version:

CAD

Python API functions

Read time 102 minutes

Last updated a month ago

configureFunctionLogger


cad.configureFunctionLogger(functionName, enableFunction, enableParameters, enableExecutionTime)

Parameters

Type	Name	Description
String	functionName
Boolean	enableFunction
Boolean	enableParameters
Boolean	enableExecutionTime

getPrecision

Get the CAD precision.


cad.getPrecision() -> geom.Distance

Returns

Type	Name	Description
Distance	precision	The current precision.

getUnitLength

Get the CAD unity length property.


cad.getUnitLength() -> geom.Distance

Returns

Type	Name	Description
Distance	precision	The current unit length.

setUnitLength

Set the CAD unity length property.


cad.setUnitLength(precision=0.02)

Parameters

Type	Name	Description
Distance	precision	Unit length.

Boolean Operators

solidIntersection

Perform boolean operation intersection on two bodies (A ^ B).


cad.solidIntersection(A, B) -> cad.BodyList

Parameters

Type	Name	Description
Body	A	The first body.
Body	B	The second body.

Returns

Type	Name	Description
BodyList	result	List of resulting bodies.

See also:

solidSubtraction

Perform boolean operation subtraction on two bodies (A - B).


cad.solidSubtraction(A, B) -> cad.BodyList

Parameters

Type	Name	Description
Body	A	The first body.
Body	B	The second body.

Returns

Type	Name	Description
BodyList	result	List of resulting bodies.

See also:

solidUnion

Perform boolean operation union on two bodies (A + B).


cad.solidUnion(A, B) -> cad.BodyList

Parameters

Type	Name	Description
Body	A	The first body.
Body	B	The second body.

Returns

Type	Name	Description
BodyList	result	List of resulting bodies.

See also:

curves

createBezierCurve

Create a Bezier curve.


cad.createBezierCurve(poles) -> cad.Curve

Parameters

Type	Name	Description
Point3List	poles	Poles list.

Returns

Type	Name	Description
Curve	BezierCurve	Bezier curve.

See also:

createCircleCurve

Create a new circle.


cad.createCircleCurve(radius, matrix=geom.IdentityMatrix4) -> cad.Curve

Parameters

Type	Name	Description
Distance	radius	Circle radius.
Matrix4	matrix	Transformation matrix.

Returns

Type	Name	Description
Curve	circleCurve	Generated circle curve.

See also:

createCompositeCurve

Create a composite curve from a list of limited curves.


cad.createCompositeCurve(CurveList) -> cad.Curve

Parameters

Type	Name	Description
CurveList	CurveList	List of limited curves.

Returns

Type	Name	Description
Curve	compositeCurve	Composite curve created from the list of limited curves.

See also:

createCosinusCurve

Create a cosinus curve.


cad.createCosinusCurve(Amplitude, Offset, Period, matrix) -> cad.Curve

Parameters

Type	Name	Description
Distance	Amplitude	Cosinus amplitude.
Distance	Offset	Cosinus offset.
Distance	Period	Cosinus period.
Matrix4	matrix	Transformation matrix.

Returns

Type	Name	Description
Curve	cosinusCurve	Cosinus curve.

See also:

createEllipseCurve

Create an ellipse curve.


cad.createEllipseCurve(URadius, VRadius, matrix=geom.IdentityMatrix4) -> cad.Curve

Parameters

Type	Name	Description
Distance	URadius	Ellipse radius in u direction.
Distance	VRadius	Ellipse radius in v direction.
Matrix4	matrix	Transformation matrix.

Returns

Type	Name	Description
Curve	ellipseCurve	Ellipse curve.

See also:

createHelixCurve

Create an helix curve.


cad.createHelixCurve(radius, pitch, matrix=geom.IdentityMatrix4, trigonometrixOrientation=True) -> cad.Curve

Parameters

Type	Name	Description
Distance	radius	Radius of the helix.
Distance	pitch	Height of one revolution.
Matrix4	matrix	Transformation matrix.
Boolean	trigonometrixOrientation	Orientation of the rotation.

Returns

Type	Name	Description
Curve	helixCurve	Helix curve.

See also:

createHermiteCurve

Create a Hermite Curve.


cad.createHermiteCurve(FirstPoint, FirstTangent, SecondPoint, SecondTangent) -> cad.Curve

Parameters

Type	Name	Description
Point3	FirstPoint	Starting point of the curve.
Point3	FirstTangent	Tangent of the starting point.
Point3	SecondPoint	Ending point of the curve.
Point3	SecondTangent	Tangent of the ending point.

Returns

Type	Name	Description
Curve	HermiteCurve	Hermite curve.

See also:

createHyperbolaCurve

Create an hyperBola curve.


cad.createHyperbolaCurve(URadius, VRadius, matrix=geom.IdentityMatrix4) -> cad.Curve

Parameters

Type	Name	Description
Double	URadius	Hyperbola radius in u direction.
Double	VRadius	Hyperbola radius in v direction.
Matrix4	matrix	Transformation matrix.

Returns

Type	Name	Description
Curve	parabolaCurve	Hyperbola curve.

See also:

createIntersectionCurve

Create a Intersection Curve.


cad.createIntersectionCurve(firstSurface, secondSurface, chart, minBounds, maxBounds) -> cad.Curve

Parameters

Type	Name	Description
Surface	firstSurface	First surface of the intersection curve.
Surface	secondSurface	Second surface of the intersection curve.
PolylineCurve	chart	Direction curve of the intersection curve.
Double	minBounds	Minimum value of the bounds of the intersection curve.
Double	maxBounds	Maximum value of the bounds of the intersection curve.

Returns

Type	Name	Description
Curve	IntersectionCurve	Intersection curve.

See also:

createLineCurve

Create a Line Curve.


cad.createLineCurve(OriginPt, DirectionPt) -> cad.Curve

Parameters

Type	Name	Description
Point3	OriginPt	Orinin point of the line curve.
Point3	DirectionPt	Direction vector of the line curve.

Returns

Type	Name	Description
Curve	LineCurve	Line curve.

See also:

createNURBSCurve

Create a NURBS curve.


cad.createNURBSCurve(degree, knots, poles, weights=None) -> cad.Curve

Parameters

Type	Name	Description
Int	degree	Degree of the curve.
DoubleList	knots	Knots of the curve.
Point3List	poles	Poles list.
DoubleList	weights	Weight list.

Returns

Type	Name	Description
Curve	NURBSCurve	NURBS curve.

See also:

createParabolaCurve

Create an parabola curve.


cad.createParabolaCurve(focalLength, matrix=geom.IdentityMatrix4) -> cad.Curve

Parameters

Type	Name	Description
Double	focalLength	Focal lecngth of the parabola.
Matrix4	matrix	Transformation matrix.

Returns

Type	Name	Description
Curve	parabolaCurve	Parabola curve.

See also:

createPolylineCurve

Create a Polyline curve.


cad.createPolylineCurve(points, parameters=None) -> cad.Curve

Parameters

Type	Name	Description
Point3List	points	Points of polyline curve.
DoubleList	parameters	Params of polyline curve.

Returns

Type	Name	Description
Curve	polylineCurve	Polyline curve.

See also:

createSegmentCurve

Create a segment curve from two given points.


cad.createSegmentCurve(firstPoint, secondPoint) -> cad.Curve

Parameters

Type	Name	Description
Point3	firstPoint	First point.
Point3	secondPoint	Second point.

Returns

Type	Name	Description
Curve	segmentCurve	Segment curve created from the two given points.

See also:

createSurfacicCurve

Create a curve from a surface.


cad.createSurfacicCurve(surface, curve2D) -> cad.Curve

Parameters

Type	Name	Description
Surface	surface	Surface to bound.
Curve	curve2D	Curve to project.

Returns

Type	Name	Description
Curve	surfacicCurve	Curve projected on given surface.

See also:

createTransformedCurve

Create a curve from a surface.


cad.createTransformedCurve(curve, matrix=geom.IdentityMatrix4) -> cad.Curve

Parameters

Type	Name	Description
Curve	curve	Curve to transform.
Matrix4	matrix	Matrix of the transformation.

Returns

Type	Name	Description
Curve	transformedCurve	Curve transformed by the given matrix.

See also:

invertCurve

Invert a curve parametricaly.


cad.invertCurve(curve, precision) -> cad.Curve

Parameters

Type	Name	Description
Curve	curve	The curve to invert.
Double	precision	The precision used to invert the curve.

Returns

Type	Name	Description
Curve	invertedCurve	The inverted curve.

See also:

extrusion creation

createBoundedLinearExtrusion

Create a linear extrusion body.


cad.createBoundedLinearExtrusion(direction, planeOrigin, planeNormal, profileBase, startingNormal, boundaryType=0, profileEnd=None) -> cad.CADEntity

Parameters

Type	Name	Description
Vector3	direction	The profile curves will be extruded in this direction.
Point3	planeOrigin	The origin of the plane that bound the extrusion.
Vector3	planeNormal	The normal of the plane that bound the extrusion.
ProfileBase	profileBase	Profile loops to extrude.
Vector3	startingNormal	The normal of the plane in which all starting profile lie on.
ExtrusionBoundaryType	boundaryType	If the profile curves define an area or not.
ProfileBase	profileEnd	The end profile of the extrusion.

Returns

Type	Name	Description
CADEntity	boundedLinearExtrusion	The created body or shell.

See also:

createCurveExtrusion

Create a curve extrusion body.


cad.createCurveExtrusion(curve, profileBase, startingNormal, boundaryType=0, profileEnd=None) -> cad.CADEntity

Parameters

Type	Name	Description
Curve	curve	The profile curves will be extruded along this curve.
ProfileBase	profileBase	Profile loops to extrude.
Vector3	startingNormal	The normal of the plane in which all starting profile lie one.
ExtrusionBoundaryType	boundaryType	If the profile curves define an area or not.
ProfileBase	profileEnd	The end profile of the extrusion.

Returns

Type	Name	Description
CADEntity	curveExtrusion	The created body or shell.

See also:

createLinearExtrusion

Create a linear extrusion body.


cad.createLinearExtrusion(direction, depth, profileBase, startingNormal, boundaryType=0, profileEnd=None) -> cad.CADEntity

Parameters

Type	Name	Description
Vector3	direction	The profile curves will be extruded in this direction.
Double	depth	The extrusion will stop at the defined depth.
ProfileBase	profileBase	Profile loops to extrude.
Vector3	startingNormal	The normal of the plane in which all starting profile lie on.
ExtrusionBoundaryType	boundaryType	If the profile curves define an area or not.
ProfileBase	profileEnd	The end profile of the extrusion.

Returns

Type	Name	Description
CADEntity	linearExtrusion	The created body or shell.

See also:

createMultiExtrusion

Create a linear extrusion body.


cad.createMultiExtrusion(profileBaseList, profileExtrusionList, boundaryType=0) -> cad.CADEntity

Parameters

Type	Name	Description
ProfileBaseList	profileBaseList	Profile loops to be extruded.
CurveListList	profileExtrusionList	Extrusion profiles.
ExtrusionBoundaryType	boundaryType	If the profile curves define an area or not.

Returns

Type	Name	Description
CADEntity	multiLinearExtrusion	The created body or shell.

See also:

createRevolveExtrusion

Create a revolved extrusion body.


cad.createRevolveExtrusion(center, axis, angle, profileBase, startingNormal, boundaryType=0, profileEnd=None) -> cad.CADEntity

Parameters

Type	Name	Description
Point3	center	The center of revolution.
Vector3	axis	The profile curves will be revolved around this axis.
Double	angle	The revolution will stop at the defined angle.
ProfileBase	profileBase	Profile loops to revolve.
Vector3	startingNormal	The normal of the plane in which all starting profile lie on.
ExtrusionBoundaryType	boundaryType	If the profile curves define an area or not.
ProfileBase	profileEnd	The end profile of the extrusion.

Returns

Type	Name	Description
CADEntity	revolvedExtrusion	The created body or shell.

See also:

material

getFaceMaterial

Get the material on a face.


cad.getFaceMaterial(face) -> material.Material

Parameters

Type	Name	Description
Face	face	The face.

Returns

Type	Name	Description
Material	material	The material.

See also:

cad.setFaceMaterial

setFaceMaterial

Set the material on a face.


cad.setFaceMaterial(face, material)

Parameters

Type	Name	Description
Face	face	The face.
Material	material	The material.

See also:

cad.getFaceMaterial

model management

addBodyToModel

Add a body to the model.


cad.addBodyToModel(body, model)

Parameters

Type	Name	Description
Body	body	Body added to the model.
Model	model	Model.

See also:

addEdgeToModel

Add an edge to the model.


cad.addEdgeToModel(edge, model)

Parameters

Type	Name	Description
Edge	edge	Edge added to the model.
Model	model	Model.

See also:

addOpenShellToModel

Add an open shell to the model.


cad.addOpenShellToModel(shell, model)

Parameters

Type	Name	Description
OpenShell	shell	Open shell added to the model.
Model	model	Model.

See also:

addVertexToModel

Add a vertex to the model.


cad.addVertexToModel(vtx, model)

Parameters

Type	Name	Description
Vertex	vtx	Vertex added to the model.
Model	model	Model.

See also:

buildFaces

Build faces from a surface and a set of loop.


cad.buildFaces(surface, loopList) -> cad.FaceList, cad.SplittedEdgeList

Parameters

Type	Name	Description
Surface	surface	Surface used to build the faces.
LoopList	loopList	List of Loops used to build the faces.

Returns

Type	Name	Description
FaceList	faces	The created faces.
SplittedEdgeList	splittingInfo	Map between the old edges and the new ones.

See also:

createModel

Create a new model.


cad.createModel(precision=-1) -> cad.Model

Parameters

Type	Name	Description
Distance	precision	CAD precision for this model.

Returns

Type	Name	Description
Model	model	The created model.

See also:

endThreadBrepSession

Create a new BrepSession on current thread.


cad.endThreadBrepSession()

See also:

getAllModelFaces

Get all the face of a model recursively.


cad.getAllModelFaces(model) -> cad.FaceList

Parameters

Type	Name	Description
Model	model	Model.

Returns

Type	Name	Description
FaceList	faces	List of faces in the given model.

See also:

getModelBodies

Get the list of bodies contained in a model.


cad.getModelBodies(model) -> cad.BodyList

Parameters

Type	Name	Description
Model	model	Model.

Returns

Type	Name	Description
BodyList	bodies	List of bodies contained in the given model.

See also:

getModelBoundaries

Get boundary edges of a model grouped by cycles.


cad.getModelBoundaries(model) -> cad.EdgeListList

Parameters

Type	Name	Description
Model	model	Model.

Returns

Type	Name	Description
EdgeListList	boundaries	List of boundary edges grouped by cycles in the given model.

See also:

getModelEdges

Get the list of free edges contained in a model.


cad.getModelEdges(model) -> cad.EdgeList

Parameters

Type	Name	Description
Model	model	Model.

Returns

Type	Name	Description
EdgeList	edges	List of edges contained in the given model.

See also:

getModelOpenShells

Get the list of open shells contained in a model.


cad.getModelOpenShells(model) -> cad.OpenShellList

Parameters

Type	Name	Description
Model	model	Model.

Returns

Type	Name	Description
OpenShellList	shells	List of open shells contained in the given model.

See also:

getModelPrecision

Get the precision used in a model.


cad.getModelPrecision(model) -> core.Double

Parameters

Type	Name	Description
Model	model	Model.

Returns

Type	Name	Description
Double	precision	Precision value.

See also:

getModelVertices

Get the list of free vertices contained in a model.


cad.getModelVertices(model) -> cad.VertexList

Parameters

Type	Name	Description
Model	model	Model.

Returns

Type	Name	Description
VertexList	vertices	List of vertices contained in the given model.

See also:

getReferencers

Returns the entities referencing a given CAD entity.


cad.getReferencers(entity) -> core.EntityList

Parameters

Type	Name	Description
CADEntity	entity	CAD entity to get the referencers.

Returns

Type	Name	Description
EntityList	referencers	List of CAD entities referencing the given entity.

See also:

startThreadBrepSession

Create a new BrepSession on current thread.


cad.startThreadBrepSession(precision)

Parameters

Type	Name	Description
Distance	precision	CAD precision for this model.

See also:

primitives

createBRepCone

Creates a BRep Cone whose axis is the Z axis centered on O.


cad.createBRepCone(radius, height, matrix=geom.IdentityMatrix4) -> cad.Body

Parameters

Type	Name	Description
Double	radius	Cone radius.
Double	height	Cone height.
Matrix4	matrix	Positionning matrix of the Cone.

Returns

Type	Name	Description
Body	body	The created Body.

See also:

createBRepCube

Creates a BRep Cube.


cad.createBRepCube(size, matrix=geom.IdentityMatrix4) -> cad.Body

Parameters

Type	Name	Description
Double	size	Side length.
Matrix4	matrix	Positionning matrix of the Cube.

Returns

Type	Name	Description
Body	body	The created Body.

See also:

createBRepCylinder

Creates a BRep Cylinder aligned on the Z axis centered on O.


cad.createBRepCylinder(radius, length, matrix=geom.IdentityMatrix4) -> cad.Body

Parameters

Type	Name	Description
Double	radius	Cylinder radius.
Double	length	Cylinder length.
Matrix4	matrix	Positionning matrix of the Cylinder.

Returns

Type	Name	Description
Body	body	The created Body.

See also:

createBRepPlane

Creates a BRep Plane whose normal is the Z axis centered on O.


cad.createBRepPlane(length, width, matrix=geom.IdentityMatrix4) -> cad.Body

Parameters

Type	Name	Description
Double	length	Plane length (X axis).
Double	width	Plane width (Y axis).
Matrix4	matrix	Positionning matrix of the Plane.

Returns

Type	Name	Description
Body	body	The created Body.

See also:

createBRepSphere

Creates a BRep Sphere centered on O and whose singularities are on the Z axis.


cad.createBRepSphere(radius, matrix=geom.IdentityMatrix4) -> cad.Body

Parameters

Type	Name	Description
Double	radius	Sphere radius.
Matrix4	matrix	Positionning matrix of the Sphere.

Returns

Type	Name	Description
Body	body	The created Body.

See also:

createBRepTorus

Creates a BRep Torus whose axis is the Z axis centered on O.


cad.createBRepTorus(majorRadius, minorRadius, matrix=geom.IdentityMatrix4) -> cad.Body

Parameters

Type	Name	Description
Double	majorRadius	Major radius.
Double	minorRadius	Minor radius.
Matrix4	matrix	Positionning matrix of the Torus.

Returns

Type	Name	Description
Body	body	The created Body.

See also:

structure access

areCurvesEquals

Check if two curve are equals by comparing each attribute, one by one. The two curves need to be of the same type; otherwise, it returns false by default.


cad.areCurvesEquals(curve1, curve2) -> core.Boolean

Parameters

Type	Name	Description
Curve	curve1	A curve to be compare.
Curve	curve2	A curve to be compare.

Returns

Type	Name	Description
Boolean	isEqual	The result of the comparison.

See also:

evalCurvatureOnCurve

Evaluate curvature on a curve.


cad.evalCurvatureOnCurve(curve, parameter) -> core.Double

Parameters

Type	Name	Description
Curve	curve	The curve.
Double	parameter	Parameter to evaluate.

Returns

Type	Name	Description
Double	curvature	Curvature on curve at parameter.

See also:

evalCurvatureOnSurface

Evaluate main curvatures on a surface.


cad.evalCurvatureOnSurface(surface, parameter) -> geom.Curvatures

Parameters

Type	Name	Description
Surface	surface	The surface.
Point2	parameter	Parameter to evaluate.

Returns

Type	Name	Description
Curvatures	curvatures	Main curvatures on surface at parameter.

See also:

evalOnCurve

Evaluate a point and derivatives on a curve.


cad.evalOnCurve(curve, parameter, derivation=0) -> geom.Point3, geom.Point3, geom.Point3

Parameters

Type	Name	Description
Curve	curve	The curve.
Double	parameter	Parameter to evaluate.
Int	derivation	Derivation level (0,1,2).

Returns

Type	Name	Description
Point3	d0	D0.
Point3	du	Du.
Point3	d2u	D2u.

See also:

evalOnSurface

Evaluate a point and derivatives on a surface.


cad.evalOnSurface(surface, parameter, derivation=0) -> geom.Point3, geom.Point3, geom.Point3, geom.Point3, geom.Point3, geom.Point3

Parameters

Type	Name	Description
Surface	surface	The surface.
Point2	parameter	Parameter to evaluate.
Int	derivation	Derivation level (0,1,2).

Returns

Type	Name	Description
Point3	d0	D0.
Point3	du	Du.
Point3	dv	Dv.
Point3	d2u	D2u.
Point3	d2v	D2v.
Point3	duv	Duv.

See also:

getBodyClosedShells

Get all closedShells contain in the body.


cad.getBodyClosedShells(body) -> cad.ClosedShellList

Parameters

Type	Name	Description
Body	body	The body.

Returns

Type	Name	Description
ClosedShellList	closedShells	The closedShells contain within the body.

See also:

getCircleCurveDefinition

Get all parameters contained in the circleCurve.


cad.getCircleCurveDefinition(circleCurve) -> core.Double, geom.Matrix4

Parameters

Type	Name	Description
CircleCurve	circleCurve	The circleCurve.

Returns

Type	Name	Description
Double	radius	The radius of the circle.
Matrix4	matrix	The matrix transformation of the circle.

See also:

getClosedShellOrientedFaces

Get all orienteFaces contain in the closedShell.


cad.getClosedShellOrientedFaces(closedShell) -> cad.OrientedFaceList

Parameters

Type	Name	Description
ClosedShell	closedShell	The closedShell.

Returns

Type	Name	Description
OrientedFaceList	orientedFaces	The orientedFaces contain within the closedShell.

See also:

getCoEdgeDefinition

Get all parameters contained in the coEdge.


cad.getCoEdgeDefinition(coEdge) -> cad.Edge, geom.Orientation, cad.Loop, cad.Surface, cad.Curve

Parameters

Type	Name	Description
CoEdge	coEdge	The coEdge.

Returns

Type	Name	Description
Edge	edge	The edge of the coEdge.
Orientation	edgeOrientation	Orientation of the edge.
Loop	loop	The loop containing the coEdge.
Surface	surface	The surface of the coEdge.
Curve	parametricCurve	The parametricCurve of the coEdge.

See also:

getCompositeCurveDefinition

Get all parameters contained in the compositeCurve.


cad.getCompositeCurveDefinition(compositeCurve) -> cad.CurveList, core.DoubleList

Parameters

Type	Name	Description
CompositeCurve	compositeCurve	The compositeCurve.

Returns

Type	Name	Description
CurveList	curves	The curves of the compositeCurve.
DoubleList	parameters	The parameters of the compositeCurve.

See also:

getConeSurfaceDefinition

Get all parameters contained in the coneSurface.


cad.getConeSurfaceDefinition(coneSurface) -> core.Double, core.Double, geom.Matrix4

Parameters

Type	Name	Description
ConeSurface	coneSurface	The coneSurface.

Returns

Type	Name	Description
Double	radius	The radius of the coneSurface.
Double	semiAngle	The semiAngle of coneSurface.
Matrix4	matrix	The transformation matrix of coneSurface.

See also:

getCurveExtrusionSurfaceDefinition

Get all parameters contained in the curveExtrusionSurface.


cad.getCurveExtrusionSurfaceDefinition(curveExtrusionSurface) -> cad.Curve, cad.Curve, cad.Surface

Parameters

Type	Name	Description
CurveExtrusionSurface	curveExtrusionSurface	The curveExtrusionSurface.

Returns

Type	Name	Description
Curve	generatrixCurve	The generatrix curve of the curveExtrusionSurface.
Curve	directrixCurve	The directrix curve of the curveExtrusionSurface.
Surface	surfaceReference	The reference surface of curveExtrusionSurface.

See also:

getCurveLength

Returns the length of the curve.


cad.getCurveLength(curve) -> core.Double

Parameters

Type	Name	Description
Curve	curve	The curve.

Returns

Type	Name	Description
Double	length	The length of the edge.

See also:

getCurveLimits

Get the parametric space limits of a curve.


cad.getCurveLimits(curve) -> cad.Bounds1D

Parameters

Type	Name	Description
Curve	curve	The curve.

Returns

Type	Name	Description
Bounds1D	limits	Curve limits.

See also:

getCylinderSurfaceDefinition

Get all parameters contained in the cylinderSurface.


cad.getCylinderSurfaceDefinition(cylinderSurface) -> core.Double, geom.Matrix4

Parameters

Type	Name	Description
CylinderSurface	cylinderSurface	The cylinderSurface.

Returns

Type	Name	Description
Double	radius	The radius of the cylinderSurface.
Matrix4	matrix	The transformation matrix of cylinderSurface.

See also:

getEdgeDefinition

Get all parameters contained in the edge.


cad.getEdgeDefinition(edge) -> cad.Vertex, cad.Vertex, cad.Curve, cad.Bounds1D

Parameters

Type	Name	Description
Edge	edge	The edge.

Returns

Type	Name	Description
Vertex	vertex1	The first vertex of the edge.
Vertex	vertex2	The second vertex of the edge.
Curve	curve	The curve of the edge.
Bounds1D	bounds	The bounds of the edge.

See also:

getEdgeLength

Returns the length of the edge.


cad.getEdgeLength(edge) -> core.Double

Parameters

Type	Name	Description
Edge	edge	The edge.

Returns

Type	Name	Description
Double	length	The length of the edge.

See also:

getEdgeMaterial

Get the material of the edge, if any.


cad.getEdgeMaterial(edge) -> material.Material

Parameters

Type	Name	Description
Edge	edge

Returns

Type	Name	Description
Material	material	The material applied to the edge, 0 if no material.

See also:

getEllipseCurveDefinition

Get all parameters contained in the ellipseCurve.


cad.getEllipseCurveDefinition(ellipseCurve) -> core.Double, core.Double, geom.Matrix4

Parameters

Type	Name	Description
EllipseCurve	ellipseCurve	The ellipseCurve.

Returns

Type	Name	Description
Double	radius1	The radius on x of the ellipse.
Double	radius2	The radius on y of the ellipse.
Matrix4	matrix	The transformation matrix of the ellipse.

See also:

getEllipticConeSurfaceDefinition

Get all parameters contained in the ellipticConeSurface.


cad.getEllipticConeSurfaceDefinition(ellipticConeSurface) -> core.Double, core.Double, core.Double, geom.Matrix4

Parameters

Type	Name	Description
EllipticConeSurface	ellipticConeSurface	The EllipticConeSurface.

Returns

Type	Name	Description
Double	radius1	The radius on X of the coneSurface.
Double	radius2	The radius on Y of the coneSurface.
Double	semiAngle	The semiAngle of coneSurface.
Matrix4	matrix	The transformation matrix of coneSurface.

See also:

getFaceDefinition

Get all parameters contain in the face.


cad.getFaceDefinition(face) -> cad.Surface, cad.LoopList, geom.Orientation, cad.Bounds2D

Parameters

Type	Name	Description
Face	face	The face.

Returns

Type	Name	Description
Surface	surface	The surface contain within the face.
LoopList	loops	The loops contain within the face.
Orientation	orientation	Relative orientation of the surface.
Bounds2D	limits	Face limits on surfaces.

See also:

getFaceParametricBoundaries

Get parametric definition of each face loop.


cad.getFaceParametricBoundaries(face) -> geom.Point2ListList

Parameters

Type	Name	Description
Face	face	The face.

Returns

Type	Name	Description
Point2ListList	boundaries	The parametric boundaries.

See also:

getHelixCurveDefinition

Get all parameters contained in the helixCurve.


cad.getHelixCurveDefinition(helixCurve) -> core.Double, geom.Matrix4, core.Boolean

Parameters

Type	Name	Description
HelixCurve	helixCurve	The helixCurve.

Returns

Type	Name	Description
Double	radius	The radius of the helixCurve.
Matrix4	matrix	The matrix of the helixCurve.
Boolean	trigonometricOrientation	The trigonometricOrientation of the helixCurve.

See also:

getHermiteCurveDefinition

Get all parameters contained in the hermiteCurve.


cad.getHermiteCurveDefinition(hermiteCurve) -> geom.Point3, geom.Point3, geom.Point3, geom.Point3

Parameters

Type	Name	Description
HermiteCurve	hermiteCurve	The HermiteCurve.

Returns

Type	Name	Description
Point3	firstPoint	The first point of the hermiteCurve.
Point3	secondPoint	The second point of the hermiteCurve.
Point3	firstTangent	The first tangent of the hermiteCurve.
Point3	secondTangent	The second tangent of the hermiteCurve.

See also:

getHyperbolaCurveDefinition

Get all parameters contained in the hyperbolaCurve.


cad.getHyperbolaCurveDefinition(hyperbolaCurve) -> core.Double, core.Double, geom.Matrix4

Parameters

Type	Name	Description
HyperbolaCurve	hyperbolaCurve	The hyperbolaCurve.

Returns

Type	Name	Description
Double	radius1	The radius on x of the hyperbola.
Double	radius2	The radius on y of the hyperbola.
Matrix4	matrix	The transformation matrix of the hyperbola.

See also:

getIntersectionCurveDefinition

Get all parameters contained in the intersectionCurve.


cad.getIntersectionCurveDefinition(intersectionCurve) -> cad.Surface, cad.Surface, cad.PolylineCurve, cad.Bounds1D

Parameters

Type	Name	Description
IntersectionCurve	intersectionCurve	The intersectionCurve.

Returns

Type	Name	Description
Surface	surface1	The first surface of the intersectionCurve.
Surface	surface2	The second surface of the intersectionCurve.
PolylineCurve	chart	The chart of the intersectionCurve.
Bounds1D	bounds	The boudns of the intersectionCurve.

See also:

getLineCurveDefinition

Get all parameters contain in the lineCurve.


cad.getLineCurveDefinition(lineCurve) -> geom.Point3, geom.Point3

Parameters

Type	Name	Description
LineCurve	lineCurve	The lineCurve.

Returns

Type	Name	Description
Point3	origin	The origin of the lineCurve.
Point3	direction	The direction of the lineCurve.

See also:

getLoopCoEdges

Get all coEdges contain in the loop.


cad.getLoopCoEdges(loop) -> cad.CoEdgeList

Parameters

Type	Name	Description
Loop	loop	The loop.

Returns

Type	Name	Description
CoEdgeList	coEdges	The coEdges contain within the loop.

See also:

getNURBSCurveDefinition

Get all parameters contained in the nurbsCurve.


cad.getNURBSCurveDefinition(nurbsCurve) -> core.Int, core.DoubleList, geom.Point3List, core.DoubleList

Parameters

Type	Name	Description
NURBSCurve	nurbsCurve	The nurbsCurve.

Returns

Type	Name	Description
Int	degree	The degree of the nurbsCurve.
DoubleList	knots	The knots of the nurbsCurve.
Point3List	poles	The poles of the nurbsCurve.
DoubleList	weights	The weights of the poles of the nurbsCurve.

See also:

getNURBSSurfaceDefinition

Get all parameters contained in the nurbsSurface.


cad.getNURBSSurfaceDefinition(nurbsSurface) -> core.Int, core.Int, core.DoubleList, core.DoubleList, geom.Point3ListList, core.DoubleListList

Parameters

Type	Name	Description
NURBSSurface	nurbsSurface	The nurbsSurface.

Returns

Type	Name	Description
Int	degreeU	The degree on U of the nurbsSurface.
Int	degreeV	The degree on V of the nurbsSurface.
DoubleList	knotsU	The knots on U of the nurbsSurface.
DoubleList	knotsV	The knots on V of the nurbsSurface.
Point3ListList	poles	The poles of nurbsSurface.
DoubleListList	weights	The weights of the poles of nurbsSurface.

See also:

getOffsetCurveDefinition

Get all parameters contained in the offsetCurve.


cad.getOffsetCurveDefinition(offsetCurve) -> cad.Curve, geom.Point3, core.Double, cad.Surface

Parameters

Type	Name	Description
OffsetCurve	offsetCurve	The offsetCurve.

Returns

Type	Name	Description
Curve	curve	The curve of the offsetCurve.
Point3	direction	The direction of the offset.
Double	distance	The distance of the offset.
Surface	surfaceReference	The surfaceReference of the offsetCurve.

See also:

getOffsetSurfaceDefinition

Get all parameters contained in the offsetSurface.


cad.getOffsetSurfaceDefinition(offsetSurface) -> cad.Surface, core.Double

Parameters

Type	Name	Description
OffsetSurface	offsetSurface	The offsetSurface.

Returns

Type	Name	Description
Surface	baseSurface	The initial surface.
Double	distance	The distance offset.

See also:

getOpenShellOrientedFaces

Get all orienteFaces contain in the openShell.


cad.getOpenShellOrientedFaces(openShell) -> cad.OrientedFaceList

Parameters

Type	Name	Description
OpenShell	openShell	The openShell.

Returns

Type	Name	Description
OrientedFaceList	orientedFaces	The orientedFaces contain within the openShell.

See also:

getParabolaCurveDefinition

Get all parameters contained in the parabolaCurve.


cad.getParabolaCurveDefinition(parabolaCurve) -> core.Double, geom.Matrix4

Parameters

Type	Name	Description
ParabolaCurve	parabolaCurve	The parabolaCurve.

Returns

Type	Name	Description
Double	focalLength	The radius of the hyperbola.
Matrix4	matrix	The transformation matrix of the hyperbola.

See also:

getParametricPrecisionOnSurface

Returns the parametric precision of a surface from the input precision.


cad.getParametricPrecisionOnSurface(surface, precision) -> core.Double

Parameters

Type	Name	Description
Surface	surface	The surface.
Double	precision	Input precision.

Returns

Type	Name	Description
Double	parametricPrecision

See also:

getPlaneSurfaceDefinition

Get all parameters contained in the planeSurface.


cad.getPlaneSurfaceDefinition(planeSurface) -> geom.Matrix4

Parameters

Type	Name	Description
PlaneSurface	planeSurface	The planeSurface.

Returns

Type	Name	Description
Matrix4	matrix	The transformation matrix of planeSurface.

See also:

getPolylineCurveDefinition

Get all parameters contained in the polylinCurve.


cad.getPolylineCurveDefinition(polylineCurve) -> geom.Point3List, core.DoubleList

Parameters

Type	Name	Description
PolylineCurve	polylineCurve	The polylineCurve.

Returns

Type	Name	Description
Point3List	points	The points of the polylineCurve.
DoubleList	parameters	The parameters of the polylineCurve.

See also:

getRevolutionSurfaceDefinition

Get all parameters contained in the revolutionSurface.


cad.getRevolutionSurfaceDefinition(revolutionSurface) -> cad.Curve, geom.Point3, geom.Point3, core.Double, core.Double

Parameters

Type	Name	Description
RevolutionSurface	revolutionSurface	The revolutionSurface.

Returns

Type	Name	Description
Curve	generatrixCurve	The generatrix curve of the revolutionSurface.
Point3	axisOrigin	The origin of the axis of the revolutionSurface.
Point3	axisDirection	The direction of the axis of the revolutionSurface.
Double	startAngle	The starting angle of the revolutionSurface.
Double	endAngle	The ending angle of the revolutionSurface.

See also:

getRuledSurfaceDefinition

Get all parameters contained in the ruledSurface.


cad.getRuledSurfaceDefinition(ruledSurface) -> cad.Curve, cad.Curve

Parameters

Type	Name	Description
RuledSurface	ruledSurface	The ruledSurface.

Returns

Type	Name	Description
Curve	firstCurve	The first curve of the ruledSurface.
Curve	secondCurve	The second curve of the ruledSurface.

See also:

getSegmentCurveDefinition

Get all parameters contained in the segmentCurve.


cad.getSegmentCurveDefinition(segmentCurve) -> geom.Point3, geom.Point3

Parameters

Type	Name	Description
SegmentCurve	segmentCurve	The segmentCurve.

Returns

Type	Name	Description
Point3	startPoint	The first point of the segmentCurve.
Point3	endPoint	The second point of the segmentCurve.

See also:

getSphereSurfaceDefinition

Get all parameters contained in the sphereSurface.


cad.getSphereSurfaceDefinition(sphereSurface) -> core.Double, geom.Matrix4

Parameters

Type	Name	Description
SphereSurface	sphereSurface	The sphereSurface.

Returns

Type	Name	Description
Double	radius	The radius of the sphereSurface.
Matrix4	matrix	The transformation matrix of sphereSurface.

See also:

getSurfaceLimits

Get the parametric space limits of a surface.


cad.getSurfaceLimits(surface) -> cad.Bounds2D

Parameters

Type	Name	Description
Surface	surface	The surface.

Returns

Type	Name	Description
Bounds2D	limits	Surface limits.

See also:

getSurfacicCurveDefinition

Get all parameters contained in the surfacicCurve.


cad.getSurfacicCurveDefinition(surfacicCurve) -> cad.Surface, cad.Curve

Parameters

Type	Name	Description
SurfacicCurve	surfacicCurve	The surfacicCurve.

Returns

Type	Name	Description
Surface	surface	The surface of the surfacicCurve.
Curve	curve2D	The 2D curve of the surfacicCurve.

See also:

getTabulatedCylinderSurfaceDefinition

Get all parameters contained in the TabulatedCylinderSurface.


cad.getTabulatedCylinderSurfaceDefinition(tabulatedCylinderSurface) -> cad.Curve, geom.Point3, cad.Bounds1D

Parameters

Type	Name	Description
TabulatedCylinderSurface	tabulatedCylinderSurface	The tabulatedCylinderSurface.

Returns

Type	Name	Description
Curve	directrixCurve	The directrix curve of the tabulatedCylinderSurface.
Point3	generatrixLine	The generatrix line of the tabulatedCylinderSurface.
Bounds1D	range	The range of the tabulatedCylinderSurface.

See also:

getTorusSurfaceDefinition

Get all parameters contained in the torusSurface.


cad.getTorusSurfaceDefinition(torusSurface) -> core.Double, core.Double, geom.Matrix4, core.Int

Parameters

Type	Name	Description
TorusSurface	torusSurface	The torusSurface.

Returns

Type	Name	Description
Double	majorRadius	The major radius of the torusSurface.
Double	minorRadius	The minor radius of the torusSurface.
Matrix4	matrix	The transformation matrix of torusSurface.
Int	type	The torus shape type id.

See also:

getTransformedCurveDefinition

Get all parameters contained in the transformedCurve.


cad.getTransformedCurveDefinition(transformedCurve) -> cad.Curve, geom.Matrix4

Parameters

Type	Name	Description
TransformedCurve	transformedCurve	The transformedCurve.

Returns

Type	Name	Description
Curve	curve	The initial curve.
Matrix4	matrix	The transformation matrix.

See also:

getVertexPosition

Get the position of the vertex.


cad.getVertexPosition(vertex) -> geom.Point3

Parameters

Type	Name	Description
Vertex	vertex	The vertex.

Returns

Type	Name	Description
Point3	position	The position of the vertex.

See also:

invertOnCurve

Invert a point to a curve.


cad.invertOnCurve(curve, point, precision=-1) -> core.Double

Parameters

Type	Name	Description
Curve	curve	The curve.
Point3	point	The point to invert.
Double	precision	Inversion precision.

Returns

Type	Name	Description
Double	parameter	The inversion parameter on the curve.

See also:

invertOnSurface

Invert a point to a surface.


cad.invertOnSurface(surface, point, precision=-1) -> geom.Point2

Parameters

Type	Name	Description
Surface	surface	The surface.
Point3	point	The point to invert.
Double	precision	Inversion precision.

Returns

Type	Name	Description
Point2	parameter	The inversion parameter on the surface.

See also:

isCurveClosed

If the curve is closed, return true, return false otherwise.


cad.isCurveClosed(curve) -> core.Boolean

Parameters

Type	Name	Description
Curve	curve	The curve.

Returns

Type	Name	Description
Boolean	closed	The value.

See also:

isCurveFinite

If the curve is finite return true, return false otherwise.


cad.isCurveFinite(curve) -> core.Boolean

Parameters

Type	Name	Description
Curve	curve	The curve.

Returns

Type	Name	Description
Boolean	finite	The value.

See also:

isCurvePeriodic

If the curve is periodic return true, return false otherwise.


cad.isCurvePeriodic(curve) -> core.Boolean, core.Double

Parameters

Type	Name	Description
Curve	curve	The curve.

Returns

Type	Name	Description
Boolean	periodic	The value.
Double	period	If th curve is periodic, this value is equal to the period value, equal to 0 otherwise.

See also:

isSurfaceClosed

Return if the surface is closed on U or on V.


cad.isSurfaceClosed(surface) -> core.Boolean, core.Boolean

Parameters

Type	Name	Description
Surface	surface	The surface.

Returns

Type	Name	Description
Boolean	closedU	The value on U.
Boolean	closedV	The value on V.

See also:

isSurfacePeriodic

Return if the surface is periodic on U or on V.


cad.isSurfacePeriodic(surface) -> core.Boolean, core.Boolean, core.Double, core.Double

Parameters

Type	Name	Description
Surface	surface	The surface.

Returns

Type	Name	Description
Boolean	periodicU	The value on U.
Boolean	periodicV	The value on V.
Double	periodU	If th curve is periodic on U, this value is equal to the period value, equal to 0 otherwise.
Double	periodV	If th curve is periodic on V, this value is equal to the period value, equal to 0 otherwise.

See also:

needTorusShapeCheck

Returns true if the torus has a shape (lemon or apple) corresponding to the provided points.


cad.needTorusShapeCheck(surface, points) -> core.Boolean

Parameters

Type	Name	Description
Surface	surface	The surface.
Point3List	points	List of points to check the surface.

Returns

Type	Name	Description
Boolean	result	Result of the check.

See also:

projectOnCurve

Project a point to a curve.


cad.projectOnCurve(curve, point, precision=-1) -> core.Double

Parameters

Type	Name	Description
Curve	curve	The curve.
Point3	point	The point to project.
Double	precision	Projection precision.

Returns

Type	Name	Description
Double	projectionParameter	The projection parameter on the curve.

See also:

projectOnSurface

Project a point to a surface.


cad.projectOnSurface(surface, point, precision=-1) -> geom.Point2

Parameters

Type	Name	Description
Surface	surface	The surface.
Point3	point	The point to project.
Double	precision	Projection precision.

Returns

Type	Name	Description
Point2	projectionParameter	The projection parameter on the surface.

See also:

setCoEdgeCurve2D

Set the curve 2D value of a coEdge.


cad.setCoEdgeCurve2D(coEdge, curve2D)

Parameters

Type	Name	Description
CoEdge	coEdge	The coEdge.
Curve	curve2D	The new curve 2D.

See also:

setCoEdgeSurface

Set the surface value of a coEdge.


cad.setCoEdgeSurface(coEdge, surface)

Parameters

Type	Name	Description
CoEdge	coEdge	The coEdge.
Surface	surface	The new surface.

See also:

setCurveLimits

Set the parametric space limits of a curve.


cad.setCurveLimits(curve, limits)

Parameters

Type	Name	Description
Curve	curve	The curve.
Bounds1D	limits	Curve limits.

See also:

setEdgeMaterial

Define an edge's material.


cad.setEdgeMaterial(edge, material)

Parameters

Type	Name	Description
Edge	edge	The edge to apply to style to.
Material	material	The material to apply.

See also:

structure creation

createBody

Create a body from a surface.


cad.createBody(outerShell, innerShells=None) -> cad.Body

Parameters

Type	Name	Description
ClosedShell	outerShell	ClosedShell used to create the body.
ClosedShellList	innerShells	List of closedShell used to create the body.

Returns

Type	Name	Description
Body	body	The created body.

See also:

createClosedShell

Create a closedShell from a set of faces of a set of orientations.


cad.createClosedShell(faces, orientations) -> cad.ClosedShell

Parameters

Type	Name	Description
FaceList	faces	List of faces composing the closedShell.
OrientationList	orientations	List of orientations for each face.

Returns

Type	Name	Description
ClosedShell	closedShell	The created closedShell.

See also:

createCoEdge

Create an coEdge with a edge and an orientation.


cad.createCoEdge(edge, orientation, surface=0, curve2D=0, computeGateway=False) -> cad.CoEdge

Parameters

Type	Name	Description
Edge	edge	Edge used to create the coEdge.
Orientation	orientation	Orientation of the edge regarding the loop.
Surface	surface	The surface trimmed by the edge.
Curve	curve2D	Surfacic curve of the edge on the surface trimmed.
Boolean	computeGateway	Needed if 3d curve and 2d curve have different parametrization.

Returns

Type	Name	Description
CoEdge	coEdge	The created edge.

See also:

createEdge

Create an edge with a curve an extremity vertices.


cad.createEdge(curve, startVertex, endVertex) -> cad.Edge

Parameters

Type	Name	Description
Curve	curve	Curve used to create the edge.
Vertex	startVertex	The start vertex.
Vertex	endVertex	The end vertex.

Returns

Type	Name	Description
Edge	edge	The created edge.

See also:

createEdgeFromCurve

Create an edge from a limited curve.


cad.createEdgeFromCurve(curve) -> cad.Edge

Parameters

Type	Name	Description
Curve	curve	Limited curve used to create the edge.

Returns

Type	Name	Description
Edge	edge	The created edge.

See also:

createEdgeWithBounds

Create an edge with a curve an extremity vertices and a given boundary.


cad.createEdgeWithBounds(curve, startVertex, endVertex, bounds) -> cad.Edge

Parameters

Type	Name	Description
Curve	curve	Curve used to create the edge.
Vertex	startVertex	The start vertex.
Vertex	endVertex	The end vertex.
Bounds1D	bounds	The parametrization boundary.

Returns

Type	Name	Description
Edge	edge	The created edge.

See also:

createFace

Create a face from a surface.


cad.createFace(surface, loopList=None, useSurfaceOrientation=False) -> cad.Face

Parameters

Type	Name	Description
Surface	surface	Surface used to create the face.
LoopList	loopList	List of Loops used to create the face.
Boolean	useSurfaceOrientation	If True, the face will have the same orientation than the surface and loops will be inverted if they are inconsistent.

Returns

Type	Name	Description
Face	face	The created face.

See also:

createLoop

Create a loop from a set of edges of a set of orientations.


cad.createLoop(coEdges, check=True, deleteIsolatedVertices=True) -> cad.Loop

Parameters

Type	Name	Description
CoEdgeList	coEdges	List of coEdges composing the loop.
Boolean	check	If true, the loop check if edges are well connected or not.
Boolean	deleteIsolatedVertices	If true, this will merge isolated vertices in the loop.

Returns

Type	Name	Description
Loop	loop	The created loop.

See also:

createLoopFromCurve

Create a loop from a finite curve.


cad.createLoopFromCurve(curve) -> cad.Loop

Parameters

Type	Name	Description
Curve	curve	The curve to create the loop with.

Returns

Type	Name	Description
Loop	loop	The created loop.

See also:

createOpenShell

Create a openShell from a set of faces of a set of orientations and set of loops.


cad.createOpenShell(faces, orientations) -> cad.OpenShell

Parameters

Type	Name	Description
FaceList	faces	List of faces composing the openShell.
OrientationList	orientations	List of orientations for each face.

Returns

Type	Name	Description
OpenShell	openShell	The created openShell.

See also:

createVertex

Create a vertex from a position.


cad.createVertex(position) -> cad.Vertex

Parameters

Type	Name	Description
Point3	position	Vertex position.

Returns

Type	Name	Description
Vertex	vertex	The created vertex.

See also:

invertCoEdge

Invert a coedge.


cad.invertCoEdge(coedge)

Parameters

Type	Name	Description
CoEdge	coedge	The coedge to invert.

See also:

invertFaces

Invert faces.


cad.invertFaces(faces, invertLoops=True)

Parameters

Type	Name	Description
FaceList	faces	The faces to invert.
Boolean	invertLoops	If true, invert loops orientation.

See also:

invertLoop

Invert a loop.


cad.invertLoop(loop)

Parameters

Type	Name	Description
Loop	loop	The loop to invert.

See also:

isSurfaceFinite

Return if the surface is finite.


cad.isSurfaceFinite(surface) -> core.Boolean

Parameters

Type	Name	Description
Surface	surface	The surface.

Returns

Type	Name	Description
Boolean	finite	Tells if finite.

See also:

surfaces

addPrecisionArea

Define a working area on the 2D projection of the surface to define a parametric precision.


cad.addPrecisionArea(surface, aabr)

Parameters

Type	Name	Description
Surface	surface	Surface on which the precision area will be set.
AABR	aabr	2D area defining the working area.

See also:

createBezierSurface

Create a new bezier surface.


cad.createBezierSurface(degreeU, degreeV, poles) -> cad.Surface

Parameters

Type	Name	Description
Int	degreeU	U degree.
Int	degreeV	V degree.
Point3List	poles	Poles list.

Returns

Type	Name	Description
Surface	bezierSurface	The new Bezier surface.

See also:

createConeSurface

Create a new cone surface.


cad.createConeSurface(radius, semiAngle, matrix=geom.IdentityMatrix4) -> cad.Surface

Parameters

Type	Name	Description
Distance	radius	Radius of the cone at origin.
Double	semiAngle	Semi-angle of the cone (in rad).
Matrix4	matrix	Positionning matrix of the cone.

Returns

Type	Name	Description
Surface	coneSurface	The new cone surface.

See also:

createCurveExtrusionSurface

Create a new curveExtrusion surface.


cad.createCurveExtrusionSurface(generatrixCurve, directrixCurve, refSurface=0) -> cad.Surface

Parameters

Type	Name	Description
Curve	generatrixCurve	The generatrix curve.
Curve	directrixCurve	The directrix curve.
Surface	refSurface	The reference surface.

Returns

Type	Name	Description
Surface	curveExtrusionSurface	The new curveExtrusion surface.

See also:

createCylinderSurface

Create a new cylinder surface.


cad.createCylinderSurface(radius, matrix=geom.IdentityMatrix4) -> cad.Surface

Parameters

Type	Name	Description
Distance	radius	Radius of the cylinder.
Matrix4	matrix	Positionning matrix of the cylinder.

Returns

Type	Name	Description
Surface	cylinderSurface	The new cylinder surface.

See also:

createEllipticConeSurface

Create a new elliptic cone surface.


cad.createEllipticConeSurface(radius1, radius2, semiAngle, matrix=geom.IdentityMatrix4) -> cad.Surface

Parameters

Type	Name	Description
Distance	radius1	Radius of the cone at origin on the X axis.
Distance	radius2	Radius of the cone at origin on the Y axis.
Double	semiAngle	Semi-angle of the cone (in rad).
Matrix4	matrix	Positionning matrix of the cone.

Returns

Type	Name	Description
Surface	ellipticConeSurface	The new elliptic cone surface.

See also:

createNURBSSurface

Create a new NURBS surface.


cad.createNURBSSurface(degreeU, degreeV, knotsU, knotsV, poles, weights=None) -> cad.Surface

Parameters

Type	Name	Description
Int	degreeU	U degree.
Int	degreeV	V degree.
DoubleList	knotsU	Knots on U.
DoubleList	knotsV	Knots on V.
Point3List	poles	Poles list.
DoubleList	weights	Weights list.

Returns

Type	Name	Description
Surface	NURBSSurface	The new NURBS surface.

See also:

createOffsetSurface

Create a new offset surface.


cad.createOffsetSurface(baseSurface, distance) -> cad.Surface

Parameters

Type	Name	Description
Surface	baseSurface	The base surface.
Double	distance	The offset distance.

Returns

Type	Name	Description
Surface	offsetSurface	The new offset surface.

See also:

createPlaneSurface

Create a new plane surface.


cad.createPlaneSurface(matrix=geom.IdentityMatrix4) -> cad.Surface

Parameters

Type	Name	Description
Matrix4	matrix	Positionning matrix of the plane.

Returns

Type	Name	Description
Surface	planeSurface	The new plane surface.

See also:

createRevolutionSurface

Create a new revolution surface.


cad.createRevolutionSurface(generatrixCurve, axisOrigin, axisDirection, startParam=0, endParam=Core.TwoPi) -> cad.Surface

Parameters

Type	Name	Description
Curve	generatrixCurve	Generatrix curve rotated to create the revolution surface.
Point3	axisOrigin	Axis origin point.
Vector3	axisDirection	Axis direction vector.
Double	startParam	Start angle of the revolution surface (in rad).
Double	endParam	End angle of the revolution surface (in rad).

Returns

Type	Name	Description
Surface	revolutionSurface	Revolution surface generated by rotating the given curve around the axis.

See also:

createRuledSurface

Create a new ruled surface.


cad.createRuledSurface(firstCurve, secondCurve) -> cad.Surface

Parameters

Type	Name	Description
Curve	firstCurve	First Curve.
Curve	secondCurve	Seconde Curve.

Returns

Type	Name	Description
Surface	ruledSurface	The new ruled surface.

See also:

createSphereSurface

Create a new sphere surface.


cad.createSphereSurface(radius, matrix=geom.IdentityMatrix4) -> cad.Surface

Parameters

Type	Name	Description
Distance	radius	Radius of the sphere.
Matrix4	matrix	Positionning matrix of the sphere.

Returns

Type	Name	Description
Surface	sphereSurface	The new sphere surface.

See also:

createTabulatedCylinderSurface

Create a new tabulated cylinder surface.


cad.createTabulatedCylinderSurface(directrixCurve, GeneratixLine, minRange, maxRange) -> cad.Surface

Parameters

Type	Name	Description
Curve	directrixCurve	Directrix Curve.
Point3	GeneratixLine	Generatrix Line.
Distance	minRange	Minimimum value of the range.
Distance	maxRange	Maximum value of the range.

Returns

Type	Name	Description
Surface	tabulatedCylinderSurface	The new tabulated cylinder surface.

See also:

createTorusSurface

Create a new torus surface.


cad.createTorusSurface(radiusMax, radiusMin, matrix=geom.IdentityMatrix4) -> cad.Surface

Parameters

Type	Name	Description
Distance	radiusMax	Major radius .
Distance	radiusMin	Minor radius .
Matrix4	matrix	Positionning matrix of the sphere.

Returns

Type	Name	Description
Surface	torusSurface	The new torus surface.

See also:

needPrecisionArea

Tells if it needs a working area on the surface.


cad.needPrecisionArea(surface) -> core.Boolean

Parameters

Type	Name	Description
Surface	surface	Surface to check if it needs precision area.

Returns

Type	Name	Description
Boolean	need	Result.

See also:

CAD

configureFunctionLogger

Type

Name

Description

getPrecision

Type

Name

Description

getUnitLength

Type

Name

Description

setUnitLength

Type

Name

Description

Boolean Operators

solidIntersection

Type

Name

Description

Type

Name

Description

solidSubtraction

Type

Name

Description

Type

Name

Description

solidUnion

Type

Name

Description

Type

Name

Description

curves

createBezierCurve

Type

Name

Description

Type

Name

Description

createCircleCurve

Type

Name

Description

Type

Name

Description

createCompositeCurve

Type

Name

Description

Type

Name

Description

createCosinusCurve

Type

Name

Description

Type

Name

Description

createEllipseCurve

Type

Name

Description

Type

Name

Description

createHelixCurve

Type

Name

Description

Type