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
|
|
|
|
|
|
|
|
|
|
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:
|
Full Usage:
this.DistanceFromOrigin
Parameters:
unit
Returns: float
Modifiers: inline |
|
Full Usage:
this.DistanceFromOriginSq
Parameters:
unit
Returns: float
Modifiers: inline |
|
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:
|
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:
|
|
|
|
|
|
|
|
|
Full Usage:
this.DistanceToXYZ
Parameters:
float
y : float
z : float
Returns: float
Modifiers: inline |
Returns the distance between a 3D point and given x, y, z coordinates.
Extended Type:
|
Full Usage:
this.DistanceToXYZSq
Parameters:
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:
|
Full Usage:
this.IsAlmostOrigin
Parameters:
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:
|
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:
|
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:
|
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:
|
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:
|
Full Usage:
this.Rotate
Parameters:
Quaternion
-
The rotation to apply.
Returns: Pnt
The rotated 3D point.
Modifiers: inline |
Rotate the 3D point by a Quaternion around the World Origin.
Extended Type:
|
|
|
|
|
Full Usage:
this.RotateAround
Parameters:
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:
|
Full Usage:
this.RotateByQuarterCircle
Parameters:
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:
|
|
|
|
Multiplies (or applies) a RigidMatrix to a 3D point.
Extended Type:
|
Full Usage:
this.TransformRigidRotateOnly
Parameters:
RigidMatrix
Returns: Pnt
Modifiers: inline |
Multiplies (or applies) only the 3x3 rotation part of a RigidMatrix to a 3D point.
Extended Type:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Full Usage:
Pnt.create x y z
Parameters:
float
y : float
z : float
Returns: Pnt
Modifiers: inline |
|
Full Usage:
Pnt.createFromMembersXYZ pt
Parameters:
^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)) |
|
Full Usage:
Pnt.createFromMembersxyz pt
Parameters:
^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)) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Full Usage:
Pnt.distanceToXYZ x y z p
Parameters:
float
y : float
z : float
p : Pnt
Returns: float
Modifiers: inline |
|
Full Usage:
Pnt.distanceToXYZSq x y z p
Parameters:
float
y : float
z : float
p : Pnt
Returns: float
Modifiers: inline |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Full Usage:
Pnt.isAlmostOrigin tol pnt
Parameters:
float
pnt : Pnt
Returns: bool
Modifiers: inline |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
|
Full Usage:
Pnt.projectedParameterBetweenPnts fromPnt toPnt testPnt
Parameters:
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:
|
Full Usage:
Pnt.projectedParameterOnUnitVec fromPnt uv testPnt
Parameters:
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:
|
Full Usage:
Pnt.projectedParameterOnVec fromPnt v testPnt
Parameters:
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:
|
|
|
|
|
|
|
Full Usage:
Pnt.rotateAround cen q pnt
Parameters:
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:
|
|
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:
|
|
Rotate the 3D point around X-axis, from Y to Z-axis, counter-clockwise looking from right.
Extended Type:
|
Full Usage:
Pnt.rotateOnXAround cen r pnt
Parameters:
Pnt
r : Rotation2D
pnt : Pnt
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:
|
|
|
|
|
|
Rotate the 3D point around Y-axis, from Z to X-axis, counter-clockwise looking from back.
Extended Type:
|
Full Usage:
Pnt.rotateOnYAround cen r pnt
Parameters:
Pnt
r : Rotation2D
pnt : Pnt
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:
|
|
|
|
|
|
Rotate the 3D point around Z-axis, from X to Y-axis, counter-clockwise looking from top.
Extended Type:
|
Full Usage:
Pnt.rotateOnZAround cen r pnt
Parameters:
Pnt
r : Rotation2D
pnt : Pnt
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:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Full Usage:
Pnt.transformRigid m p
Parameters:
RigidMatrix
p : Pnt
Returns: Pnt
Modifiers: inline |
Multiplies (or applies) a RigidMatrix to a 3D point.
Extended Type:
|
|
Multiplies (or applies) only the 3x3 rotation part of a RigidMatrix to a 3D point.
Extended Type:
|
|
|
|
|
|
|
|
Euclid