Interface Point3

Point3: a three-dimensional point

interface Point3 {
    x: number;
    y: number;
    z: number;
    back(dy: number): Point3;
    distance(p: Point3): number;
    down(dz: number): Point3;
    forw(dy: number): Point3;
    isEqual(p: Point3, eps?: number): boolean;
    isValid(): boolean;
    left(dx: number): Point3;
    mirrorO(): Point3;
    mirrorX(): Point3;
    mirrorXY(): Point3;
    mirrorXZ(): Point3;
    mirrorY(): Point3;
    mirrorYZ(): Point3;
    mirrorZ(): Point3;
    move(dx: number, dy: number, dz: number): Point3;
    move(v: Vector3 | Point3): Point3;
    moveX(dx: number): Point3;
    moveY(dy: number): Point3;
    moveZ(dz: number): Point3;
    right(dx: number): Point3;
    rotate(angle: number, axis: Vector3): Point3;
    rotate(x: number, y: number, z: number): Point3;
    rotateX(angle: number): Point3;
    rotateY(angle: number): Point3;
    rotateZ(angle: number): Point3;
    scale(factor: number, center?: Point3): Point3;
    toPoint2(): point;
    toString(): string;
    translate(dx: number, dy: number, dz: number): Point3;
    translate(v: Vector3): Point3;
    translateX(dx: number): Point3;
    translateY(dy: number): Point3;
    translateZ(dz: number): Point3;
    up(dz: number): Point3;
}

Index

Properties

x y z

Properties

x

x: number

X coordinate

Access

Read/Write

y

y: number

Y coordinate

Access

Read/Write

z

z: number

Z coordinate

Access

Read/Write

Methods

back

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

distance

distance(p: Point3): number
Calculates the distance to another point
Parameters
- p: Point3
  {Point3} The other point
Returns number
Distance between the points
- Defined in types_MotorXP-AFM.en.d.ts:2961

down

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

forw

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

isEqual

isEqual(p: Point3, eps?: number): boolean
Compares with another point using the specified tolerance
Parameters
- p: Point3
  {Point3} The other point
- Optionaleps: number
  {number} Comparison tolerance [default=1e-6]
Returns boolean
True if the points coincide within eps
- Defined in types_MotorXP-AFM.en.d.ts:2975

isValid

isValid(): boolean
Checks whether the point is valid

Returns boolean
True if the point is valid
- Defined in types_MotorXP-AFM.en.d.ts:2967

left

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

mirrorO

mirrorO(): Point3
Reflects the point about different axes

Returns Point3
- Defined in types_MotorXP-AFM.en.d.ts:3046

mirrorX

mirrorX(): Point3
Returns Point3
- Defined in types_MotorXP-AFM.en.d.ts:3047

mirrorXY

mirrorXY(): Point3
Returns Point3
- Defined in types_MotorXP-AFM.en.d.ts:3050

mirrorXZ

mirrorXZ(): Point3
Returns Point3
- Defined in types_MotorXP-AFM.en.d.ts:3052

mirrorY

mirrorY(): Point3
Returns Point3
- Defined in types_MotorXP-AFM.en.d.ts:3048

mirrorYZ

mirrorYZ(): Point3
Returns Point3
- Defined in types_MotorXP-AFM.en.d.ts:3051

mirrorZ

mirrorZ(): Point3
Returns Point3
- Defined in types_MotorXP-AFM.en.d.ts:3049

move

move(dx: number, dy: number, dz: number): Point3
Aliases for translate
Parameters
- dx: number
- dy: number
- dz: number
Returns Point3
- Defined in types_MotorXP-AFM.en.d.ts:3003
move(v: Vector3 | Point3): Point3
Parameters
- v: Vector3 | Point3
Returns Point3
- Defined in types_MotorXP-AFM.en.d.ts:3004

moveX

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

moveY

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

moveZ

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

right

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

rotate

rotate(angle: number, axis: Vector3): Point3
Rotates the point about an arbitrary vector
Parameters
- angle: number
  {number} Rotation angle in degrees
- axis: Vector3
  {Vector3} Rotation axis vector
Returns Point3
New point after rotation
- Defined in types_MotorXP-AFM.en.d.ts:3025
rotate(x: number, y: number, z: number): Point3
Rotates the point about X, Y, and Z
Parameters
- x: number
  {number} Rotation angle about X
- y: number
  {number} Rotation angle about Y
- z: number
  {number} Rotation angle about Z
Returns Point3
New point after rotation
- Defined in types_MotorXP-AFM.en.d.ts:3034

rotateX

rotateX(angle: number): Point3
Rotation about X
Parameters
- angle: number
Returns Point3
- Defined in types_MotorXP-AFM.en.d.ts:3037

rotateY

rotateY(angle: number): Point3
Rotation about Y
Parameters
- angle: number
Returns Point3
- Defined in types_MotorXP-AFM.en.d.ts:3039

rotateZ

rotateZ(angle: number): Point3
Rotation about Z
Parameters
- angle: number
Returns Point3
- Defined in types_MotorXP-AFM.en.d.ts:3041

scale

scale(factor: number, center?: Point3): Point3
Scales the point
Parameters
- factor: number
  {number} Scale factor
- Optionalcenter: Point3
  {Point3} Scaling center [default=(0,0,0)]
Returns Point3
New point after scaling
- Defined in types_MotorXP-AFM.en.d.ts:3060

toPoint2

toPoint2(): point
Converts a 3D point to 2D

Returns point
2D point with coordinates (x, y)
- Defined in types_MotorXP-AFM.en.d.ts:2948

toString

toString(): string
String representation of the point

Returns string
String in the form "(x, y, z)"
- Defined in types_MotorXP-AFM.en.d.ts:2954

translate

translate(dx: number, dy: number, dz: number): Point3
Translates the point by a vector
Parameters
- dx: number
  {number} Displacement along X
- dy: number
  {number} Displacement along Y
- dz: number
  {number} Displacement along Z
Returns Point3
New point after translation
- Defined in types_MotorXP-AFM.en.d.ts:2984
translate(v: Vector3): Point3
Translates the point by a vector
Parameters
- v: Vector3
  {Vector3} Translation vector
Returns Point3
New point after translation
- Defined in types_MotorXP-AFM.en.d.ts:2991

translateX

translateX(dx: number): Point3
Parameters
- dx: number
Returns Point3
New point after translation along X
- Defined in types_MotorXP-AFM.en.d.ts:2994

translateY

translateY(dy: number): Point3
Parameters
- dy: number
Returns Point3
New point after translation along Y
- Defined in types_MotorXP-AFM.en.d.ts:2996

translateZ

translateZ(dz: number): Point3
Parameters
- dz: number
Returns Point3
New point after translation along Z
- Defined in types_MotorXP-AFM.en.d.ts:2998

up

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