Class CAD

Inheritance
CAD
Namespace:
Syntax

Methods

configureFunctionLogger

Declaration
cad.configureFunctionLogger(functionName, enableFunction, enableParameters, enableExecutionTime)
Parameters
Type Name Description
String functionName
Boolean enableFunction
Boolean enableParameters
Boolean enableExecutionTime

getPrecision

Get the CAD precision

Declaration
cad.getPrecision() -> geom.Distance
Returns
Type Description
Distance

The current precision

getUnitLength

Get the CAD unity length property

Declaration
cad.getUnitLength() -> geom.Distance
Returns
Type Description
Distance

The current unit length

setUnitLength

Set the CAD unity length property

Declaration
cad.setUnitLength(precision=0.02)
Parameters
Type Name Description
Distance precision

Unit length

solidIntersection

perform boolean operation intersection on two bodies (A ^ B)

See also:

Declaration
cad.solidIntersection(A, B) -> cad.BodyList
Parameters
Type Name Description
Body A

The first body
Body B

The second body
Returns
Type Description
BodyList

List of resulting bodies

solidSubtraction

perform boolean operation subtraction on two bodies (A - B)

See also:

Declaration
cad.solidSubtraction(A, B) -> cad.BodyList
Parameters
Type Name Description
Body A

The first body
Body B

The second body
Returns
Type Description
BodyList

List of resulting bodies

solidUnion

perform boolean operation union on two bodies (A + B)

See also:

Declaration
cad.solidUnion(A, B) -> cad.BodyList
Parameters
Type Name Description
Body A

The first body
Body B

The second body
Returns
Type Description
BodyList

List of resulting bodies

createBezierCurve

Create a Bezier curve

See also:

Declaration
cad.createBezierCurve(poles) -> cad.Curve
Parameters
Type Name Description
Point3List poles

Poles list
Returns
Type Description
Curve

Bezier curve

createCircleCurve

Create a new circle

See also:

Declaration
cad.createCircleCurve(radius, matrix=geom.IdentityMatrix4) -> cad.Curve
Parameters
Type Name Description
Distance radius

Circle radius
Matrix4 matrix

Transformation matrix
Returns
Type Description
Curve

Generated circle curve

createCompositeCurve

Create a composite curve from a list of limited curves

See also:

Declaration
cad.createCompositeCurve(CurveList) -> cad.Curve
Parameters
Type Name Description
CurveList CurveList

List of limited curves
Returns
Type Description
Curve

Composite curve created from the list of limited curves

createCosinusCurve

Create a cosinus curve

See also:

Declaration
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 Description
Curve

Cosinus curve

createEllipseCurve

Create an ellipse curve

See also:

Declaration
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 Description
Curve

Ellipse curve

createHelixCurve

Create an helix curve

See also:

Declaration
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 Description
Curve

Helix curve

createHermiteCurve

Create a Hermite Curve

See also:

Declaration
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 Description
Curve

Hermite curve

createHyperbolaCurve

Create an hyperBola curve

See also:

Declaration
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 Description
Curve

Hyperbola curve

createIntersectionCurve

Create a Intersection Curve

See also:

Declaration
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 Description
Curve

Intersection curve

createLineCurve

Create a Line Curve

See also:

Declaration
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 Description
Curve

Line curve

createNURBSCurve

Create a NURBS curve

See also:

Declaration
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 Description
Curve

NURBS curve

createParabolaCurve

Create an parabola curve

See also:

Declaration
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 Description
Curve

Parabola curve

createPolylineCurve

Create a Polyline curve

See also:

Declaration
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 Description
Curve

Polyline curve

createSegmentCurve

Create a segment curve from two given points

See also:

Declaration
cad.createSegmentCurve(firstPoint, secondPoint) -> cad.Curve
Parameters
Type Name Description
Point3 firstPoint

First point
Point3 secondPoint

Second point
Returns
Type Description
Curve

Segment curve created from the two given points

createSurfacicCurve

Create a curve from a surface

See also:

Declaration
cad.createSurfacicCurve(surface, curve2D) -> cad.Curve
Parameters
Type Name Description
Surface surface

Surface to bound
Curve curve2D

Curve to project
Returns
Type Description
Curve

Curve projected on given surface

createTransformedCurve

Create a curve from a surface

See also:

Declaration
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 Description
Curve

Curve transformed by the given matrix

invertCurve

Invert a curve parametricaly

See also:

Declaration
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 Description
Curve

The inverted curve

createBoundedLinearExtrusion

create a linear extrusion body

See also:

Declaration
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 Description
CADEntity

The created body or shell

createCurveExtrusion

create a curve extrusion body

See also:

Declaration
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 Description
CADEntity

The created body or shell

createLinearExtrusion

create a linear extrusion body

See also:

Declaration
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 Description
CADEntity

The created body or shell

createMultiExtrusion

create a linear extrusion body

See also:

Declaration
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 Description
CADEntity

The created body or shell

createRevolveExtrusion

create a revolved extrusion body

See also:

Declaration
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 Description
CADEntity

The created body or shell

getFaceMaterial

get the material on a face

See also:

Declaration
cad.getFaceMaterial(face) -> material.Material
Parameters
Type Name Description
Face face

The face
Returns
Type Description
Material

The material

setFaceMaterial

set the material on a face

See also:

Declaration
cad.setFaceMaterial(face, material)
Parameters
Type Name Description
Face face

The face
Material material

The material

addBodyToModel

Add a body to the model

See also:

Declaration
cad.addBodyToModel(body, model)
Parameters
Type Name Description
Body body

Body added to the model
Model model

Model

addEdgeToModel

Add an edge to the model

See also:

Declaration
cad.addEdgeToModel(edge, model)
Parameters
Type Name Description
Edge edge

Edge added to the model
Model model

Model

addOpenShellToModel

Add an open shell to the model

See also:

Declaration
cad.addOpenShellToModel(shell, model)
Parameters
Type Name Description
OpenShell shell

Open shell added to the model
Model model

Model

addVertexToModel

Add a vertex to the model

See also:

Declaration
cad.addVertexToModel(vtx, model)
Parameters
Type Name Description
Vertex vtx

Vertex added to the model
Model model

Model

buildFaces

Build faces from a surface and a set of loop

See also:

Declaration
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 Description
FaceList

The created faces

createModel

Create a new model

See also:

Declaration
cad.createModel(precision=-1) -> cad.Model
Parameters
Type Name Description
Distance precision

CAD precision for this model
Returns
Type Description
Model

The created model

endThreadBrepSession

Create a new BrepSession on current thread

See also:

Declaration
cad.endThreadBrepSession()

getAllModelFaces

Get all the face of a model recursively

See also:

Declaration
cad.getAllModelFaces(model) -> cad.FaceList
Parameters
Type Name Description
Model model

Model
Returns
Type Description
FaceList

List of faces in the given model

getModelBodies

Get the list of bodies contained in a model

See also:

Declaration
cad.getModelBodies(model) -> cad.BodyList
Parameters
Type Name Description
Model model

Model
Returns
Type Description
BodyList

List of bodies contained in the given model

getModelBoundaries

Get boundary edges of a model grouped by cycles

See also:

Declaration
cad.getModelBoundaries(model) -> cad.EdgeListList
Parameters
Type Name Description
Model model

Model
Returns
Type Description
EdgeListList

List of boundary edges grouped by cycles in the given model

getModelEdges

Get the list of free edges contained in a model

See also:

Declaration
cad.getModelEdges(model) -> cad.EdgeList
Parameters
Type Name Description
Model model

Model
Returns
Type Description
EdgeList

List of edges contained in the given model

getModelOpenShells

Get the list of open shells contained in a model

See also:

Declaration
cad.getModelOpenShells(model) -> cad.OpenShellList
Parameters
Type Name Description
Model model

Model
Returns
Type Description
OpenShellList

List of open shells contained in the given model

getModelPrecision

Get the precision used in a model

See also:

Declaration
cad.getModelPrecision(model) -> core.Double
Parameters
Type Name Description
Model model

Model
Returns
Type Description
Double

Precision value

getModelVertices

Get the list of free vertices contained in a model

See also:

Declaration
cad.getModelVertices(model) -> cad.VertexList
Parameters
Type Name Description
Model model

Model
Returns
Type Description
VertexList

List of vertices contained in the given model

getReferencers

Returns the entities referencing a given CAD entity

See also:

Declaration
cad.getReferencers(entity) -> core.EntityList
Parameters
Type Name Description
CADEntity entity

CAD entity to get the referencers
Returns
Type Description
EntityList

List of CAD entities referencing the given entity

startThreadBrepSession

Create a new BrepSession on current thread

See also:

Declaration
cad.startThreadBrepSession(precision)
Parameters
Type Name Description
Distance precision

CAD precision for this model

createBRepCone

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

See also:

Declaration
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 Description
Body

The created Body

createBRepCube

Creates a BRep Cube

See also:

Declaration
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 Description
Body

The created Body

createBRepCylinder

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

See also:

Declaration
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 Description
Body

The created Body

createBRepPlane

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

See also:

Declaration
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 Description
Body

The created Body

createBRepSphere

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

See also:

Declaration
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 Description
Body

The created Body

createBRepTorus

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

See also:

Declaration
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 Description
Body

The created Body

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

See also:

Declaration
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 Description
Boolean

The result of the comparison

evalCurvatureOnCurve

evaluate curvature on a curve

See also:

Declaration
cad.evalCurvatureOnCurve(curve, parameter) -> core.Double
Parameters
Type Name Description
Curve curve

The curve
Double parameter

Parameter to evaluate
Returns
Type Description
Double

Curvature on curve at parameter

evalCurvatureOnSurface

evaluate main curvatures on a surface

See also:

Declaration
cad.evalCurvatureOnSurface(surface, parameter) -> geom.Curvatures
Parameters
Type Name Description
Surface surface

The surface
Point2 parameter

Parameter to evaluate
Returns
Type Description
Curvatures

Main curvatures on surface at parameter

evalOnCurve

evaluate a point and derivatives on a curve

See also:

Declaration
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 Description
Point3

D0

evalOnSurface

evaluate a point and derivatives on a surface

See also:

Declaration
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 Description
Point3

D0

getBodyClosedShells

get all closedShells contain in the body

See also:

Declaration
cad.getBodyClosedShells(body) -> cad.ClosedShellList
Parameters
Type Name Description
Body body

The body
Returns
Type Description
ClosedShellList

The closedShells contain within the body

getCircleCurveDefinition

get all parameters contained in the circleCurve

See also:

Declaration
cad.getCircleCurveDefinition(circleCurve) -> core.Double, geom.Matrix4
Parameters
Type Name Description
CircleCurve circleCurve

The circleCurve
Returns
Type Description
Double

The radius of the circle

getClosedShellOrientedFaces

get all orienteFaces contain in the closedShell

See also:

Declaration
cad.getClosedShellOrientedFaces(closedShell) -> cad.OrientedFaceList
Parameters
Type Name Description
ClosedShell closedShell

The closedShell
Returns
Type Description
OrientedFaceList

The orientedFaces contain within the closedShell

getCoEdgeDefinition

get all parameters contained in the coEdge

See also:

Declaration
cad.getCoEdgeDefinition(coEdge) -> cad.Edge, geom.Orientation, cad.Loop, cad.Surface, cad.Curve
Parameters
Type Name Description
CoEdge coEdge

The coEdge
Returns
Type Description
Edge

The edge of the coEdge

getCompositeCurveDefinition

get all parameters contained in the compositeCurve

See also:

Declaration
cad.getCompositeCurveDefinition(compositeCurve) -> cad.CurveList, core.DoubleList
Parameters
Type Name Description
CompositeCurve compositeCurve

The compositeCurve
Returns
Type Description
CurveList

The curves of the compositeCurve

getConeSurfaceDefinition

get all parameters contained in the coneSurface

See also:

Declaration
cad.getConeSurfaceDefinition(coneSurface) -> core.Double, core.Double, geom.Matrix4
Parameters
Type Name Description
ConeSurface coneSurface

The coneSurface
Returns
Type Description
Double

The radius of the coneSurface

getCurveExtrusionSurfaceDefinition

get all parameters contained in the curveExtrusionSurface

See also:

Declaration
cad.getCurveExtrusionSurfaceDefinition(curveExtrusionSurface) -> cad.Curve, cad.Curve, cad.Surface
Parameters
Type Name Description
CurveExtrusionSurface curveExtrusionSurface

The curveExtrusionSurface
Returns
Type Description
Curve

The generatrix curve of the curveExtrusionSurface

getCurveLength

returns the length of the curve

See also:

Declaration
cad.getCurveLength(curve) -> core.Double
Parameters
Type Name Description
Curve curve

The curve
Returns
Type Description
Double

The length of the edge

getCurveLimits

get the parametric space limits of a curve

See also:

Declaration
cad.getCurveLimits(curve) -> cad.Bounds1D
Parameters
Type Name Description
Curve curve

The curve
Returns
Type Description
Bounds1D

Curve limits

getCylinderSurfaceDefinition

get all parameters contained in the cylinderSurface

See also:

Declaration
cad.getCylinderSurfaceDefinition(cylinderSurface) -> core.Double, geom.Matrix4
Parameters
Type Name Description
CylinderSurface cylinderSurface

The cylinderSurface
Returns
Type Description
Double

The radius of the cylinderSurface

getEdgeDefinition

get all parameters contained in the edge

See also:

Declaration
cad.getEdgeDefinition(edge) -> cad.Vertex, cad.Vertex, cad.Curve, cad.Bounds1D
Parameters
Type Name Description
Edge edge

The edge
Returns
Type Description
Vertex

The first vertex of the edge

getEdgeLength

returns the length of the edge

See also:

Declaration
cad.getEdgeLength(edge) -> core.Double
Parameters
Type Name Description
Edge edge

The edge
Returns
Type Description
Double

The length of the edge

getEdgeMaterial

Get the material of the edge, if any

See also:

Declaration
cad.getEdgeMaterial(edge) -> material.Material
Parameters
Type Name Description
Edge edge
Returns
Type Description
Material

The material applied to the edge, 0 if no material

getEllipseCurveDefinition

get all parameters contained in the ellipseCurve

See also:

Declaration
cad.getEllipseCurveDefinition(ellipseCurve) -> core.Double, core.Double, geom.Matrix4
Parameters
Type Name Description
EllipseCurve ellipseCurve

The ellipseCurve
Returns
Type Description
Double

The radius on x of the ellipse

getEllipticConeSurfaceDefinition

get all parameters contained in the ellipticConeSurface

See also:

Declaration
cad.getEllipticConeSurfaceDefinition(ellipticConeSurface) -> core.Double, core.Double, core.Double, geom.Matrix4
Parameters
Type Name Description
EllipticConeSurface ellipticConeSurface

The EllipticConeSurface
Returns
Type Description
Double

The radius on X of the coneSurface

getFaceDefinition

get all parameters contain in the face

See also:

Declaration
cad.getFaceDefinition(face) -> cad.Surface, cad.LoopList, geom.Orientation, cad.Bounds2D
Parameters
Type Name Description
Face face

The face
Returns
Type Description
Surface

The surface contain within the face

getFaceParametricBoundaries

get parametric definition of each face loop

See also:

Declaration
cad.getFaceParametricBoundaries(face) -> geom.Point2ListList
Parameters
Type Name Description
Face face

The face
Returns
Type Description
Point2ListList

The parametric boundaries

getHelixCurveDefinition

get all parameters contained in the helixCurve

See also:

Declaration
cad.getHelixCurveDefinition(helixCurve) -> core.Double, geom.Matrix4, core.Boolean
Parameters
Type Name Description
HelixCurve helixCurve

The helixCurve
Returns
Type Description
Double

The radius of the helixCurve

getHermiteCurveDefinition

get all parameters contained in the hermiteCurve

See also:

Declaration
cad.getHermiteCurveDefinition(hermiteCurve) -> geom.Point3, geom.Point3, geom.Point3, geom.Point3
Parameters
Type Name Description
HermiteCurve hermiteCurve

The HermiteCurve
Returns
Type Description
Point3

The first point of the hermiteCurve

getHyperbolaCurveDefinition

get all parameters contained in the hyperbolaCurve

See also:

Declaration
cad.getHyperbolaCurveDefinition(hyperbolaCurve) -> core.Double, core.Double, geom.Matrix4
Parameters
Type Name Description
HyperbolaCurve hyperbolaCurve

The hyperbolaCurve
Returns
Type Description
Double

The radius on x of the hyperbola

getIntersectionCurveDefinition

get all parameters contained in the intersectionCurve

See also:

Declaration
cad.getIntersectionCurveDefinition(intersectionCurve) -> cad.Surface, cad.Surface, cad.PolylineCurve, cad.Bounds1D
Parameters
Type Name Description
IntersectionCurve intersectionCurve

The intersectionCurve
Returns
Type Description
Surface

The first surface of the intersectionCurve

getLineCurveDefinition

get all parameters contain in the lineCurve

See also:

Declaration
cad.getLineCurveDefinition(lineCurve) -> geom.Point3, geom.Point3
Parameters
Type Name Description
LineCurve lineCurve

The lineCurve
Returns
Type Description
Point3

The origin of the lineCurve

getLoopCoEdges

get all coEdges contain in the loop

See also:

Declaration
cad.getLoopCoEdges(loop) -> cad.CoEdgeList
Parameters
Type Name Description
Loop loop

The loop
Returns
Type Description
CoEdgeList

The coEdges contain within the loop

getNURBSCurveDefinition

get all parameters contained in the nurbsCurve

See also:

Declaration
cad.getNURBSCurveDefinition(nurbsCurve) -> core.Int, core.DoubleList, geom.Point3List, core.DoubleList
Parameters
Type Name Description
NURBSCurve nurbsCurve

The nurbsCurve
Returns
Type Description
Int

The degree of the nurbsCurve

getNURBSSurfaceDefinition

get all parameters contained in the nurbsSurface

See also:

Declaration
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 Description
Int

The degree on U of the nurbsSurface

getOffsetCurveDefinition

get all parameters contained in the offsetCurve

See also:

Declaration
cad.getOffsetCurveDefinition(offsetCurve) -> cad.Curve, geom.Point3, core.Double, cad.Surface
Parameters
Type Name Description
OffsetCurve offsetCurve

The offsetCurve
Returns
Type Description
Curve

The curve of the offsetCurve

getOffsetSurfaceDefinition

get all parameters contained in the offsetSurface

See also:

Declaration
cad.getOffsetSurfaceDefinition(offsetSurface) -> cad.Surface, core.Double
Parameters
Type Name Description
OffsetSurface offsetSurface

The offsetSurface
Returns
Type Description
Surface

The initial surface

getOpenShellOrientedFaces

get all orienteFaces contain in the openShell

See also:

Declaration
cad.getOpenShellOrientedFaces(openShell) -> cad.OrientedFaceList
Parameters
Type Name Description
OpenShell openShell

The openShell
Returns
Type Description
OrientedFaceList

The orientedFaces contain within the openShell

getParabolaCurveDefinition

get all parameters contained in the parabolaCurve

See also:

Declaration
cad.getParabolaCurveDefinition(parabolaCurve) -> core.Double, geom.Matrix4
Parameters
Type Name Description
ParabolaCurve parabolaCurve

The parabolaCurve
Returns
Type Description
Double

The radius of the hyperbola

getParametricPrecisionOnSurface

returns the parametric precision of a surface from the input precision

See also:

Declaration
cad.getParametricPrecisionOnSurface(surface, precision) -> core.Double
Parameters
Type Name Description
Surface surface

The surface
Double precision

Input precision
Returns
Type Description
Double

getPlaneSurfaceDefinition

get all parameters contained in the planeSurface

See also:

Declaration
cad.getPlaneSurfaceDefinition(planeSurface) -> geom.Matrix4
Parameters
Type Name Description
PlaneSurface planeSurface

The planeSurface
Returns
Type Description
Matrix4

The transformation matrix of planeSurface

getPolylineCurveDefinition

get all parameters contained in the polylinCurve

See also:

Declaration
cad.getPolylineCurveDefinition(polylineCurve) -> geom.Point3List, core.DoubleList
Parameters
Type Name Description
PolylineCurve polylineCurve

The polylineCurve
Returns
Type Description
Point3List

The points of the polylineCurve

getRevolutionSurfaceDefinition

get all parameters contained in the revolutionSurface

See also:

Declaration
cad.getRevolutionSurfaceDefinition(revolutionSurface) -> cad.Curve, geom.Point3, geom.Point3, core.Double, core.Double
Parameters
Type Name Description
RevolutionSurface revolutionSurface

The revolutionSurface
Returns
Type Description
Curve

The generatrix curve of the revolutionSurface

getRuledSurfaceDefinition

get all parameters contained in the ruledSurface

See also:

Declaration
cad.getRuledSurfaceDefinition(ruledSurface) -> cad.Curve, cad.Curve
Parameters
Type Name Description
RuledSurface ruledSurface

The ruledSurface
Returns
Type Description
Curve

The first curve of the ruledSurface

getSegmentCurveDefinition

get all parameters contained in the segmentCurve

See also:

Declaration
cad.getSegmentCurveDefinition(segmentCurve) -> geom.Point3, geom.Point3
Parameters
Type Name Description
SegmentCurve segmentCurve

The segmentCurve
Returns
Type Description
Point3

The first point of the segmentCurve

getSphereSurfaceDefinition

get all parameters contained in the sphereSurface

See also:

Declaration
cad.getSphereSurfaceDefinition(sphereSurface) -> core.Double, geom.Matrix4
Parameters
Type Name Description
SphereSurface sphereSurface

The sphereSurface
Returns
Type Description
Double

The radius of the sphereSurface

getSurfaceLimits

get the parametric space limits of a surface

See also:

Declaration
cad.getSurfaceLimits(surface) -> cad.Bounds2D
Parameters
Type Name Description
Surface surface

The surface
Returns
Type Description
Bounds2D

Surface limits

getSurfacicCurveDefinition

get all parameters contained in the surfacicCurve

See also:

Declaration
cad.getSurfacicCurveDefinition(surfacicCurve) -> cad.Surface, cad.Curve
Parameters
Type Name Description
SurfacicCurve surfacicCurve

The surfacicCurve
Returns
Type Description
Surface

The surface of the surfacicCurve

getTabulatedCylinderSurfaceDefinition

get all parameters contained in the TabulatedCylinderSurface

See also:

Declaration
cad.getTabulatedCylinderSurfaceDefinition(tabulatedCylinderSurface) -> cad.Curve, geom.Point3, cad.Bounds1D
Parameters
Type Name Description
TabulatedCylinderSurface tabulatedCylinderSurface

The tabulatedCylinderSurface
Returns
Type Description
Curve

The directrix curve of the tabulatedCylinderSurface

getTorusSurfaceDefinition

get all parameters contained in the torusSurface

See also:

Declaration
cad.getTorusSurfaceDefinition(torusSurface) -> core.Double, core.Double, geom.Matrix4, core.Int
Parameters
Type Name Description
TorusSurface torusSurface

The torusSurface
Returns
Type Description
Double

The major radius of the torusSurface

getTransformedCurveDefinition

get all parameters contained in the transformedCurve

See also:

Declaration
cad.getTransformedCurveDefinition(transformedCurve) -> cad.Curve, geom.Matrix4
Parameters
Type Name Description
TransformedCurve transformedCurve

The transformedCurve
Returns
Type Description
Curve

The initial curve

getVertexPosition

get the position of the vertex

See also:

Declaration
cad.getVertexPosition(vertex) -> geom.Point3
Parameters
Type Name Description
Vertex vertex

The vertex
Returns
Type Description
Point3

The position of the vertex

invertOnCurve

invert a point to a curve

See also:

Declaration
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 Description
Double

The inversion parameter on the curve

invertOnSurface

invert a point to a surface

See also:

Declaration
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 Description
Point2

The inversion parameter on the surface

isCurveClosed

if the curve is closed, return true, return false otherwise

See also:

Declaration
cad.isCurveClosed(curve) -> core.Boolean
Parameters
Type Name Description
Curve curve

The curve
Returns
Type Description
Boolean

The value

isCurveFinite

if the curve is finite return true, return false otherwise

See also:

Declaration
cad.isCurveFinite(curve) -> core.Boolean
Parameters
Type Name Description
Curve curve

The curve
Returns
Type Description
Boolean

The value

isCurvePeriodic

if the curve is periodic return true, return false otherwise

See also:

Declaration
cad.isCurvePeriodic(curve) -> core.Boolean, core.Double
Parameters
Type Name Description
Curve curve

The curve
Returns
Type Description
Boolean

The value

isSurfaceClosed

return if the surface is closed on U or on V

See also:

Declaration
cad.isSurfaceClosed(surface) -> core.Boolean, core.Boolean
Parameters
Type Name Description
Surface surface

The surface
Returns
Type Description
Boolean

The value on U

isSurfacePeriodic

return if the surface is periodic on U or on V

See also:

Declaration
cad.isSurfacePeriodic(surface) -> core.Boolean, core.Boolean, core.Double, core.Double
Parameters
Type Name Description
Surface surface

The surface
Returns
Type Description
Boolean

The value on U

needTorusShapeCheck

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

See also:

Declaration
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 Description
Boolean

Result of the check

projectOnCurve

project a point to a curve

See also:

Declaration
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 Description
Double

The projection parameter on the curve

projectOnSurface

project a point to a surface

See also:

Declaration
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 Description
Point2

The projection parameter on the surface

setCoEdgeCurve2D

Set the curve 2D value of a coEdge

See also:

Declaration
cad.setCoEdgeCurve2D(coEdge, curve2D)
Parameters
Type Name Description
CoEdge coEdge

The coEdge
Curve curve2D

The new curve 2D

setCoEdgeSurface

Set the surface value of a coEdge

See also:

Declaration
cad.setCoEdgeSurface(coEdge, surface)
Parameters
Type Name Description
CoEdge coEdge

The coEdge
Surface surface

The new surface

setCurveLimits

set the parametric space limits of a curve

See also:

Declaration
cad.setCurveLimits(curve, limits)
Parameters
Type Name Description
Curve curve

The curve
Bounds1D limits

Curve limits

setEdgeMaterial

Define an edge's material

See also:

Declaration
cad.setEdgeMaterial(edge, material)
Parameters
Type Name Description
Edge edge

The edge to apply to style to
Material material

The material to apply

createBody

Create a body from a surface

See also:

Declaration
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 Description
Body

The created body

createClosedShell

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

See also:

Declaration
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 Description
ClosedShell

The created closedShell

createCoEdge

Create an coEdge with a edge and an orientation

See also:

Declaration
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 Description
CoEdge

The created edge

createEdge

Create an edge with a curve an extremity vertices

See also:

Declaration
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 Description
Edge

The created edge

createEdgeFromCurve

Create an edge from a limited curve

See also:

Declaration
cad.createEdgeFromCurve(curve) -> cad.Edge
Parameters
Type Name Description
Curve curve

Limited curve used to create the edge
Returns
Type Description
Edge

The created edge

createEdgeWithBounds

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

See also:

Declaration
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 Description
Edge

The created edge

createFace

Create a face from a surface

See also:

Declaration
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 Description
Face

The created face

createLoop

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

See also:

Declaration
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 Description
Loop

The created loop

createLoopFromCurve

Create a loop from a finite curve

See also:

Declaration
cad.createLoopFromCurve(curve) -> cad.Loop
Parameters
Type Name Description
Curve curve

The curve to create the loop with
Returns
Type Description
Loop

The created loop

createOpenShell

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

See also:

Declaration
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 Description
OpenShell

The created openShell

createVertex

Create a vertex from a position

See also:

Declaration
cad.createVertex(position) -> cad.Vertex
Parameters
Type Name Description
Point3 position

Vertex position
Returns
Type Description
Vertex

The created vertex

invertCoEdge

Invert a coedge

See also:

Declaration
cad.invertCoEdge(coedge)
Parameters
Type Name Description
CoEdge coedge

The coedge to invert

invertFaces

Invert faces

See also:

Declaration
cad.invertFaces(faces, invertLoops=True)
Parameters
Type Name Description
FaceList faces

The faces to invert
Boolean invertLoops

If true, invert loops orientation

invertLoop

Invert a loop

See also:

Declaration
cad.invertLoop(loop)
Parameters
Type Name Description
Loop loop

The loop to invert

isSurfaceFinite

return if the surface is finite

See also:

Declaration
cad.isSurfaceFinite(surface) -> core.Boolean
Parameters
Type Name Description
Surface surface

The surface
Returns
Type Description
Boolean

Tells if finite

addPrecisionArea

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

See also:

Declaration
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

createBezierSurface

Create a new bezier surface

See also:

Declaration
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 Description
Surface

The new Bezier surface

createConeSurface

Create a new cone surface

See also:

Declaration
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 Description
Surface

The new cone surface

createCurveExtrusionSurface

Create a new curveExtrusion surface

See also:

Declaration
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 Description
Surface

The new curveExtrusion surface

createCylinderSurface

Create a new cylinder surface

See also:

Declaration
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 Description
Surface

The new cylinder surface

createEllipticConeSurface

Create a new elliptic cone surface

See also:

Declaration
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 Description
Surface

The new elliptic cone surface

createNURBSSurface

Create a new NURBS surface

See also:

Declaration
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 Description
Surface

The new NURBS surface

createOffsetSurface

Create a new offset surface

See also:

Declaration
cad.createOffsetSurface(baseSurface, distance) -> cad.Surface
Parameters
Type Name Description
Surface baseSurface

The base surface
Double distance

The offset distance
Returns
Type Description
Surface

The new offset surface

createPlaneSurface

Create a new plane surface

See also:

Declaration
cad.createPlaneSurface(matrix=geom.IdentityMatrix4) -> cad.Surface
Parameters
Type Name Description
Matrix4 matrix

Positionning matrix of the plane
Returns
Type Description
Surface

The new plane surface

createRevolutionSurface

Create a new revolution surface

See also:

Declaration
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 Description
Surface

Revolution surface generated by rotating the given curve around the axis

createRuledSurface

Create a new ruled surface

See also:

Declaration
cad.createRuledSurface(firstCurve, secondCurve) -> cad.Surface
Parameters
Type Name Description
Curve firstCurve

First Curve
Curve secondCurve

Seconde Curve
Returns
Type Description
Surface

The new ruled surface

createSphereSurface

Create a new sphere surface

See also:

Declaration
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 Description
Surface

The new sphere surface

createTabulatedCylinderSurface

Create a new tabulated cylinder surface

See also:

Declaration
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 Description
Surface

The new tabulated cylinder surface

createTorusSurface

Create a new torus surface

See also:

Declaration
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 Description
Surface

The new torus surface

needPrecisionArea

tells if it needs a working area on the surface

See also:

Declaration
cad.needPrecisionArea(surface) -> core.Boolean
Parameters
Type Name Description
Surface surface

Surface to check if it needs precision area
Returns
Type Description
Boolean

Result