dsl: { assembly: ((id,
instances,
opts?) => IntentAssembly); assemblyInstance: ((id,
part,
transform?,
tags?) => AssemblyInstance); assemblyOutput: ((name,
refs) => AssemblyOutput); assemblyRef: ((instanceId,
connector) => AssemblyRef); assertBrepValid: ((id,
target?) => AssertionBrepValid); assertMinEdgeLength: ((id,
min,
target?) => AssertionMinEdgeLength); axisDatum: ((ref) => AxisSpec); axisSketchNormal: (() => ExtrudeAxis); axisVector: ((direction) => AxisSpec); booleanOp: ((id,
op,
left,
right,
result?,
deps?) => BooleanOp); chamfer: ((id,
edges,
distance,
depsOrOpts?) => Chamfer); context: ((overrides?) => BuildContext); cosmeticThread: ((id,
target,
opts?) => CosmeticThread); curveIntersect: ((id,
first,
second,
result?,
deps?) => CurveIntersect); datumAxis: ((id,
direction,
origin?,
deps?) => DatumAxis); datumFeature: ((id,
label,
target,
opts?) => FTIDatum); datumFrame: ((id,
on,
deps?) => DatumFrame); datumPlane: ((id,
normal,
origin?,
deps?,
opts?) => DatumPlane); datumRef: ((datum,
modifiers?) => DatumRef); deleteFace: ((id,
source,
faces,
result?,
deps?,
opts?) => DeleteFace); dimensionAngle: ((id,
from,
to,
opts?) => DimensionAngle); dimensionDistance: ((id,
from,
to,
opts?) => DimensionDistance); document: ((id,
parts,
ctx?,
assemblies?,
opts?) => IntentDocument); draft: ((id,
source,
faces,
neutralPlane,
pullDirection,
angle,
result?,
deps?) => Draft); exprAdd: ((left,
right) => Expr); exprDiv: ((left,
right) => Expr); exprLiteral: ((value,
unit?) => Expr); exprMul: ((left,
right) => Expr); exprNeg: ((value) => Expr); exprParam: ((id) => Expr); exprSub: ((left,
right) => Expr); extendSurface: ((id,
source,
edges,
distance,
result?,
deps?,
opts?) => ExtendSurface); extrude: ((id,
profile,
depth,
result?,
deps?,
opts?) => Extrude); featureArray: (<T>(layout,
make) => T[]); featureArrayAlongSpline: (<T>(layout,
make) => T[]); featureCircularArray: (<T>(layout,
make) => T[]); featureRadialArray: (<T>(layout,
make) => T[]); fillet: ((id,
edges,
radius,
depsOrOpts?) => Fillet); flatnessConstraint: ((id,
target,
tolerance,
opts?) => FlatnessConstraint); hexTubeSweep: ((id,
path,
outerAcrossFlats,
innerAcrossFlats?,
result?,
opts?) => HexTubeSweep); hole: ((id,
onFace,
axis,
diameter,
depth,
opts?) => Hole); holeWizard: ((id,
onFace,
axis,
diameter,
opts?) => Hole); knit: ((id,
sources,
result?,
deps?,
opts?) => Knit); loft: ((id,
profiles,
result?,
deps?,
opts?) => Loft); mateAngle: ((a,
b,
angle?) => AssemblyMate); mateCoaxial: ((a,
b) => AssemblyMate); mateConnector: ((id,
origin,
opts?) => MateConnector); mateDistance: ((a,
b,
distance?) => AssemblyMate); mateFixed: ((a,
b) => AssemblyMate); mateHinge: ((a,
b,
offset?) => AssemblyMate); mateInsert: ((a,
b,
offset?) => AssemblyMate); mateParallel: ((a,
b) => AssemblyMate); matePerpendicular: ((a,
b) => AssemblyMate); matePlanar: ((a,
b,
offset?) => AssemblyMate); mateSlider: ((a,
b) => AssemblyMate); mirror: ((id,
source,
plane,
result?,
deps?) => Mirror); moveBody: ((id,
source,
result?,
deps?,
opts?) => MoveBody); moveFace: ((id,
source,
faces,
result?,
deps?,
opts?) => MoveFace); parallelismConstraint: ((id,
target,
tolerance,
datum,
opts?) => ParallelismConstraint); paramAngle: ((id,
value) => ParamDef); paramCount: ((id,
value) => ParamDef); paramLength: ((id,
value) => ParamDef); part: ((id,
features,
opts?) => IntentPart); pathArc: ((start,
end,
center,
direction?) => PathSegment); pathHelix: ((opts) => Path3D); pathLine: ((start,
end) => PathSegment); pathPolyline: ((points,
opts?) => Path3D); pathSegments: ((segments) => Path3D); pathSpiral: ((opts) => Path3D); pathSpline: ((points,
opts?) => Path3D); patternCircular: ((id,
origin,
axis,
count,
depsOrOpts?) => PatternCircular); patternLinear: ((id,
origin,
spacing,
count,
depsOrOpts?) => PatternLinear); perpendicularityConstraint: ((id,
target,
tolerance,
datum,
opts?) => PerpendicularityConstraint); pipe: ((id,
axis,
length,
outerDiameter,
innerDiameter?,
result?,
opts?) => Pipe); pipeSweep: ((id,
path,
outerDiameter,
innerDiameter?,
result?,
opts?) => PipeSweep); plane: ((id,
width,
height,
result?,
opts?) => Plane); planeDatum: ((ref) => PlaneRef); positionConstraint: ((id,
target,
tolerance,
datum,
opts?) => PositionConstraint); predCreatedBy: ((featureId) => Predicate); predNormal: ((value) => Predicate); predPlanar: (() => Predicate); predRole: ((value) => Predicate); profileCircle: ((radius,
center?) => Profile); profilePoly: ((sides,
radius,
center?,
rotation?) => Profile); profileRect: ((width,
height,
center?) => Profile); profileRef: ((name) => ProfileRef); profileSketchLoop: ((loop,
opts?) => Profile); rankClosestTo: ((target) => RankRule); rankMaxArea: (() => RankRule); rankMaxZ: (() => RankRule); rankMinZ: (() => RankRule); refAxis: ((selector) => RefAxis); refEdge: ((selector) => RefEdge); refFrame: ((selector) => RefFrame); refPoint: ((selector,
locator?) => RefPoint); refSurface: ((selector) => RefSurface); replaceFace: ((id,
source,
faces,
tool,
result?,
deps?,
opts?) => ReplaceFace); revolve: ((id,
profile,
axis,
angle,
result?,
opts?) => Revolve); selectorEdge: ((predicates,
rank?) => EdgeQuery); selectorFace: ((predicates,
rank?) => FaceQuery); selectorNamed: ((name) => NamedOutput); selectorSolid: ((predicates,
rank?) => SolidQuery); shell: ((id,
source,
thickness,
result?,
deps?,
opts?) => Shell); sizeConstraint: ((id,
target,
opts) => SizeConstraint); sketch2d: ((id,
profiles,
opts?) => Sketch2D); sketchArc: ((id,
start,
end,
center,
direction,
opts?) => SketchArc); sketchArray: (<T>(layout,
make) => T[]); sketchArrayAlongSpline: (<T>(layout,
make) => T[]); sketchCircle: ((id,
center,
radius,
opts?) => SketchCircle); sketchCircularArray: (<T>(layout,
make) => T[]); sketchConstraintAngle: ((id,
a,
b,
angle) => SketchConstraint); sketchConstraintCoincident: ((id,
a,
b) => SketchConstraint); sketchConstraintCollinear: ((id,
a,
b) => SketchConstraint); sketchConstraintConcentric: ((id,
a,
b) => SketchConstraint); sketchConstraintDistance: ((id,
a,
b,
distance) => SketchConstraint); sketchConstraintEqualLength: ((id,
a,
b) => SketchConstraint); sketchConstraintFixPoint: ((id,
point,
opts?) => SketchConstraint); sketchConstraintHorizontal: ((id,
line) => SketchConstraint); sketchConstraintMidpoint: ((id,
point,
line) => SketchConstraint); sketchConstraintParallel: ((id,
a,
b) => SketchConstraint); sketchConstraintPerpendicular: ((id,
a,
b) => SketchConstraint); sketchConstraintPointOnLine: ((id,
point,
line) => SketchConstraint); sketchConstraintRadius: ((id,
curve,
radius) => SketchConstraint); sketchConstraintSymmetry: ((id,
a,
b,
axis) => SketchConstraint); sketchConstraintTangent: ((id,
a,
b) => SketchConstraint); sketchConstraintVertical: ((id,
line) => SketchConstraint); sketchEllipse: ((id,
center,
radiusX,
radiusY,
opts?) => SketchEllipse); sketchLine: ((id,
start,
end,
opts?) => SketchLine); sketchPoint: ((id,
point,
opts?) => SketchPoint); sketchPointRef: ((entity,
handle?) => SketchConstraintPointRef); sketchPolygon: ((id,
center,
radius,
sides,
opts?) => SketchPolygon); sketchProfileLoop: ((sketchId,
profileName,
loop,
entities,
opts?) => SketchProfileBundle); sketchRadialArray: (<T>(layout,
make) => T[]); sketchRectCenter: ((id,
center,
width,
height,
opts?) => SketchRectangle); sketchRectCorner: ((id,
corner,
width,
height,
opts?) => SketchRectangle); sketchSlot: ((id,
center,
length,
width,
opts?) => SketchSlot); sketchSpline: ((id,
points,
opts?) => SketchSpline); splitBody: ((id,
source,
tool,
result?,
deps?,
opts?) => SplitBody); splitFace: ((id,
faces,
tool,
result?,
deps?) => SplitFace); surface: ((id,
profile,
result?,
deps?) => Surface); surfaceProfileConstraint: ((id,
target,
tolerance,
opts?) => SurfaceProfileConstraint); sweep: ((id,
profile,
path,
result?,
deps?,
opts?) => Sweep); thicken: ((id,
surface,
thickness,
result?,
deps?,
opts?) => Thicken); thread: ((id,
axis,
length,
majorDiameter,
pitch,
result?,
deps?,
opts?) => Thread); transform: ((opts?) => Transform); trimSurface: ((id,
source,
tools,
result?,
deps?,
opts?) => TrimSurface); unwrap: ((id,
source,
result?,
deps?,
opts?) => Unwrap); variableChamfer: ((id,
source,
entries,
result?,
deps?) => VariableChamfer); variableFillet: ((id,
source,
entries,
result?,
deps?) => VariableFillet); withTags: (<T>(feature,
tags) => T); } = ... Type declaration
assembly: ((id, instances, opts?) => IntentAssembly)
assemblyInstance: ((id, part, transform?, tags?) => AssemblyInstance)
- (id, part, transform?, tags?): AssemblyInstance
Parameters
- id: string
- part: string
Optional transform: TransformOptional tags: string[]
assemblyOutput: ((name, refs) => AssemblyOutput)
assemblyRef: ((instanceId, connector) => AssemblyRef)
- (instanceId, connector): AssemblyRef
Parameters
- instanceId: string
- connector: string
assertMinEdgeLength: ((id, min, target?) => AssertionMinEdgeLength)
axisDatum: ((ref) => AxisSpec)
axisSketchNormal: (() => ExtrudeAxis)
axisVector: ((direction) => AxisSpec)
booleanOp: ((id, op, left, right, result?, deps?) => BooleanOp)
- (id, op, left, right, result?, deps?): BooleanOp
Parameters
- id: string
- op: "union" | "subtract" | "intersect"
- left: Selector
- right: Selector
Optional result: stringOptional deps: string[]
chamfer: ((id, edges, distance, depsOrOpts?) => Chamfer)
- (id, edges, distance, depsOrOpts?): Chamfer
Parameters
- id: string
- edges: Selector
- distance: number
Optional depsOrOpts: string[] | {
deps?: string[];
result?: string;
}
context: ((overrides?) => BuildContext)
cosmeticThread: ((id, target, opts?) => CosmeticThread)
- (id, target, opts?): CosmeticThread
Parameters
- id: string
- target: GeometryRef
Optional opts: {
capabilities?: string[];
class?: string;
depth?: Scalar;
designation?: string;
handedness?: "right" | "left";
internal?: boolean;
length?: Scalar;
majorDiameter?: Scalar;
minorDiameter?: Scalar;
notes?: string[];
pitch?: Scalar;
requirement?: string;
series?: string;
standard?: string;
}Optional capabilities?: string[]
Optional class?: string
Optional depth?: Scalar
Optional designation?: string
Optional handedness?: "right" | "left"
Optional internal?: boolean
Optional length?: Scalar
Optional majorDiameter?: Scalar
Optional minorDiameter?: Scalar
Optional notes?: string[]
Optional pitch?: Scalar
Optional requirement?: string
Optional series?: string
Optional standard?: string
curveIntersect: ((id, first, second, result?, deps?) => CurveIntersect)
datumAxis: ((id, direction, origin?, deps?) => DatumAxis)
- (id, direction, origin?, deps?): DatumAxis
Parameters
- id: string
- direction: AxisSpec
Optional origin: [number, number, number]Optional deps: string[]
datumFeature: ((id, label, target, opts?) => FTIDatum)
- (id, label, target, opts?): FTIDatum
Parameters
- id: string
- label: string
- target: RefSurface | RefFrame | RefEdge | RefAxis | RefPoint
Optional opts: {
capabilities?: string[];
modifiers?: ("MMB" | "LMB" | "RMB")[];
requirement?: string;
}Optional capabilities?: string[]
Optional modifiers?: ("MMB" | "LMB" | "RMB")[]
Optional requirement?: string
datumFrame: ((id, on, deps?) => DatumFrame)
datumPlane: ((id, normal, origin?, deps?, opts?) => DatumPlane)
- (id, normal, origin?, deps?, opts?): DatumPlane
Parameters
- id: string
- normal: AxisSpec
Optional origin: [number, number, number]Optional deps: string[]Optional opts: {
xAxis?: AxisSpec;
}
datumRef: ((datum, modifiers?) => DatumRef)
- (datum, modifiers?): DatumRef
Parameters
- datum: string
Optional modifiers: ("MMB" | "LMB" | "RMB")[]
deleteFace: ((id, source, faces, result?, deps?, opts?) => DeleteFace)
- (id, source, faces, result?, deps?, opts?): DeleteFace
Parameters
- id: string
- source: Selector
- faces: Selector
Optional result: stringOptional deps: string[]Optional opts: {
heal?: boolean;
}
dimensionAngle: ((id, from, to, opts?) => DimensionAngle)
dimensionDistance: ((id, from, to, opts?) => DimensionDistance)
document: ((id, parts, ctx?, assemblies?, opts?) => IntentDocument)
draft: ((id, source, faces, neutralPlane, pullDirection, angle, result?, deps?) => Draft)
- (id, source, faces, neutralPlane, pullDirection, angle, result?, deps?): Draft
exprAdd: ((left, right) => Expr)
exprDiv: ((left, right) => Expr)
exprLiteral: ((value, unit?) => Expr)
- (value, unit?): Expr
Parameters
- value: number
Optional unit: "mm" | "cm" | "m" | "in" | "rad" | "deg"
exprMul: ((left, right) => Expr)
exprNeg: ((value) => Expr)
exprParam: ((id) => Expr)
exprSub: ((left, right) => Expr)
extendSurface: ((id, source, edges, distance, result?, deps?, opts?) => ExtendSurface)
- (id, source, edges, distance, result?, deps?, opts?): ExtendSurface
Parameters
- id: string
- source: Selector
- edges: Selector
- distance: Scalar
Optional result: stringOptional deps: string[]Optional opts: {
mode?: "natural" | "tangent";
}Optional mode?: "natural" | "tangent"
extrude: ((id, profile, depth, result?, deps?, opts?) => Extrude)
- (id, profile, depth, result?, deps?, opts?): Extrude
Parameters
- id: string
- profile: ProfileRef
- depth: "throughAll" | Scalar
Optional result: stringOptional deps: string[]Optional opts: {
axis?: ExtrudeAxis;
mode?: "solid" | "surface";
}Optional mode?: "solid" | "surface"
featureArray: (<T>(layout, make) => T[])
- <T>(layout, make): T[]
Returns T[]
featureArrayAlongSpline: (<T>(layout, make) => T[])
- <T>(layout, make): T[]
Returns T[]
featureCircularArray: (<T>(layout, make) => T[])
- <T>(layout, make): T[]
Returns T[]
featureRadialArray: (<T>(layout, make) => T[])
- <T>(layout, make): T[]
Returns T[]
fillet: ((id, edges, radius, depsOrOpts?) => Fillet)
- (id, edges, radius, depsOrOpts?): Fillet
Parameters
- id: string
- edges: Selector
- radius: number
Optional depsOrOpts: string[] | {
deps?: string[];
result?: string;
}
flatnessConstraint: ((id, target, tolerance, opts?) => FlatnessConstraint)
- (id, target, tolerance, opts?): FlatnessConstraint
Parameters
- id: string
- target: RefSurface
- tolerance: Scalar
Optional opts: {
capabilities?: string[];
requirement?: string;
}Optional capabilities?: string[]
Optional requirement?: string
hexTubeSweep: ((id, path, outerAcrossFlats, innerAcrossFlats?, result?, opts?) => HexTubeSweep)
- (id, path, outerAcrossFlats, innerAcrossFlats?, result?, opts?): HexTubeSweep
Parameters
- id: string
- path: Path3D
- outerAcrossFlats: Scalar
Optional innerAcrossFlats: ScalarOptional result: stringOptional opts: {
deps?: string[];
mode?: "solid" | "surface";
}Optional deps?: string[]
Optional mode?: "solid" | "surface"
hole: ((id, onFace, axis, diameter, depth, opts?) => Hole)
- (id, onFace, axis, diameter, depth, opts?): Hole
holeWizard: ((id, onFace, axis, diameter, opts?) => Hole)
- (id, onFace, axis, diameter, opts?): Hole
Parameters
- id: string
- onFace: Selector
- axis: "+X" | "-X" | "+Y" | "-Y" | "+Z" | "-Z"
- diameter: number
Optional opts: {
counterbore?: HoleCounterbore;
countersink?: HoleCountersink;
deps?: string[];
depth?: "throughAll" | Scalar;
endCondition?: "blind" | "throughAll" | "upToNext" | "upToLast";
fitClass?: string;
pattern?: PatternRef;
position?: Point2D;
result?: string;
series?: string;
size?: string;
standard?: string;
threadClass?: string;
threaded?: boolean;
}Optional deps?: string[]
Optional depth?: "throughAll" | Scalar
Optional endCondition?: "blind" | "throughAll" | "upToNext" | "upToLast"
Optional fitClass?: string
Optional position?: Point2D
Optional result?: string
Optional series?: string
Optional size?: string
Optional standard?: string
Optional threadClass?: string
Optional threaded?: boolean
knit: ((id, sources, result?, deps?, opts?) => Knit)
- (id, sources, result?, deps?, opts?): Knit
Parameters
- id: string
- sources: Selector[]
Optional result: stringOptional deps: string[]Optional opts: {
makeSolid?: boolean;
tolerance?: Scalar;
}Optional makeSolid?: boolean
Optional tolerance?: Scalar
loft: ((id, profiles, result?, deps?, opts?) => Loft)
- (id, profiles, result?, deps?, opts?): Loft
Parameters
- id: string
- profiles: ProfileRef[]
Optional result: stringOptional deps: string[]Optional opts: {
mode?: "solid" | "surface";
}Optional mode?: "solid" | "surface"
mateAngle: ((a, b, angle?) => AssemblyMate)
mateCoaxial: ((a, b) => AssemblyMate)
mateConnector: ((id, origin, opts?) => MateConnector)
- (id, origin, opts?): MateConnector
Parameters
- id: string
- origin: Selector
Optional opts: {
normal?: "+X" | "-X" | "+Y" | "-Y" | "+Z" | "-Z";
xAxis?: "+X" | "-X" | "+Y" | "-Y" | "+Z" | "-Z";
}Optional normal?: "+X" | "-X" | "+Y" | "-Y" | "+Z" | "-Z"
Optional xAxis?: "+X" | "-X" | "+Y" | "-Y" | "+Z" | "-Z"
mateDistance: ((a, b, distance?) => AssemblyMate)
mateHinge: ((a, b, offset?) => AssemblyMate)
mateInsert: ((a, b, offset?) => AssemblyMate)
mateParallel: ((a, b) => AssemblyMate)
matePerpendicular: ((a, b) => AssemblyMate)
matePlanar: ((a, b, offset?) => AssemblyMate)
mirror: ((id, source, plane, result?, deps?) => Mirror)
- (id, source, plane, result?, deps?): Mirror
Parameters
- id: string
- source: Selector
- plane: PlaneRef
Optional result: stringOptional deps: string[]
moveBody: ((id, source, result?, deps?, opts?) => MoveBody)
- (id, source, result?, deps?, opts?): MoveBody
moveFace: ((id, source, faces, result?, deps?, opts?) => MoveFace)
- (id, source, faces, result?, deps?, opts?): MoveFace
parallelismConstraint: ((id, target, tolerance, datum, opts?) => ParallelismConstraint)
- (id, target, tolerance, datum, opts?): ParallelismConstraint
Parameters
- id: string
- target: RefSurface
- tolerance: Scalar
- datum: DatumRef[]
Optional opts: {
capabilities?: string[];
modifiers?: ("MMC" | "LMC" | "RFS" | "PROJECTED" | "FREE_STATE" | "TANGENT_PLANE" | "STATISTICAL")[];
requirement?: string;
}Optional capabilities?: string[]
Optional modifiers?: ("MMC" | "LMC" | "RFS" | "PROJECTED" | "FREE_STATE" | "TANGENT_PLANE" | "STATISTICAL")[]
Optional requirement?: string
paramAngle: ((id, value) => ParamDef)
paramCount: ((id, value) => ParamDef)
paramLength: ((id, value) => ParamDef)
part: ((id, features, opts?) => IntentPart)
pathArc: ((start, end, center, direction?) => PathSegment)
pathHelix: ((opts) => Path3D)
pathLine: ((start, end) => PathSegment)
pathPolyline: ((points, opts?) => Path3D)
- (points, opts?): Path3D
Parameters
- points: Point3D[]
Optional opts: {
closed?: boolean;
}Optional closed?: boolean
pathSegments: ((segments) => Path3D)
pathSpiral: ((opts) => Path3D)
pathSpline: ((points, opts?) => Path3D)
- (points, opts?): Path3D
Parameters
- points: Point3D[]
Optional opts: {
closed?: boolean;
degree?: Scalar;
}Optional closed?: boolean
Optional degree?: Scalar
patternCircular: ((id, origin, axis, count, depsOrOpts?) => PatternCircular)
- (id, origin, axis, count, depsOrOpts?): PatternCircular
Parameters
- id: string
- origin: Selector
- axis: "+X" | "-X" | "+Y" | "-Y" | "+Z" | "-Z"
- count: Scalar
Optional depsOrOpts: string[] | {
deps?: string[];
result?: string;
source?: Selector;
}
patternLinear: ((id, origin, spacing, count, depsOrOpts?) => PatternLinear)
perpendicularityConstraint: ((id, target, tolerance, datum, opts?) => PerpendicularityConstraint)
- (id, target, tolerance, datum, opts?): PerpendicularityConstraint
Parameters
- id: string
- target: RefSurface
- tolerance: Scalar
- datum: DatumRef[]
Optional opts: {
capabilities?: string[];
modifiers?: ("MMC" | "LMC" | "RFS" | "PROJECTED" | "FREE_STATE" | "TANGENT_PLANE" | "STATISTICAL")[];
requirement?: string;
}Optional capabilities?: string[]
Optional modifiers?: ("MMC" | "LMC" | "RFS" | "PROJECTED" | "FREE_STATE" | "TANGENT_PLANE" | "STATISTICAL")[]
Optional requirement?: string
pipe: ((id, axis, length, outerDiameter, innerDiameter?, result?, opts?) => Pipe)
- (id, axis, length, outerDiameter, innerDiameter?, result?, opts?): Pipe
Parameters
- id: string
- axis: "+X" | "-X" | "+Y" | "-Y" | "+Z" | "-Z"
- length: Scalar
- outerDiameter: Scalar
Optional innerDiameter: ScalarOptional result: stringOptional opts: {
deps?: string[];
origin?: Point3D;
}Optional deps?: string[]
Optional origin?: Point3D
pipeSweep: ((id, path, outerDiameter, innerDiameter?, result?, opts?) => PipeSweep)
- (id, path, outerDiameter, innerDiameter?, result?, opts?): PipeSweep
Parameters
- id: string
- path: Path3D
- outerDiameter: Scalar
Optional innerDiameter: ScalarOptional result: stringOptional opts: {
deps?: string[];
mode?: "solid" | "surface";
}Optional deps?: string[]
Optional mode?: "solid" | "surface"
plane: ((id, width, height, result?, opts?) => Plane)
- (id, width, height, result?, opts?): Plane
planeDatum: ((ref) => PlaneRef)
positionConstraint: ((id, target, tolerance, datum, opts?) => PositionConstraint)
- (id, target, tolerance, datum, opts?): PositionConstraint
Parameters
- id: string
- target: RefSurface | RefFrame | RefEdge | RefAxis | RefPoint
- tolerance: Scalar
- datum: DatumRef[]
Optional opts: {
capabilities?: string[];
modifiers?: ("MMC" | "LMC" | "RFS" | "PROJECTED" | "FREE_STATE" | "TANGENT_PLANE" | "STATISTICAL")[];
requirement?: string;
zone?: "diameter" | "cartesian";
}Optional capabilities?: string[]
Optional modifiers?: ("MMC" | "LMC" | "RFS" | "PROJECTED" | "FREE_STATE" | "TANGENT_PLANE" | "STATISTICAL")[]
Optional requirement?: string
Optional zone?: "diameter" | "cartesian"
predCreatedBy: ((featureId) => Predicate)
predNormal: ((value) => Predicate)
- (value): Predicate
Parameters
- value: "+X" | "-X" | "+Y" | "-Y" | "+Z" | "-Z"
predPlanar: (() => Predicate)
predRole: ((value) => Predicate)
profileCircle: ((radius, center?) => Profile)
profilePoly: ((sides, radius, center?, rotation?) => Profile)
- (sides, radius, center?, rotation?): Profile
profileRect: ((width, height, center?) => Profile)
profileRef: ((name) => ProfileRef)
profileSketchLoop: ((loop, opts?) => Profile)
- (loop, opts?): Profile
Parameters
- loop: string[]
Optional opts: {
holes?: string[][];
open?: boolean;
}Optional holes?: string[][]
Optional open?: boolean
rankClosestTo: ((target) => RankRule)
rankMaxArea: (() => RankRule)
rankMaxZ: (() => RankRule)
rankMinZ: (() => RankRule)
refAxis: ((selector) => RefAxis)
refEdge: ((selector) => RefEdge)
refFrame: ((selector) => RefFrame)
refPoint: ((selector, locator?) => RefPoint)
- (selector, locator?): RefPoint
Parameters
- selector: Selector
Optional locator: "center" | "mid" | "start" | "end"
refSurface: ((selector) => RefSurface)
replaceFace: ((id, source, faces, tool, result?, deps?, opts?) => ReplaceFace)
- (id, source, faces, tool, result?, deps?, opts?): ReplaceFace
Parameters
- id: string
- source: Selector
- faces: Selector
- tool: Selector
Optional result: stringOptional deps: string[]Optional opts: {
heal?: boolean;
}
revolve: ((id, profile, axis, angle, result?, opts?) => Revolve)
- (id, profile, axis, angle, result?, opts?): Revolve
Parameters
- id: string
- profile: ProfileRef
- axis: "+X" | "-X" | "+Y" | "-Y" | "+Z" | "-Z"
- angle: undefined | Scalar | "full"
Optional result: stringOptional opts: {
deps?: string[];
mode?: "solid" | "surface";
origin?: [number, number, number];
}Optional deps?: string[]
Optional mode?: "solid" | "surface"
Optional origin?: [number, number, number]
selectorEdge: ((predicates, rank?) => EdgeQuery)
selectorFace: ((predicates, rank?) => FaceQuery)
selectorNamed: ((name) => NamedOutput)
selectorSolid: ((predicates, rank?) => SolidQuery)
shell: ((id, source, thickness, result?, deps?, opts?) => Shell)
- (id, source, thickness, result?, deps?, opts?): Shell
Parameters
- id: string
- source: Selector
- thickness: Scalar
Optional result: stringOptional deps: string[]Optional opts: {
direction?: "inside" | "outside";
openFaces?: Selector[];
}Optional direction?: "inside" | "outside"
Optional openFaces?: Selector[]
sizeConstraint: ((id, target, opts) => SizeConstraint)
- (id, target, opts): SizeConstraint
Parameters
- id: string
- target: RefSurface | RefFrame | RefEdge | RefAxis | RefPoint
- opts: {
capabilities?: string[];
max?: Scalar;
min?: Scalar;
modifiers?: ("MMC" | "LMC" | "RFS" | "PROJECTED" | "FREE_STATE" | "TANGENT_PLANE" | "STATISTICAL")[];
nominal?: Scalar;
requirement?: string;
tolerance?: Scalar;
}Optional capabilities?: string[]
Optional max?: Scalar
Optional min?: Scalar
Optional modifiers?: ("MMC" | "LMC" | "RFS" | "PROJECTED" | "FREE_STATE" | "TANGENT_PLANE" | "STATISTICAL")[]
Optional nominal?: Scalar
Optional requirement?: string
Optional tolerance?: Scalar
sketch2d: ((id, profiles, opts?) => Sketch2D)
sketchArc: ((id, start, end, center, direction, opts?) => SketchArc)
- (id, start, end, center, direction, opts?): SketchArc
Parameters
- id: string
- start: Point2D
- end: Point2D
- center: Point2D
- direction: "cw" | "ccw"
Optional opts: {
construction?: boolean;
}Optional construction?: boolean
sketchArray: (<T>(layout, make) => T[])
- <T>(layout, make): T[]
Returns T[]
sketchArrayAlongSpline: (<T>(layout, make) => T[])
- <T>(layout, make): T[]
Returns T[]
sketchCircle: ((id, center, radius, opts?) => SketchCircle)
- (id, center, radius, opts?): SketchCircle
Parameters
- id: string
- center: Point2D
- radius: Scalar
Optional opts: {
construction?: boolean;
}Optional construction?: boolean
sketchCircularArray: (<T>(layout, make) => T[])
- <T>(layout, make): T[]
Returns T[]
sketchConstraintAngle: ((id, a, b, angle) => SketchConstraint)
sketchConstraintCoincident: ((id, a, b) => SketchConstraint)
sketchConstraintCollinear: ((id, a, b) => SketchConstraint)
sketchConstraintConcentric: ((id, a, b) => SketchConstraint)
sketchConstraintDistance: ((id, a, b, distance) => SketchConstraint)
sketchConstraintEqualLength: ((id, a, b) => SketchConstraint)
sketchConstraintFixPoint: ((id, point, opts?) => SketchConstraint)
sketchConstraintHorizontal: ((id, line) => SketchConstraint)
sketchConstraintMidpoint: ((id, point, line) => SketchConstraint)
sketchConstraintParallel: ((id, a, b) => SketchConstraint)
sketchConstraintPerpendicular: ((id, a, b) => SketchConstraint)
sketchConstraintPointOnLine: ((id, point, line) => SketchConstraint)
sketchConstraintRadius: ((id, curve, radius) => SketchConstraint)
sketchConstraintSymmetry: ((id, a, b, axis) => SketchConstraint)
sketchConstraintTangent: ((id, a, b) => SketchConstraint)
sketchConstraintVertical: ((id, line) => SketchConstraint)
sketchEllipse: ((id, center, radiusX, radiusY, opts?) => SketchEllipse)
- (id, center, radiusX, radiusY, opts?): SketchEllipse
Parameters
- id: string
- center: Point2D
- radiusX: Scalar
- radiusY: Scalar
Optional opts: {
construction?: boolean;
rotation?: Scalar;
}Optional construction?: boolean
Optional rotation?: Scalar
sketchLine: ((id, start, end, opts?) => SketchLine)
- (id, start, end, opts?): SketchLine
Parameters
- id: string
- start: Point2D
- end: Point2D
Optional opts: {
construction?: boolean;
}Optional construction?: boolean
sketchPoint: ((id, point, opts?) => SketchPoint)
- (id, point, opts?): SketchPoint
Parameters
- id: string
- point: Point2D
Optional opts: {
construction?: boolean;
}Optional construction?: boolean
- (entity, handle?): SketchConstraintPointRef
Parameters
- entity: string
Optional handle: "center" | "start" | "end" | "point" | "corner"
sketchPolygon: ((id, center, radius, sides, opts?) => SketchPolygon)
- (id, center, radius, sides, opts?): SketchPolygon
Parameters
- id: string
- center: Point2D
- radius: Scalar
- sides: Scalar
Optional opts: {
construction?: boolean;
rotation?: Scalar;
}Optional construction?: boolean
Optional rotation?: Scalar
sketchProfileLoop: ((sketchId, profileName, loop, entities, opts?) => SketchProfileBundle)
- (sketchId, profileName, loop, entities, opts?): SketchProfileBundle
Parameters
- sketchId: string
- profileName: string
- loop: string[]
- entities: SketchEntity[]
Optional opts: {
deps?: string[];
holes?: string[][];
open?: boolean;
origin?: [number, number, number];
plane?: Selector;
}Optional deps?: string[]
Optional holes?: string[][]
Optional open?: boolean
Optional origin?: [number, number, number]
Optional plane?: Selector
sketchRadialArray: (<T>(layout, make) => T[])
- <T>(layout, make): T[]
Returns T[]
sketchRectCenter: ((id, center, width, height, opts?) => SketchRectangle)
- (id, center, width, height, opts?): SketchRectangle
Parameters
- id: string
- center: Point2D
- width: Scalar
- height: Scalar
Optional opts: {
construction?: boolean;
rotation?: Scalar;
}Optional construction?: boolean
Optional rotation?: Scalar
sketchRectCorner: ((id, corner, width, height, opts?) => SketchRectangle)
- (id, corner, width, height, opts?): SketchRectangle
Parameters
- id: string
- corner: Point2D
- width: Scalar
- height: Scalar
Optional opts: {
construction?: boolean;
rotation?: Scalar;
}Optional construction?: boolean
Optional rotation?: Scalar
sketchSlot: ((id, center, length, width, opts?) => SketchSlot)
- (id, center, length, width, opts?): SketchSlot
Parameters
- id: string
- center: Point2D
- length: Scalar
- width: Scalar
Optional opts: {
construction?: boolean;
endStyle?: "arc" | "straight";
rotation?: Scalar;
}Optional construction?: boolean
Optional endStyle?: "arc" | "straight"
Optional rotation?: Scalar
sketchSpline: ((id, points, opts?) => SketchSpline)
- (id, points, opts?): SketchSpline
Parameters
- id: string
- points: Point2D[]
Optional opts: {
closed?: boolean;
construction?: boolean;
degree?: Scalar;
}Optional closed?: boolean
Optional construction?: boolean
Optional degree?: Scalar
splitBody: ((id, source, tool, result?, deps?, opts?) => SplitBody)
- (id, source, tool, result?, deps?, opts?): SplitBody
Parameters
- id: string
- source: Selector
- tool: Selector
Optional result: stringOptional deps: string[]Optional opts: {
keepTool?: boolean;
}Optional keepTool?: boolean
splitFace: ((id, faces, tool, result?, deps?) => SplitFace)
- (id, faces, tool, result?, deps?): SplitFace
Parameters
- id: string
- faces: Selector
- tool: Selector
Optional result: stringOptional deps: string[]
surface: ((id, profile, result?, deps?) => Surface)
- (id, profile, result?, deps?): Surface
Parameters
- id: string
- profile: ProfileRef
Optional result: stringOptional deps: string[]
surfaceProfileConstraint: ((id, target, tolerance, opts?) => SurfaceProfileConstraint)
- (id, target, tolerance, opts?): SurfaceProfileConstraint
Parameters
- id: string
- target: RefSurface
- tolerance: Scalar
Optional opts: {
capabilities?: string[];
referenceFrame?: RefFrame;
requirement?: string;
}Optional capabilities?: string[]
Optional referenceFrame?: RefFrame
Optional requirement?: string
sweep: ((id, profile, path, result?, deps?, opts?) => Sweep)
- (id, profile, path, result?, deps?, opts?): Sweep
Parameters
- id: string
- profile: ProfileRef
- path: Path3D
Optional result: stringOptional deps: string[]Optional opts: {
frame?: PlaneRef;
mode?: "solid" | "surface";
orientation?: "frenet" | "fixed";
}Optional frame?: PlaneRef
Optional mode?: "solid" | "surface"
Optional orientation?: "frenet" | "fixed"
thicken: ((id, surface, thickness, result?, deps?, opts?) => Thicken)
- (id, surface, thickness, result?, deps?, opts?): Thicken
Parameters
- id: string
- surface: Selector
- thickness: Scalar
Optional result: stringOptional deps: string[]Optional opts: {
direction?: "normal" | "reverse";
}Optional direction?: "normal" | "reverse"
thread: ((id, axis, length, majorDiameter, pitch, result?, deps?, opts?) => Thread)
- (id, axis, length, majorDiameter, pitch, result?, deps?, opts?): Thread
Parameters
- id: string
- axis: AxisSpec
- length: Scalar
- majorDiameter: Scalar
- pitch: Scalar
Optional result: stringOptional deps: string[]Optional opts: {
crestFlat?: Scalar;
handedness?: "right" | "left";
minorDiameter?: Scalar;
origin?: Point3D;
profileAngle?: Scalar;
rootFlat?: Scalar;
segmentsPerTurn?: Scalar;
}Optional crestFlat?: Scalar
Optional handedness?: "right" | "left"
Optional minorDiameter?: Scalar
Optional origin?: Point3D
Optional profileAngle?: Scalar
Optional rootFlat?: Scalar
Optional segmentsPerTurn?: Scalar
transform: ((opts?) => Transform)
trimSurface: ((id, source, tools, result?, deps?, opts?) => TrimSurface)
- (id, source, tools, result?, deps?, opts?): TrimSurface
Parameters
- id: string
- source: Selector
- tools: Selector[]
Optional result: stringOptional deps: string[]Optional opts: {
keep?: "inside" | "outside" | "both";
}Optional keep?: "inside" | "outside" | "both"
unwrap: ((id, source, result?, deps?, opts?) => Unwrap)
- (id, source, result?, deps?, opts?): Unwrap
Parameters
- id: string
- source: Selector
Optional result: stringOptional deps: string[]Optional opts: {
mode?: "strict" | "experimental";
}Optional mode?: "strict" | "experimental"
variableChamfer: ((id, source, entries, result?, deps?) => VariableChamfer)
variableFillet: ((id, source, entries, result?, deps?) => VariableFillet)
withTags: (<T>(feature, tags) => T)
- <T>(feature, tags): T
Returns T
Generate a 2D grid of features (constant Z from origin).