Logo Euclid

AutoOpenPnt Module

When Euclid is opened this module will be auto-opened. It only contains extension members for type Pnt.

Type extensions

Type extension Description

this.AsPt

Full Usage: this.AsPt

Parameters:
    () : unit

Returns: Pt
Modifiers: inline

Returns the 3D point as 2D point.

Extended Type: Pnt

() : unit
Returns: Pt

this.AsVc

Full Usage: this.AsVc

Parameters:
    () : unit

Returns: Vc
Modifiers: inline

Returns the 3D point as 2D vector, discarding the Z value.

Extended Type: Pnt

() : unit
Returns: Vc

this.AsVec

Full Usage: this.AsVec

Parameters:
    () : unit

Returns: Vec
Modifiers: inline

Returns the 3D point as 3D vector.

Extended Type: Pnt

() : unit
Returns: Vec

this.ClosestPointOnLine

Full Usage: this.ClosestPointOnLine

Parameters:
Returns: Pnt
Modifiers: inline

Returns the closest point on a finite line segment to test point. The line segment is given as a Line3D `ln`. Fails if the line is degenerate (zero-length).

Extended Type: Pnt

ln : Line3D
Returns: Pnt

this.Direction2PiInXYTo

Full Usage: this.Direction2PiInXYTo

Parameters:
Returns: float
Modifiers: inline

Returns the angle in radians from this point to another point projected in X-Y plane. 0.0 = XAxis, going counter-clockwise till two Pi. The static counterpart is Pnt.direction2PiInXYFromTo.

Extended Type: Pnt

o : Pnt
Returns: float

this.Direction360InXYTo

Full Usage: this.Direction360InXYTo

Parameters:
Returns: float
Modifiers: inline

Returns the angle in degrees from this point to another point projected in X-Y plane. 0.0 = XAxis, going counter-clockwise till 360. The static counterpart is Pnt.direction360InXYFromTo.

Extended Type: Pnt

o : Pnt
Returns: float

this.DirectionDiamondInXYTo

Full Usage: this.DirectionDiamondInXYTo

Parameters:
Returns: float
Modifiers: inline

Returns the Diamond Angle from this point to another point projected in X-Y plane. The diamond angle is always positive and in the range of 0.0 to 4.0 (for 360 degrees) 0.0 = XAxis, going counter-clockwise. Ignoring Z component. This is the fastest angle computation since it does not use Math.Cos or Math.Sin. It is useful for radial sorting. The static counterpart is Pnt.directionDiamondInXYFromTo.

Extended Type: Pnt

o : Pnt
Returns: float

this.DistanceFromOrigin

Full Usage: this.DistanceFromOrigin

Parameters:
    () : unit

Returns: float
Modifiers: inline

Returns the distance from Origin (0, 0, 0)

Extended Type: Pnt

() : unit
Returns: float

this.DistanceFromOriginSq

Full Usage: this.DistanceFromOriginSq

Parameters:
    () : unit

Returns: float
Modifiers: inline

Returns the squared distance from Origin (0, 0, 0)

Extended Type: Pnt

() : unit
Returns: float

this.DistanceInXYFromOrigin

Full Usage: this.DistanceInXYFromOrigin

Parameters:
    () : unit

Returns: float
Modifiers: inline

Returns the projected distance from Origin (0, 0, 0). Ignoring the Z component.

Extended Type: Pnt

() : unit
Returns: float

this.DistanceInXYFromOriginSq

Full Usage: this.DistanceInXYFromOriginSq

Parameters:
    () : unit

Returns: float
Modifiers: inline

Returns the projected squared distance from Origin (0, 0, 0). Ignoring the Z component.

Extended Type: Pnt

() : unit
Returns: float

this.DistanceTo

Full Usage: this.DistanceTo

Parameters:
Returns: float
Modifiers: inline

Returns the distance between two 3D points. The static counterpart is Pnt.distance.

Extended Type: Pnt

b : Pnt
Returns: float

this.DistanceToLine

Full Usage: this.DistanceToLine

Parameters:
Returns: float
Modifiers: inline

Returns the distance between point and finite line segment. The line segment is given as a Line3D `ln`.

Extended Type: Pnt

ln : Line3D
Returns: float

this.DistanceToLineSq

Full Usage: this.DistanceToLineSq

Parameters:
Returns: float
Modifiers: inline

Returns the squared distance between point and finite line segment. The line segment is given as a Line3D `ln`.

Extended Type: Pnt

ln : Line3D
Returns: float

this.DistanceToSq

Full Usage: this.DistanceToSq

Parameters:
Returns: float
Modifiers: inline

Returns the squared distance between two 3D points. This operation is slightly faster than the distance function, and sufficient for many algorithms like finding closest points. The static counterpart is Pnt.distanceSq.

Extended Type: Pnt

b : Pnt
Returns: float

this.DistanceToXYZ

Full Usage: this.DistanceToXYZ

Parameters:
    x : float
    y : float
    z : float

Returns: float
Modifiers: inline

Returns the distance between a 3D point and given x, y, z coordinates.

Extended Type: Pnt

x : float
y : float
z : float
Returns: float

this.DistanceToXYZSq

Full Usage: this.DistanceToXYZSq

Parameters:
    x : float
    y : float
    z : float

Returns: float
Modifiers: inline

Returns the squared distance between a 3D point and given x, y, z coordinates.

Extended Type: Pnt

x : float
y : float
z : float
Returns: float

this.IsAlmostOrigin

Full Usage: this.IsAlmostOrigin

Parameters:
    tol : float

Returns: bool
Modifiers: inline

Returns a boolean indicating whether the absolute value of X, Y and Z is each less than the given tolerance.

Extended Type: Pnt

tol : float
Returns: bool

this.IsInvalid

Full Usage: this.IsInvalid

Parameters:
    () : unit

Returns: bool
Modifiers: inline

Returns a boolean indicating whether X, Y or Z is NaN or Infinity.

Extended Type: Pnt

() : unit
Returns: bool

this.IsNotOrigin

Full Usage: this.IsNotOrigin

Parameters:
    () : unit

Returns: bool
Modifiers: inline

Returns a boolean indicating if any of X, Y and Z is not exactly 0.0.

Extended Type: Pnt

() : unit
Returns: bool

this.IsOrigin

Full Usage: this.IsOrigin

Parameters:
    () : unit

Returns: bool
Modifiers: inline

Returns a boolean indicating whether X, Y and Z are exactly 0.0.

Extended Type: Pnt

() : unit
Returns: bool

this.IsValid

Full Usage: this.IsValid

Parameters:
    () : unit

Returns: bool
Modifiers: inline

Returns a boolean indicating whether X, Y and Z are valid (not NaN or Infinity).

Extended Type: Pnt

() : unit
Returns: bool

this.Rotate

Full Usage: this.Rotate

Parameters:
Returns: Pnt The rotated 3D point.
Modifiers: inline

Rotate the 3D point by a Quaternion around the World Origin.

Extended Type: Pnt

q : Quaternion

The rotation to apply.

Returns: Pnt

The rotated 3D point.

this.Rotate2Dby90CCW

Full Usage: this.Rotate2Dby90CCW

Parameters:
    () : unit

Returns: Pnt
Modifiers: inline

90-degree rotation counter-clockwise around the Z-axis through the World Origin.

Extended Type: Pnt

() : unit
Returns: Pnt

this.Rotate2Dby90CW

Full Usage: this.Rotate2Dby90CW

Parameters:
    () : unit

Returns: Pnt
Modifiers: inline

90-degree rotation clockwise around the Z-axis through the World Origin.

Extended Type: Pnt

() : unit
Returns: Pnt

this.RotateAround

Full Usage: this.RotateAround

Parameters:
    cen : Pnt - The center point of the rotation.
    q : Quaternion - The rotation to apply.

Returns: Pnt The rotated 3D point.
Modifiers: inline

Rotate the 3D point by a Quaternion around a given center point.

Extended Type: Pnt

cen : Pnt

The center point of the rotation.

q : Quaternion

The rotation to apply.

Returns: Pnt

The rotated 3D point.

this.RotateByQuarterCircle

Full Usage: this.RotateByQuarterCircle

Parameters:
    numberOfQuarters : int

Returns: Pnt
Modifiers: inline

Rotates the 3D point around the Z-axis through the World Origin by a given number of quarter-circles (i.e. multiples of 90 degrees or Pi/2 radians). A positive number rotates counter-clockwise, a negative number rotates clockwise. The Z coordinate is preserved.

Extended Type: Pnt

numberOfQuarters : int
Returns: Pnt

this.Transform

Full Usage: this.Transform

Parameters:
Returns: Pnt
Modifiers: inline

Multiplies (or applies) a Matrix to a 3D point (with an implicit 1 in the 4th dimension, so that it also works correctly for projections.)

Extended Type: Pnt

m : Matrix
Returns: Pnt

this.TransformRigid

Full Usage: this.TransformRigid

Parameters:
Returns: Pnt
Modifiers: inline

Multiplies (or applies) a RigidMatrix to a 3D point.

Extended Type: Pnt

m : RigidMatrix
Returns: Pnt

this.TransformRigidRotateOnly

Full Usage: this.TransformRigidRotateOnly

Parameters:
Returns: Pnt
Modifiers: inline

Multiplies (or applies) only the 3x3 rotation part of a RigidMatrix to a 3D point.

Extended Type: Pnt

m : RigidMatrix
Returns: Pnt

this.WithDistanceFromOrigin

Full Usage: this.WithDistanceFromOrigin

Parameters:
    l : float

Returns: Pnt
Modifiers: inline

Returns new 3D point with given distance from Origin by scaling it up or down.

Extended Type: Pnt

l : float
Returns: Pnt

this.WithX

Full Usage: this.WithX

Parameters:
    x : float

Returns: Pnt
Modifiers: inline

Returns new 3D point with new X coordinate, Y and Z stay the same.

Extended Type: Pnt

x : float
Returns: Pnt

this.WithY

Full Usage: this.WithY

Parameters:
    y : float

Returns: Pnt
Modifiers: inline

Returns a new 3D point with new Y coordinate, X and Z stay the same.

Extended Type: Pnt

y : float
Returns: Pnt

this.WithZ

Full Usage: this.WithZ

Parameters:
    z : float

Returns: Pnt
Modifiers: inline

Returns a new 3D point with new Z coordinate, X and Y stay the same.

Extended Type: Pnt

z : float
Returns: Pnt

Pnt.add a b

Full Usage: Pnt.add a b

Parameters:
Returns: Pnt
Modifiers: inline

Adds two 3D points and return new 3D point.

Extended Type: Pnt

a : Pnt
b : Pnt
Returns: Pnt

Pnt.angle180Pnts pntPrev pntThis pntNext

Full Usage: Pnt.angle180Pnts pntPrev pntThis pntNext

Parameters:
Returns: float
Modifiers: inline

Returns angle between three 3D Points in degrees. Range 0.0 to 180

Extended Type: Pnt

pntPrev : Pnt
pntThis : Pnt
pntNext : Pnt
Returns: float

Pnt.anglePiPnts pntPrev pntThis pntNext

Full Usage: Pnt.anglePiPnts pntPrev pntThis pntNext

Parameters:
Returns: float
Modifiers: inline

Returns angle between three 3D Points in radians. Range 0.0 to Pi.

Extended Type: Pnt

pntPrev : Pnt
pntThis : Pnt
pntNext : Pnt
Returns: float

Pnt.asPt pnt

Full Usage: Pnt.asPt pnt

Parameters:
Returns: Pt
Modifiers: inline

Returns the 3D point as 2D point.

Extended Type: Pnt

pnt : Pnt
Returns: Pt

Pnt.asVc pnt

Full Usage: Pnt.asVc pnt

Parameters:
Returns: Vc
Modifiers: inline

Returns the 3D point as 2D vector, discarding the Z value.

Extended Type: Pnt

pnt : Pnt
Returns: Vc

Pnt.asVec pnt

Full Usage: Pnt.asVec pnt

Parameters:
Returns: Vec
Modifiers: inline

Returns the 3D point as 3D vector.

Extended Type: Pnt

pnt : Pnt
Returns: Vec

Pnt.bisector pntPrev pntThis pntNext

Full Usage: Pnt.bisector pntPrev pntThis pntNext

Parameters:
Returns: Vec
Modifiers: inline

Returns a (not unitized) bisector vector in the middle direction from pntThis. Code : (pntPrev-pntThis).Unitized + (pntNext-pntThis).Unitized pntPrev * pntThis * pntNext -> bisector vector

Extended Type: Pnt

pntPrev : Pnt
pntThis : Pnt
pntNext : Pnt
Returns: Vec

Pnt.closestOfTwo pnt1 pnt2 referencePoint

Full Usage: Pnt.closestOfTwo pnt1 pnt2 referencePoint

Parameters:
Returns: Pnt

Returns the closer point of the two points to the reference given point. When both points are equally close, the first point is returned.

Extended Type: Pnt

pnt1 : Pnt
pnt2 : Pnt
referencePoint : Pnt
Returns: Pnt

Pnt.closestPointOnLine ln testPnt

Full Usage: Pnt.closestPointOnLine ln testPnt

Parameters:
Returns: Pnt
Modifiers: inline

Returns the closest point on a finite line segment to test point. The line segment is given as a Line3D `ln`. Fails if the line is degenerate (zero-length).

Extended Type: Pnt

ln : Line3D
testPnt : Pnt
Returns: Pnt

Pnt.create x y z

Full Usage: Pnt.create x y z

Parameters:
    x : float
    y : float
    z : float

Returns: Pnt
Modifiers: inline

Create 3D point from X, Y and Z components.

Extended Type: Pnt

x : float
y : float
z : float
Returns: Pnt

Pnt.createFromMembersXYZ pt

Full Usage: Pnt.createFromMembersXYZ pt

Parameters:
    pt : ^T

Returns: Pnt
Modifiers: inline
Type parameters: ^T, ^a, ^b, ^c (requires (member get_X : ^T -> ^a) and (member get_Y : ^T -> ^b) and (member get_Z : ^T -> ^c) and (static member op_Explicit : ^a -> Microsoft.FSharp.Core.float) and (static member op_Explicit : ^b -> Microsoft.FSharp.Core.float) and (static member op_Explicit : ^c -> Microsoft.FSharp.Core.float))

Accepts any type that has an X, Y and Z (UPPERCASE) member that can be converted to a float. Internally this is not using reflection at runtime but F# Statically Resolved Type Parameters at compile time.

Extended Type: Pnt

pt : ^T
Returns: Pnt

Pnt.createFromMembersxyz pt

Full Usage: Pnt.createFromMembersxyz pt

Parameters:
    pt : ^T

Returns: Pnt
Modifiers: inline
Type parameters: ^T, ^a, ^b, ^c (requires (member get_x : ^T -> ^a) and (member get_y : ^T -> ^b) and (member get_z : ^T -> ^c) and (static member op_Explicit : ^a -> Microsoft.FSharp.Core.float) and (static member op_Explicit : ^b -> Microsoft.FSharp.Core.float) and (static member op_Explicit : ^c -> Microsoft.FSharp.Core.float))

Accepts any type that has a x, y and z (lowercase) member that can be converted to a float. Internally this is not using reflection at runtime but F# Statically Resolved Type Parameters at compile time.

Extended Type: Pnt

pt : ^T
Returns: Pnt

Pnt.createFromPt p

Full Usage: Pnt.createFromPt p

Parameters:
Returns: Pnt
Modifiers: inline

Create 3D point from 2D point. Using 0.0 for Z

Extended Type: Pnt

p : Pt
Returns: Pnt

Pnt.createFromPtWithZ z p

Full Usage: Pnt.createFromPtWithZ z p

Parameters:
    z : float
    p : Pt

Returns: Pnt
Modifiers: inline

Returns a 3D point from Z level and 2D point.

Extended Type: Pnt

z : float
p : Pt
Returns: Pnt

Pnt.createFromUnitVec v

Full Usage: Pnt.createFromUnitVec v

Parameters:
Returns: Pnt
Modifiers: inline

Create 3D point from 3D unit-vector.

Extended Type: Pnt

v : UnitVec
Returns: Pnt

Pnt.createFromVec v

Full Usage: Pnt.createFromVec v

Parameters:
Returns: Pnt
Modifiers: inline

Create 3D point from 3D vector.

Extended Type: Pnt

v : Vec
Returns: Pnt

Pnt.direction2PiInXYFromTo fromPnt toPnt

Full Usage: Pnt.direction2PiInXYFromTo fromPnt toPnt

Parameters:
Returns: float
Modifiers: inline

Returns the angle in radians from 'fromPnt' to 'toPnt' projected in X-Y plane. 0.0 = XAxis, going counter-clockwise till two Pi. The instance counterpart is Pnt.Direction2PiInXYTo.

Extended Type: Pnt

fromPnt : Pnt
toPnt : Pnt
Returns: float

Pnt.direction360InXYFromTo fromPnt toPnt

Full Usage: Pnt.direction360InXYFromTo fromPnt toPnt

Parameters:
Returns: float
Modifiers: inline

Returns the angle in degrees from 'fromPnt' to 'toPnt' projected in X-Y plane. 0.0 = XAxis, going counter-clockwise till 360. The instance counterpart is Pnt.Direction360InXYTo.

Extended Type: Pnt

fromPnt : Pnt
toPnt : Pnt
Returns: float

Pnt.directionDiamondInXYFromTo fromPnt toPnt

Full Usage: Pnt.directionDiamondInXYFromTo fromPnt toPnt

Parameters:
Returns: float
Modifiers: inline

Returns the Diamond Angle from 'fromPnt' to 'toPnt' projected in X-Y plane. The diamond angle is always positive and in the range of 0.0 to 4.0 (for 360 degrees) 0.0 = XAxis, going counter-clockwise. Ignoring Z component. This is the fastest angle computation since it does not use Math.Cos or Math.Sin. It is useful for radial sorting. The instance counterpart is Pnt.DirectionDiamondInXYTo.

Extended Type: Pnt

fromPnt : Pnt
toPnt : Pnt
Returns: float

Pnt.distance a b

Full Usage: Pnt.distance a b

Parameters:
Returns: float
Modifiers: inline

Returns the distance between two 3D points. The instance counterpart is Pnt.DistanceTo.

Extended Type: Pnt

a : Pnt
b : Pnt
Returns: float

Pnt.distanceFromOrigin pnt

Full Usage: Pnt.distanceFromOrigin pnt

Parameters:
Returns: float
Modifiers: inline

Returns the distance from Origin (0, 0, 0)

Extended Type: Pnt

pnt : Pnt
Returns: float

Pnt.distanceFromOriginSq pnt

Full Usage: Pnt.distanceFromOriginSq pnt

Parameters:
Returns: float
Modifiers: inline

Returns the squared distance from Origin (0, 0, 0)

Extended Type: Pnt

pnt : Pnt
Returns: float

Pnt.distanceInXY a b

Full Usage: Pnt.distanceInXY a b

Parameters:
Returns: float
Modifiers: inline

Returns the horizontal distance between two 3D points(ignoring their Z Value)

Extended Type: Pnt

a : Pnt
b : Pnt
Returns: float

Pnt.distanceInXYFromOrigin pnt

Full Usage: Pnt.distanceInXYFromOrigin pnt

Parameters:
Returns: float
Modifiers: inline

Returns the projected distance from Origin (0, 0, 0). Ignoring the Z component.

Extended Type: Pnt

pnt : Pnt
Returns: float

Pnt.distanceInXYFromOriginSq pnt

Full Usage: Pnt.distanceInXYFromOriginSq pnt

Parameters:
Returns: float
Modifiers: inline

Same as pnt.DistanceInXYFromOriginSq.

Extended Type: Pnt

pnt : Pnt
Returns: float

Pnt.distanceSq a b

Full Usage: Pnt.distanceSq a b

Parameters:
Returns: float
Modifiers: inline

Returns the squared distance between two 3D points. This operation is slightly faster than the distance function, and sufficient for many algorithms like finding closest points. The instance counterpart is Pnt.DistanceToSq.

Extended Type: Pnt

a : Pnt
b : Pnt
Returns: float

Pnt.distanceToLine ln testPnt

Full Usage: Pnt.distanceToLine ln testPnt

Parameters:
Returns: float
Modifiers: inline

Returns the distance between point and finite line segment. The line segment is given as a Line3D `ln`.

Extended Type: Pnt

ln : Line3D
testPnt : Pnt
Returns: float

Pnt.distanceToLineSq ln testPnt

Full Usage: Pnt.distanceToLineSq ln testPnt

Parameters:
Returns: float
Modifiers: inline

Returns the squared distance between point and finite line segment. The line segment is given as a Line3D `ln`.

Extended Type: Pnt

ln : Line3D
testPnt : Pnt
Returns: float

Pnt.distanceToXYZ x y z p

Full Usage: Pnt.distanceToXYZ x y z p

Parameters:
    x : float
    y : float
    z : float
    p : Pnt

Returns: float
Modifiers: inline

Returns the distance between a 3D point and given x, y, z coordinates.

Extended Type: Pnt

x : float
y : float
z : float
p : Pnt
Returns: float

Pnt.distanceToXYZSq x y z p

Full Usage: Pnt.distanceToXYZSq x y z p

Parameters:
    x : float
    y : float
    z : float
    p : Pnt

Returns: float
Modifiers: inline

Returns the squared distance between a 3D point and given x, y, z coordinates.

Extended Type: Pnt

x : float
y : float
z : float
p : Pnt
Returns: float

Pnt.divPnt fromPnt toPnt rel

Full Usage: Pnt.divPnt fromPnt toPnt rel

Parameters:
    fromPnt : Pnt
    toPnt : Pnt
    rel : float

Returns: Pnt
Modifiers: inline

Linearly interpolates between two 3D points. e.g. rel=0.5 will return the middle point, rel=1.0 the endPoint, rel=3.0 a point three times the distance beyond the end point. Same as Pnt.lerp.

Extended Type: Pnt

fromPnt : Pnt
toPnt : Pnt
rel : float
Returns: Pnt

Pnt.equalsExact a b

Full Usage: Pnt.equalsExact a b

Parameters:
Returns: bool
Modifiers: inline

Checks if two 3D points are exactly equal. Compares each field with the = operator, so a NaN value is never equal.

Extended Type: Pnt

a : Pnt
b : Pnt
Returns: bool

Pnt.equalsWithin tol a b

Full Usage: Pnt.equalsWithin tol a b

Parameters:
Returns: bool
Modifiers: inline

Checks if two 3D points are equal within tolerance. The tolerance applies to the X, Y and Z coordinates separately, not to the Euclidean distance between the points. Use Pnt.equalsExact to check for an exact match.

Extended Type: Pnt

tol : float
a : Pnt
b : Pnt
Returns: bool

Pnt.extendToZLevel fromPnt toPnt z

Full Usage: Pnt.extendToZLevel fromPnt toPnt z

Parameters:
    fromPnt : Pnt
    toPnt : Pnt
    z : float

Returns: Pnt

Returns a point that is at a given Z level, going from a point in the direction of another point.

Extended Type: Pnt

fromPnt : Pnt
toPnt : Pnt
z : float
Returns: Pnt

Pnt.getX pnt

Full Usage: Pnt.getX pnt

Parameters:
Returns: float
Modifiers: inline

Gets the X value of 3D point.

Extended Type: Pnt

pnt : Pnt
Returns: float

Pnt.getY pnt

Full Usage: Pnt.getY pnt

Parameters:
Returns: float
Modifiers: inline

Gets the Y value of 3D point.

Extended Type: Pnt

pnt : Pnt
Returns: float

Pnt.getZ pnt

Full Usage: Pnt.getZ pnt

Parameters:
Returns: float
Modifiers: inline

Gets the Z value of 3D point.

Extended Type: Pnt

pnt : Pnt
Returns: float

Pnt.isAlmostOrigin tol pnt

Full Usage: Pnt.isAlmostOrigin tol pnt

Parameters:
    tol : float
    pnt : Pnt

Returns: bool
Modifiers: inline

Returns a boolean indicating whether the absolute value of X, Y and Z is each less than the given tolerance.

Extended Type: Pnt

tol : float
pnt : Pnt
Returns: bool

Pnt.isInvalid pnt

Full Usage: Pnt.isInvalid pnt

Parameters:
Returns: bool
Modifiers: inline

Same as pnt.IsInvalid.

Extended Type: Pnt

pnt : Pnt
Returns: bool

Pnt.isNotOrigin pnt

Full Usage: Pnt.isNotOrigin pnt

Parameters:
Returns: bool
Modifiers: inline

Returns a boolean indicating if any of X, Y and Z is not exactly 0.0.

Extended Type: Pnt

pnt : Pnt
Returns: bool

Pnt.isOrigin pnt

Full Usage: Pnt.isOrigin pnt

Parameters:
Returns: bool
Modifiers: inline

Returns a boolean indicating whether X, Y and Z are exactly 0.0.

Extended Type: Pnt

pnt : Pnt
Returns: bool

Pnt.isValid pnt

Full Usage: Pnt.isValid pnt

Parameters:
Returns: bool
Modifiers: inline

Returns a boolean indicating whether X, Y and Z are valid (not NaN or Infinity).

Extended Type: Pnt

pnt : Pnt
Returns: bool

Pnt.lerp fromPnt toPnt rel

Full Usage: Pnt.lerp fromPnt toPnt rel

Parameters:
    fromPnt : Pnt
    toPnt : Pnt
    rel : float

Returns: Pnt
Modifiers: inline

Linearly interpolates between two 3D points. e.g. rel=0.5 will return the middle point, rel=1.0 the endPoint, rel=3.0 a point three times the distance beyond the end point. Same as Pnt.divPnt.

Extended Type: Pnt

fromPnt : Pnt
toPnt : Pnt
rel : float
Returns: Pnt

Pnt.midPnt a b

Full Usage: Pnt.midPnt a b

Parameters:
Returns: Pnt
Modifiers: inline

Returns the midpoint of two 3D points.

Extended Type: Pnt

a : Pnt
b : Pnt
Returns: Pnt

Pnt.move shift pnt

Full Usage: Pnt.move shift pnt

Parameters:
Returns: Pnt
Modifiers: inline

Move point 3D by vector.

Extended Type: Pnt

shift : Vec
pnt : Pnt
Returns: Pnt

Pnt.moveX x pnt

Full Usage: Pnt.moveX x pnt

Parameters:
    x : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Add float to X component of a 3D point and return new 3D point.

Extended Type: Pnt

x : float
pnt : Pnt
Returns: Pnt

Pnt.moveY y pnt

Full Usage: Pnt.moveY y pnt

Parameters:
    y : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Add float to Y component of a 3D point and return new 3D point.

Extended Type: Pnt

y : float
pnt : Pnt
Returns: Pnt

Pnt.moveZ z pnt

Full Usage: Pnt.moveZ z pnt

Parameters:
    z : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Add float to Z component of a 3D point and return new 3D point.

Extended Type: Pnt

z : float
pnt : Pnt
Returns: Pnt

Pnt.normalOf3Pnts a b c

Full Usage: Pnt.normalOf3Pnts a b c

Parameters:
Returns: Vec

For three Points describing a plane return a normal. The points 'a', 'b' and 'c' in counter-clockwise order return a normal pointing towards the viewer (e.g. +Z for points in the XY plane), matching NPlane.createFrom3Pnts and Points3D.normalOfPoints. The result is not unitized. If the returned vector has length zero then the points are in one line.

Extended Type: Pnt

a : Pnt
b : Pnt
c : Pnt
Returns: Vec

Pnt.normalOfTwoPointsInXY fromPnt toPnt

Full Usage: Pnt.normalOfTwoPointsInXY fromPnt toPnt

Parameters:
Returns: Vec

Every 3D line has a normal vector in the X-Y plane. Rotated counter-clockwise in top view. The result is unitized. If line is vertical then XAxis is returned. see also : Vec.perpendicularVecInXY.

Extended Type: Pnt

fromPnt : Pnt
toPnt : Pnt
Returns: Vec

Pnt.notEqualsWithin tol a b

Full Usage: Pnt.notEqualsWithin tol a b

Parameters:
Returns: bool

Check if two 3D points are not equal within a given tolerance. The tolerance applies to the X, Y and Z coordinates separately, not to the Euclidean distance between the points.

Extended Type: Pnt

tol : float
a : Pnt
b : Pnt
Returns: bool

Pnt.pointAtDistance fromPnt dirPnt distance

Full Usage: Pnt.pointAtDistance fromPnt dirPnt distance

Parameters:
    fromPnt : Pnt
    dirPnt : Pnt
    distance : float

Returns: Pnt
Modifiers: inline

Returns a point that is at a given distance from a 3D point in the direction of another point.

Extended Type: Pnt

fromPnt : Pnt
dirPnt : Pnt
distance : float
Returns: Pnt

Pnt.projectToXYPlane pnt

Full Usage: Pnt.projectToXYPlane pnt

Parameters:
Returns: Pnt
Modifiers: inline

Project point to World X-Y plane. Use Pnt.asPt to convert to a 2D point instance.

Extended Type: Pnt

pnt : Pnt
Returns: Pnt

Pnt.projectedParameterBetweenPnts fromPnt toPnt testPnt

Full Usage: Pnt.projectedParameterBetweenPnts fromPnt toPnt testPnt

Parameters:
    fromPnt : Pnt - The start point defining the endless line.
    toPnt : Pnt - The end point defining the direction of the endless line.
    testPnt : Pnt - The point to be projected onto the line.

Returns: float The parameter along the line direction (fromPnt to toPnt) at which the projection of testPnt falls. A value of 0.0 corresponds to fromPnt, 1.0 corresponds to toPnt.
Modifiers: inline

Projects a test point onto an endless line defined by two points.

Extended Type: Pnt

fromPnt : Pnt

The start point defining the endless line.

toPnt : Pnt

The end point defining the direction of the endless line.

testPnt : Pnt

The point to be projected onto the line.

Returns: float

The parameter along the line direction (fromPnt to toPnt) at which the projection of testPnt falls. A value of 0.0 corresponds to fromPnt, 1.0 corresponds to toPnt.

Pnt.projectedParameterOnUnitVec fromPnt uv testPnt

Full Usage: Pnt.projectedParameterOnUnitVec fromPnt uv testPnt

Parameters:
    fromPnt : Pnt - The origin point of the endless line.
    uv : UnitVec - The unit direction vector describing the orientation of the endless line.
    testPnt : Pnt - The point to be projected onto the line.

Returns: float The parameter (scalar value) along the unit vector at which the projection of testPnt falls on the line.
Modifiers: inline

Projects a test point onto an endless line defined by an origin point and a unit direction vector.

Extended Type: Pnt

fromPnt : Pnt

The origin point of the endless line.

uv : UnitVec

The unit direction vector describing the orientation of the endless line.

testPnt : Pnt

The point to be projected onto the line.

Returns: float

The parameter (scalar value) along the unit vector at which the projection of testPnt falls on the line.

Pnt.projectedParameterOnVec fromPnt v testPnt

Full Usage: Pnt.projectedParameterOnVec fromPnt v testPnt

Parameters:
    fromPnt : Pnt - The origin point of the endless line.
    v : Vec - The direction vector of the endless line. Does not need to be unitized.
    testPnt : Pnt - The point to be projected onto the line.

Returns: float The parameter (scaling factor for the direction vector) at which the projection of testPnt falls on the line.
Modifiers: inline

Projects a test point onto an endless line defined by an origin point and a direction vector.

Extended Type: Pnt

fromPnt : Pnt

The origin point of the endless line.

v : Vec

The direction vector of the endless line. Does not need to be unitized.

testPnt : Pnt

The point to be projected onto the line.

Returns: float

The parameter (scaling factor for the direction vector) at which the projection of testPnt falls on the line.

Pnt.rotate q pnt

Full Usage: Pnt.rotate q pnt

Parameters:
Returns: Pnt
Modifiers: inline

Rotate by Quaternion around Origin

Extended Type: Pnt

q : Quaternion
pnt : Pnt
Returns: Pnt

Pnt.rotate2Dby90CCW pnt

Full Usage: Pnt.rotate2Dby90CCW pnt

Parameters:
Returns: Pnt
Modifiers: inline

90-degree rotation counter-clockwise around the Z-axis through the World Origin.

Extended Type: Pnt

pnt : Pnt
Returns: Pnt

Pnt.rotate2Dby90CW pnt

Full Usage: Pnt.rotate2Dby90CW pnt

Parameters:
Returns: Pnt
Modifiers: inline

90-degree rotation clockwise around the Z-axis through the World Origin.

Extended Type: Pnt

pnt : Pnt
Returns: Pnt

Pnt.rotateAround cen q pnt

Full Usage: Pnt.rotateAround cen q pnt

Parameters:
    cen : Pnt - The center point of the rotation.
    q : Quaternion - The rotation to apply.
    pnt : Pnt - The 3D point to rotate.

Returns: Pnt The rotated 3D point.
Modifiers: inline

Rotate a 3D point by a Quaternion around a given center point.

Extended Type: Pnt

cen : Pnt

The center point of the rotation.

q : Quaternion

The rotation to apply.

pnt : Pnt

The 3D point to rotate.

Returns: Pnt

The rotated 3D point.

Pnt.rotateByQuarterCircle numberOfQuarters pnt

Full Usage: Pnt.rotateByQuarterCircle numberOfQuarters pnt

Parameters:
    numberOfQuarters : int
    pnt : Pnt

Returns: Pnt

Rotates a 3D point around the Z-axis through the World Origin by a given number of quarter-circles (i.e. multiples of 90 degrees or Pi/2 radians). A positive number rotates counter-clockwise, a negative number rotates clockwise. The Z coordinate is preserved.

Extended Type: Pnt

numberOfQuarters : int
pnt : Pnt
Returns: Pnt

Pnt.rotateOnX r p

Full Usage: Pnt.rotateOnX r p

Parameters:
Returns: Pnt

Rotate the 3D point around X-axis, from Y to Z-axis, counter-clockwise looking from right.

Extended Type: Pnt

r : Rotation2D
p : Pnt
Returns: Pnt

Pnt.rotateOnXAround cen r pnt

Full Usage: Pnt.rotateOnXAround cen r pnt

Parameters:
Returns: Pnt

Rotate the 3D point around a center 3D point and an X-aligned axis, from Y to Z-axis, counter-clockwise looking from right.

Extended Type: Pnt

cen : Pnt
r : Rotation2D
pnt : Pnt
Returns: Pnt

Pnt.rotateOnXDegrees angDegree pnt

Full Usage: Pnt.rotateOnXDegrees angDegree pnt

Parameters:
    angDegree : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Rotate the 3D point in degrees around X-axis, from Y to Z-axis, counter-clockwise looking from right.

Extended Type: Pnt

angDegree : float
pnt : Pnt
Returns: Pnt

Pnt.rotateOnXDegreesAround cen angDegree pnt

Full Usage: Pnt.rotateOnXDegreesAround cen angDegree pnt

Parameters:
    cen : Pnt
    angDegree : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Rotate the 3D point in degrees around center point and an X-aligned axis, from Y to Z-axis, counter-clockwise looking from right.

Extended Type: Pnt

cen : Pnt
angDegree : float
pnt : Pnt
Returns: Pnt

Pnt.rotateOnY r p

Full Usage: Pnt.rotateOnY r p

Parameters:
Returns: Pnt

Rotate the 3D point around Y-axis, from Z to X-axis, counter-clockwise looking from back.

Extended Type: Pnt

r : Rotation2D
p : Pnt
Returns: Pnt

Pnt.rotateOnYAround cen r pnt

Full Usage: Pnt.rotateOnYAround cen r pnt

Parameters:
Returns: Pnt

Rotate the 3D point around a center point and a Y aligned axis, from Z to X-axis, counter-clockwise looking from back.

Extended Type: Pnt

cen : Pnt
r : Rotation2D
pnt : Pnt
Returns: Pnt

Pnt.rotateOnYDegrees angDegree pnt

Full Usage: Pnt.rotateOnYDegrees angDegree pnt

Parameters:
    angDegree : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Rotate the 3D point in degrees around Y-axis, from Z to X-axis, counter-clockwise looking from back.

Extended Type: Pnt

angDegree : float
pnt : Pnt
Returns: Pnt

Pnt.rotateOnYDegreesAround cen angDegree pnt

Full Usage: Pnt.rotateOnYDegreesAround cen angDegree pnt

Parameters:
    cen : Pnt
    angDegree : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Rotate the 3D point in degrees around center point and a Y aligned axis, from Z to X-axis, counter-clockwise looking from back.

Extended Type: Pnt

cen : Pnt
angDegree : float
pnt : Pnt
Returns: Pnt

Pnt.rotateOnZ r p

Full Usage: Pnt.rotateOnZ r p

Parameters:
Returns: Pnt

Rotate the 3D point around Z-axis, from X to Y-axis, counter-clockwise looking from top.

Extended Type: Pnt

r : Rotation2D
p : Pnt
Returns: Pnt

Pnt.rotateOnZAround cen r pnt

Full Usage: Pnt.rotateOnZAround cen r pnt

Parameters:
Returns: Pnt

Rotate the 3D point around a center point and a Z aligned axis, from X to Y-axis, counter-clockwise looking from top.

Extended Type: Pnt

cen : Pnt
r : Rotation2D
pnt : Pnt
Returns: Pnt

Pnt.rotateOnZDegrees angDegree pnt

Full Usage: Pnt.rotateOnZDegrees angDegree pnt

Parameters:
    angDegree : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Rotate the 3D point in degrees around Z-axis, from X to Y-axis, counter-clockwise looking from top.

Extended Type: Pnt

angDegree : float
pnt : Pnt
Returns: Pnt

Pnt.rotateOnZDegreesAround cen angDegree pnt

Full Usage: Pnt.rotateOnZDegreesAround cen angDegree pnt

Parameters:
    cen : Pnt
    angDegree : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Rotate the 3D point in degrees around center point and a Z aligned axis, from X to Y-axis, counter-clockwise looking from top.

Extended Type: Pnt

cen : Pnt
angDegree : float
pnt : Pnt
Returns: Pnt

Pnt.scale f pnt

Full Usage: Pnt.scale f pnt

Parameters:
    f : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Scale a 3D point by a scalar and return new 3D point.

Extended Type: Pnt

f : float
pnt : Pnt
Returns: Pnt

Pnt.scaleOn cen factor pnt

Full Usage: Pnt.scaleOn cen factor pnt

Parameters:
    cen : Pnt - The center point of the scaling.
    factor : float - The scale factor.
    pnt : Pnt - The 3D point to scale.

Returns: Pnt The scaled 3D point.
Modifiers: inline

Scales a 3D point by a factor around a given center point.

Extended Type: Pnt

cen : Pnt

The center point of the scaling.

factor : float

The scale factor.

pnt : Pnt

The 3D point to scale.

Returns: Pnt

The scaled 3D point.

Pnt.snap precision pnt

Full Usage: Pnt.snap precision pnt

Parameters:
    precision : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Snaps the points coordinate to the given precision. e.g. snap 0.1 Pnt(0.123, 0.456, 0) -> Pnt(0.1, 0.5, 0) e.g. snap 10 Pnt(3 , 19 , 0) -> Pnt(0 , 20 , 0) does: (Math.Round (x/precision)) * precision

Extended Type: Pnt

precision : float
pnt : Pnt
Returns: Pnt

Pnt.snapIfClose snapDistance snapTo pnt

Full Usage: Pnt.snapIfClose snapDistance snapTo pnt

Parameters:
    snapDistance : float
    snapTo : Pnt
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Snaps to a point if it is within the snapDistance. otherwise returns the original point.

Extended Type: Pnt

snapDistance : float
snapTo : Pnt
pnt : Pnt
Returns: Pnt

Pnt.transform m p

Full Usage: Pnt.transform m p

Parameters:
Returns: Pnt
Modifiers: inline

Multiplies (or applies) a Matrix to a 3D point (with an implicit 1 in the 4th dimension, so that it also works correctly for projections.)

Extended Type: Pnt

m : Matrix
p : Pnt
Returns: Pnt

Pnt.transformRigid m p

Full Usage: Pnt.transformRigid m p

Parameters:
Returns: Pnt
Modifiers: inline

Multiplies (or applies) a RigidMatrix to a 3D point.

Extended Type: Pnt

m : RigidMatrix
p : Pnt
Returns: Pnt

Pnt.transformRigidRotateOnly m p

Full Usage: Pnt.transformRigidRotateOnly m p

Parameters:
Returns: Pnt

Multiplies (or applies) only the 3x3 rotation part of a RigidMatrix to a 3D point.

Extended Type: Pnt

m : RigidMatrix
p : Pnt
Returns: Pnt

Pnt.withDistanceFromOrigin l pnt

Full Usage: Pnt.withDistanceFromOrigin l pnt

Parameters:
    l : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Returns new 3D point with given distance from Origin by scaling it up or down.

Extended Type: Pnt

l : float
pnt : Pnt
Returns: Pnt

Pnt.withX x pnt

Full Usage: Pnt.withX x pnt

Parameters:
    x : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Returns new 3D point with new X coordinate, Y and Z stay the same.

Extended Type: Pnt

x : float
pnt : Pnt
Returns: Pnt

Pnt.withY y pnt

Full Usage: Pnt.withY y pnt

Parameters:
    y : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Returns a new 3D point with new Y coordinate, X and Z stay the same.

Extended Type: Pnt

y : float
pnt : Pnt
Returns: Pnt

Pnt.withZ z pnt

Full Usage: Pnt.withZ z pnt

Parameters:
    z : float
    pnt : Pnt

Returns: Pnt
Modifiers: inline

Returns a new 3D point with new Z coordinate, X and Y stay the same.

Extended Type: Pnt

z : float
pnt : Pnt
Returns: Pnt

Type something to start searching.