FormIt Plugin API  v23.0.0 (2023.0.0)
WSM.Point3d API

Description

Functions

json WSM.Point3d.Point3d (x, y, z)
 Point3d constructs a Point3d. More...
 
json WSM.Point3d.AreEqual (pt1, pt2)
 
json WSM.Point3d.AddPoint (point1, point2)
 Adds two points. More...
 
json WSM.Point3d.AddVector (point, vector)
 
json WSM.Point3d.SubtractPoint (point1, point2)
 Subtracts a point from a point. More...
 
json WSM.Point3d.SubtractVector (point, vector)
 
json WSM.Point3d.MultiplyByFactor (point, factor)
 
json WSM.Point3d.DotWithVector (point, vector)
 Returns the dot product between a point and vector. More...
 
json WSM.Point3d.DistanceBetweenPoints (point1, point2)
 Returns the distance between two points. More...
 
json WSM.Point3d.DistanceSquaredBetweenPoints (point1, point2)
 Returns the squared distance between two points. More...
 
json WSM.Point3d.IsBetweenPoints (point, linePoint1, linePoint2)
 Returns true if a point (that is assumed to lie on the line defined by the two points p1, p2) is between the two given points or is coincident with one of the points In: WSM.Point3d, WSM.Point3d, WSM.Point3d Out: bool. More...
 
json WSM.Point3d.Transform (point, transf3d)
 

Function Documentation

json WSM.Point3d.AddPoint ( point1  ,
point2   
)

Adds two points.

Returns the new point Parameters: In: WSM.Point3d, WSM.Point3d Out: WSM.Point3d

Parameters
[in]point1WSM.Point3d
[in]point2WSM.Point3d
Returns
point1 + point2
json WSM.Point3d.AddVector ( point  ,
vector   
)
json WSM.Point3d.AreEqual ( pt1  ,
pt2   
)
json WSM.Point3d.DistanceBetweenPoints ( point1  ,
point2   
)

Returns the distance between two points.

Parameters: In: WSM.Point3d, WSM.Point3d Out: double

Parameters
[in]point1WSM.Point3d
[in]point2WSM.Point3d
Returns
point1.dist(point2)
json WSM.Point3d.DistanceSquaredBetweenPoints ( point1  ,
point2   
)

Returns the squared distance between two points.

Parameters: In: WSM.Point3d, WSM.Point3d Out: double

Parameters
[in]point1WSM.Point3d
[in]point2WSM.Point3d
Returns
point1.distSqrd(point2)
json WSM.Point3d.DotWithVector ( point  ,
vector   
)

Returns the dot product between a point and vector.

Parameters: In: WSM.Point3d, WSM.Vector3d Out: double

Parameters
[in]pointWSM.Point3d
[in]vectorWSM.Vector3d
Returns
point % vector
json WSM.Point3d.IsBetweenPoints ( point  ,
linePoint1  ,
linePoint2   
)

Returns true if a point (that is assumed to lie on the line defined by the two points p1, p2) is between the two given points or is coincident with one of the points In: WSM.Point3d, WSM.Point3d, WSM.Point3d Out: bool.

Parameters
[in]pointWSM.Point3d
[in]linePoint1WSM.Point3d
[in]linePoint2WSM.Point3d
Returns
point.isBetween(linePoint1, linePoint2)
json WSM.Point3d.MultiplyByFactor ( point  ,
factor   
)
json WSM.Point3d.Point3d ( ,
,
 
)

Point3d constructs a Point3d.

Parameters: In: x, y, z Out: Point3d

Parameters
[in]x(OPTIONAL, default = 0.0) double
[in]y(OPTIONAL, default = 0.0) double
[in]z(OPTIONAL, default = 0.0) double
Returns
{...}
json WSM.Point3d.SubtractPoint ( point1  ,
point2   
)

Subtracts a point from a point.

Returns a vector that goes from point 2 to point 1 Parameters: In: WSM.Point3d, WSM.Point3d Out: WSM.Vector3d

Parameters
[in]point1WSM.Point3d
[in]point2WSM.Point3d
Returns
point1 - point2
json WSM.Point3d.SubtractVector ( point  ,
vector   
)
json WSM.Point3d.Transform ( point  ,
transf3d   
)