Interface Shape

Shape type

interface Shape {
    area(): number;
    back(dy: number): Shape;
    center(): Point3;
    diff(other: Shape): Shape;
    diff(other: Shape): Shape;
    difference(other: Shape): Shape;
    difference(other: Shape): Shape;
    distance(other: Shape): number;
    down(dz: number): Shape;
    edges(): Shape[];
    edges(): Shape[];
    extrema(other: Shape): Shape;
    extrude(z: number): Shape;
    extrude(x: number, y: number, z: number): Shape;
    extrude(V: Vector3): Shape;
    extrudeX(x: number): Shape;
    extrudeY(y: number): Shape;
    extrudeZ(z: number): Shape;
    fill(): Shape;
    firstParameter(): number;
    firstPoint(): Point3;
    forw(dy: number): Shape;
    interpolate(countPoint: number): Point3[];
    intersect(other: Shape): Shape;
    isEmpty(): boolean;
    lastParameter(): number;
    lastPoint(): Point3;
    left(dx: number): Shape;
    length(): number;
    length(): number;
    mirrorO(): Shape;
    mirrorX(): Shape;
    mirrorXY(): Shape;
    mirrorXZ(): Shape;
    mirrorY(): Shape;
    mirrorYZ(): Shape;
    mirrorZ(): Shape;
    move(dx: number, dy: number, dz: number): Shape;
    move(v: Vector3 | Point3): Shape;
    moveX(dx: number): Shape;
    moveY(dy: number): Shape;
    moveZ(dz: number): Shape;
    nearEdge(pt: Point3): Shape;
    nearFace(pt: Point3): Shape;
    nearVertex(pt: Point3): Shape;
    pointAt(parameter: number): Point3;
    points(all?: boolean): Point3[];
    right(dx: number): Shape;
    rotate(angle: number, axis: Vector3): Shape;
    rotate(x: number, y: number, z: number): Shape;
    rotateX(angle: number, center?: Point3): Shape;
    rotateY(angle: number, center?: Point3): Shape;
    rotateZ(angle: number, center?: Point3): Shape;
    scale(factor: number, center: Point3): Shape;
    toFileSTEP(path: string): boolean;
    translate(dx: number, dy: number, dz: number): Shape;
    translate(v: Vector3): Shape;
    translateX(dx: number): Shape;
    translateY(dy: number): Shape;
    translateZ(dz: number): Shape;
    unify(): Shape;
    unite(other: Shape): Shape;
    up(dz: number): Shape;
    vertices(all?: boolean): Point3[];
    volume(): number;
    wire(): Shape;
}

Methods

area

area(): number
Returns the shape area.

Returns number
Surface area of the shape.
- Defined in types_MotorXP-AFM.en.d.ts:3567

back

back(dy: number): Shape
Parameters
- dy: number
Returns Shape
- Defined in types_MotorXP-AFM.en.d.ts:3742

center

center(): Point3
Returns the geometric center of the shape.

Returns Point3
Shape center in 3D coordinates.
- Defined in types_MotorXP-AFM.en.d.ts:3573

diff

diff(other: Shape): Shape
Subtracts another shape from this one.
Parameters
- other: Shape
  {Shape} Shape to subtract.
Returns Shape
Shape resulting from the difference.
- Defined in types_MotorXP-AFM.en.d.ts:3580
diff(other: Shape): Shape
Alias for difference.
Parameters
- other: Shape
  {Shape} The other shape.
Returns Shape
New shape after subtraction.
- Defined in types_MotorXP-AFM.en.d.ts:3868

difference

difference(other: Shape): Shape
Alias for diff: difference of shapes.
Parameters
- other: Shape
  {Shape} Shape to subtract.
Returns Shape
Resulting shape.
- Defined in types_MotorXP-AFM.en.d.ts:3587
difference(other: Shape): Shape
Subtracts another shape from this one.
Parameters
- other: Shape
  {Shape} The other shape.
Returns Shape
New shape after subtraction.
- Defined in types_MotorXP-AFM.en.d.ts:3861

distance

distance(other: Shape): number
Calculates the distance to another shape.
Parameters
- other: Shape
  {Shape} Shape to measure the distance to.
Returns number
Minimum distance between shapes.
- Defined in types_MotorXP-AFM.en.d.ts:3594

down

down(dz: number): Shape
Parameters
- dz: number
Returns Shape
- Defined in types_MotorXP-AFM.en.d.ts:3740

edges

edges(): Shape[]
Returns the edges of the current geometric shape.

Returns Shape[]
Array of Shape objects representing the edges.
- Defined in types_MotorXP-AFM.en.d.ts:3600
edges(): Shape[]
Returns the edges of the shape.

Returns Shape[]
Array of Shape objects representing edges.
- Defined in types_MotorXP-AFM.en.d.ts:3898

extrema

extrema(other: Shape): Shape
Returns the extreme points of the shape.
Parameters
- other: Shape
  {Shape} Shape for calculating extrema.
Returns Shape
Shape containing the extreme points.
- Defined in types_MotorXP-AFM.en.d.ts:3607

extrude

extrude(z: number): Shape
Extrudes the shape along Z.
Parameters
- z: number
  {number} Extrusion distance along Z.
Returns Shape
Extrusion result.
- Defined in types_MotorXP-AFM.en.d.ts:3614
extrude(x: number, y: number, z: number): Shape
Extrudes the shape.
Parameters
- x: number
  {number} Extrusion distance along X.
- y: number
  {number} Extrusion distance along Y.
- z: number
  {number} Extrusion distance along Z.
Returns Shape
Extrusion result.
- Defined in types_MotorXP-AFM.en.d.ts:3623
extrude(V: Vector3): Shape
Extrudes the shape.
Parameters
- V: Vector3
  {Vector3} Extrusion vector.
Returns Shape
Extrusion result.
- Defined in types_MotorXP-AFM.en.d.ts:3630

extrudeX

extrudeX(x: number): Shape
Extrudes along X.
Parameters
- x: number
  {number} Distance along X.
Returns Shape
Resulting shape.
- Defined in types_MotorXP-AFM.en.d.ts:3637

extrudeY

extrudeY(y: number): Shape
Extrudes along Y.
Parameters
- y: number
  {number} Distance along Y.
Returns Shape
Resulting shape.
- Defined in types_MotorXP-AFM.en.d.ts:3644

extrudeZ

extrudeZ(z: number): Shape
Extrudes along Z.
Parameters
- z: number
  {number} Distance along Z.
Returns Shape
Resulting shape.
- Defined in types_MotorXP-AFM.en.d.ts:3651

fill

fill(): Shape
Fills the shape by creating a surface or solid from its boundary.

Returns Shape
Resulting shape.
- Defined in types_MotorXP-AFM.en.d.ts:3657

firstParameter

firstParameter(): number
Returns the first curve parameter.

Returns number
First parameter.
- Defined in types_MotorXP-AFM.en.d.ts:3923

firstPoint

firstPoint(): Point3
Returns the first point on the curve.

Returns Point3
First point on the curve.
- Defined in types_MotorXP-AFM.en.d.ts:3929

forw

forw(dy: number): Shape
Parameters
- dy: number
Returns Shape
- Defined in types_MotorXP-AFM.en.d.ts:3741

interpolate

interpolate(countPoint: number): Point3[]
Interpolates points along the curve, returning the specified number of points.
Parameters
- countPoint: number
  {number} Number of interpolation points. If 0, the optimal number is determined automatically.
Returns Point3[]
Array of interpolated points.
- Defined in types_MotorXP-AFM.en.d.ts:3949

intersect

intersect(other: Shape): Shape
Intersects with another shape.
Parameters
- other: Shape
  {Shape} The other shape.
Returns Shape
Intersection result.
- Defined in types_MotorXP-AFM.en.d.ts:3664

isEmpty

isEmpty(): boolean
Checks whether the shape is empty.

Returns boolean
True if the shape is empty.
- Defined in types_MotorXP-AFM.en.d.ts:3670

lastParameter

lastParameter(): number
Returns the last parameter of the curve or wire.

Returns number
Last parameter.
- Defined in types_MotorXP-AFM.en.d.ts:3676

lastPoint

lastPoint(): Point3
Returns the last point on the curve.

Returns Point3
Last point on the curve.
- Defined in types_MotorXP-AFM.en.d.ts:3935

left

left(dx: number): Shape
Parameters
- dx: number
Returns Shape
- Defined in types_MotorXP-AFM.en.d.ts:3744

length

length(): number
Returns the curve length or shape perimeter.

Returns number
Length.
- Defined in types_MotorXP-AFM.en.d.ts:3682
length(): number
Returns the length of the shape.

Returns number
Shape length.
- Defined in types_MotorXP-AFM.en.d.ts:3911

mirrorO

mirrorO(): Shape
Reflects about the origin.

Returns Shape
Reflected shape.
- Defined in types_MotorXP-AFM.en.d.ts:3754

mirrorX

mirrorX(): Shape
Reflects about the X axis.

Returns Shape
Reflected shape.
- Defined in types_MotorXP-AFM.en.d.ts:3760

mirrorXY

mirrorXY(): Shape
Reflects about the XY plane.

Returns Shape
Reflected shape.
- Defined in types_MotorXP-AFM.en.d.ts:3778

mirrorXZ

mirrorXZ(): Shape
Reflects about the XZ plane.

Returns Shape
Reflected shape.
- Defined in types_MotorXP-AFM.en.d.ts:3790

mirrorY

mirrorY(): Shape
Reflects about the Y axis.

Returns Shape
Reflected shape.
- Defined in types_MotorXP-AFM.en.d.ts:3766

mirrorYZ

mirrorYZ(): Shape
Reflects about the YZ plane.

Returns Shape
Reflected shape.
- Defined in types_MotorXP-AFM.en.d.ts:3784

mirrorZ

mirrorZ(): Shape
Reflects about the Z axis.

Returns Shape
Reflected shape.
- Defined in types_MotorXP-AFM.en.d.ts:3772

move

move(dx: number, dy: number, dz: number): Shape
Convenience aliases for translate (move).
Parameters
- dx: number
- dy: number
- dz: number
Returns Shape
- Defined in types_MotorXP-AFM.en.d.ts:3730
move(v: Vector3 | Point3): Shape
Parameters
- v: Vector3 | Point3
Returns Shape
- Defined in types_MotorXP-AFM.en.d.ts:3731

moveX

moveX(dx: number): Shape
Parameters
- dx: number
Returns Shape
- Defined in types_MotorXP-AFM.en.d.ts:3732

moveY

moveY(dy: number): Shape
Parameters
- dy: number
Returns Shape
- Defined in types_MotorXP-AFM.en.d.ts:3733

moveZ

moveZ(dz: number): Shape
Parameters
- dz: number
Returns Shape
- Defined in types_MotorXP-AFM.en.d.ts:3734

nearEdge

nearEdge(pt: Point3): Shape
Finds the edge nearest to a given point.
Parameters
- pt: Point3
  {Point3} Point used to find the nearest edge.
Returns Shape
Shape representing the nearest edge.
- Defined in types_MotorXP-AFM.en.d.ts:3963

nearFace

nearFace(pt: Point3): Shape
Finds the face nearest to a given point.
Parameters
- pt: Point3
  {Point3} Point used to find the nearest face.
Returns Shape
Shape representing the nearest face.
- Defined in types_MotorXP-AFM.en.d.ts:3956

nearVertex

nearVertex(pt: Point3): Shape
Finds the vertex nearest to a given point.
Parameters
- pt: Point3
  {Point3} Point used to find the nearest vertex.
Returns Shape
Shape representing the nearest vertex.
- Defined in types_MotorXP-AFM.en.d.ts:3970

pointAt

pointAt(parameter: number): Point3
Returns the point on the curve at a given parameter.
Parameters
- parameter: number
  {number} Parameter at which to find the point.
Returns Point3
Point on the curve.
- Defined in types_MotorXP-AFM.en.d.ts:3942

points

points(all?: boolean): Point3[]
Returns the points (vertices) of the shape; same as vertices().
Parameters
- Optionalall: boolean
  {boolean} If true, returns all points; otherwise only unique points [default=false].
Returns Point3[]
Array of points.
- Defined in types_MotorXP-AFM.en.d.ts:3892

right

right(dx: number): Shape
Parameters
- dx: number
Returns Shape
- Defined in types_MotorXP-AFM.en.d.ts:3743

rotate

rotate(angle: number, axis: Vector3): Shape
Rotates about an arbitrary vector.
Parameters
- angle: number
  {number} Rotation angle in degrees.
- axis: Vector3
  {Vector3} Rotation axis vector.
Returns Shape
New shape after rotation.
- Defined in types_MotorXP-AFM.en.d.ts:3802
rotate(x: number, y: number, z: number): Shape
Rotates about X, Y, and Z.
Parameters
- x: number
  {number} Angle about X in degrees.
- y: number
  {number} Angle about Y in degrees.
- z: number
  {number} Angle about Z in degrees.
Returns Shape
New shape after rotation.
- Defined in types_MotorXP-AFM.en.d.ts:3811

rotateX

rotateX(angle: number, center?: Point3): Shape
Rotates about X.
Parameters
- angle: number
  {number} Angle in degrees.
- Optionalcenter: Point3
  {Point3} Rotation center [default=(0,0,0)].
Returns Shape
New shape after rotation.
- Defined in types_MotorXP-AFM.en.d.ts:3819

rotateY

rotateY(angle: number, center?: Point3): Shape
Rotates about Y.
Parameters
- angle: number
  {number} Angle in degrees.
- Optionalcenter: Point3
  {Point3} Rotation center [default=(0,0,0)].
Returns Shape
New shape after rotation.
- Defined in types_MotorXP-AFM.en.d.ts:3827

rotateZ

rotateZ(angle: number, center?: Point3): Shape
Rotates about Z.
Parameters
- angle: number
  {number} Angle in degrees.
- Optionalcenter: Point3
  {Point3} Rotation center [default=(0,0,0)].
Returns Shape
New shape after rotation.
- Defined in types_MotorXP-AFM.en.d.ts:3835

scale

scale(factor: number, center: Point3): Shape
Scales the shape about a center.
Parameters
- factor: number
  {number} Scale factor.
- center: Point3
  {Point3} Scaling center.
Returns Shape
New shape after scaling.
- Defined in types_MotorXP-AFM.en.d.ts:3847

toFileSTEP

toFileSTEP(path: string): boolean
Saves the shape to a STEP file.
Parameters
- path: string
  {string} File path.
Returns boolean
True if the file was written.
- Defined in types_MotorXP-AFM.en.d.ts:3885

translate

translate(dx: number, dy: number, dz: number): Shape
Translates the shape by the specified X, Y, and Z displacements.
Parameters
- dx: number
  {number} Displacement along X.
- dy: number
  {number} Displacement along Y.
- dz: number
  {number} Displacement along Z.
Returns Shape
New shape after translation.
- Defined in types_MotorXP-AFM.en.d.ts:3697
translate(v: Vector3): Shape
Translates the shape by a vector.
Parameters
- v: Vector3
  {Vector3} Translation vector.
Returns Shape
New shape after translation.
- Defined in types_MotorXP-AFM.en.d.ts:3704

translateX

translateX(dx: number): Shape
Translates the shape along X only.
Parameters
- dx: number
  {number} Displacement along X.
Returns Shape
New shape.
- Defined in types_MotorXP-AFM.en.d.ts:3711

translateY

translateY(dy: number): Shape
Translates the shape along Y only.
Parameters
- dy: number
  {number} Displacement along Y.
Returns Shape
New shape.
- Defined in types_MotorXP-AFM.en.d.ts:3718

translateZ

translateZ(dz: number): Shape
Translates the shape along Z only.
Parameters
- dz: number
  {number} Displacement along Z.
Returns Shape
New shape.
- Defined in types_MotorXP-AFM.en.d.ts:3725

unify

unify(): Shape
Combines all separate parts of the shape into a single whole.

Returns Shape
New combined shape.
- Defined in types_MotorXP-AFM.en.d.ts:3874

unite

unite(other: Shape): Shape
Unites the current shape with another shape.
Parameters
- other: Shape
  {Shape} The other shape.
Returns Shape
New shape after union.
- Defined in types_MotorXP-AFM.en.d.ts:3854

up

up(dz: number): Shape
Shorthand translation methods.
Parameters
- dz: number
Returns Shape
- Defined in types_MotorXP-AFM.en.d.ts:3739

vertices

vertices(all?: boolean): Point3[]
Returns the vertices of the shape.
Parameters
- Optionalall: boolean
  {boolean} If true, returns all points; otherwise only unique points [default=false].
Returns Point3[]
Array of points.
- Defined in types_MotorXP-AFM.en.d.ts:3905

volume

volume(): number
Returns the shape volume.

Returns number
Shape volume.
- Defined in types_MotorXP-AFM.en.d.ts:3688

wire

wire(): Shape
Converts the shape to its wireframe.

Returns Shape
Shape wireframe.
- Defined in types_MotorXP-AFM.en.d.ts:3917

Interface Shape

Index

Methods

Methods

area

Returns number

back

Parameters

Returns Shape

center

Returns Point3

diff

Parameters

Returns Shape

Parameters

Returns Shape

difference

Parameters

Returns Shape

Parameters

Returns Shape

distance

Parameters

Returns number

down

Parameters

Returns Shape

edges

Returns Shape[]

Returns Shape[]

extrema

Parameters

Returns Shape

extrude

Parameters

Returns Shape

Parameters

Returns Shape

Parameters

Returns Shape

extrudeX

Parameters

Returns Shape

extrudeY

Parameters

Returns Shape

extrudeZ

Parameters

Returns Shape

fill

Returns Shape

firstParameter

Returns number

firstPoint

Returns Point3

forw

Parameters

Returns Shape

interpolate

Parameters

Returns Point3[]

intersect

Parameters

Returns Shape

isEmpty

Returns boolean

lastParameter

Returns number

lastPoint

Returns Point3

left

Parameters

Returns Shape

length

Returns number

Returns number

mirrorO

Returns Shape

mirrorX

Returns Shape