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

Description

Functions

json WSM.Transf3d.MakeRotationTransform (axis, angle)
 Create a transform for rotation Parameters: In: axis In: angle Out: transf3d. More...
 
json WSM.Transf3d.MakeScalingTransform (scaleCenter, factorVec)
 Create a transform for scaling Parameters: In: scaleCenter In: factorVec (x, y, z scaling factors) Out: transf3d. More...
 
json WSM.Transf3d.MakeTranslationTransform (vector)
 Returns a translation transform. More...
 
json WSM.Transf3d.MakeMirrorTransform (plane)
 Returns a mirror transform. More...
 
json WSM.Transf3d.MakeAlignedTransformFromPoints (src1, src2, src3, dst1, dst2, dst3)
 Returns a transform that aligns three points to three other points The transformation maps points as follows: More...
 
json WSM.Transf3d.MakeAlignedTransformFromPointsAndVectors (src1, src2, src3, dst1, dst2, dst3)
 Returns a transform that aligns a point and two vectors to another point and two vectors The transformation maps points and vectors as follows: More...
 
json WSM.Transf3d.MakeRigidTransform (origin, xDir, yDir, zDir)
 Create a rigid transformation. More...
 
json WSM.Transf3d.Transf3d (arg0, arg1, arg2, arg3)
 
json WSM.Transf3d.Invert (trans)
 Returns the inverted transform of an existing transform Parameters: In: WSM.Transf3d Out: WSM.Transf3d. More...
 
json WSM.Transf3d.IsIdentity (trans)
 Returns true if a transform is the identity transform, false otherwise Parameters: In: WSM.Transf3d Out: bool. More...
 
json WSM.Transf3d.AreEqual (trans1, trans2)
 
json WSM.Transf3d.SetValue (trans, i1, i2, value)
 Returns the given transform with the new value set at the (i1, i2) position. More...
 
json WSM.Transf3d.GetValue (trans, i1, i2)
 Returns the value at the (i1, i2) position of a transform Parameters: In: WSM.Transf3d, size_t, size_t Out: double. More...
 
json WSM.Transf3d.Multiply (trans, geomObject)
 
json WSM.Transf3d.GetCoordinateSystem (trans)
 Returns the coordinate system of a transform. More...
 
json WSM.Transf3d.SetOrigin (trans, origin)
 Sets the origin of a transform. More...
 

Function Documentation

json WSM.Transf3d.AreEqual ( trans1  ,
trans2   
)
json WSM.Transf3d.GetCoordinateSystem ( trans  )

Returns the coordinate system of a transform.

Parameters: In: WSM.Transf3d Out: "origin" WSM.Point3d "xDir" WSM.Vector3d "yDir" WSM.Vector3d "zDir" WSM.Vector3d

Parameters
[in]transWSM.Transf3d
Returns
{ { "origin" , to_json(origin)}, { "xDir" , to_json(xDir)}, { "yDir" , to_json(yDir)}, { "zDir" , to_json(zDir)} };
json WSM.Transf3d.GetValue ( trans  ,
i1  ,
i2   
)

Returns the value at the (i1, i2) position of a transform Parameters: In: WSM.Transf3d, size_t, size_t Out: double.

Parameters
[in]transWSM.Transf3d
[in]i1int
[in]i2int
Returns
trans(i1, i2)
json WSM.Transf3d.Invert ( trans  )

Returns the inverted transform of an existing transform Parameters: In: WSM.Transf3d Out: WSM.Transf3d.

Parameters
[in]transWSM.Transf3d
Returns
trans.invert()
json WSM.Transf3d.IsIdentity ( trans  )

Returns true if a transform is the identity transform, false otherwise Parameters: In: WSM.Transf3d Out: bool.

Parameters
[in]transWSM.Transf3d
Returns
trans.isIdentity()
json WSM.Transf3d.MakeAlignedTransformFromPoints ( src1  ,
src2  ,
src3  ,
dst1  ,
dst2  ,
dst3   
)

Returns a transform that aligns three points to three other points The transformation maps points as follows:

Point src1 maps to point dst1 Vector (src1,src2) maps to vector (dst1,dst2) Plane (src1,src2,src3) maps to plane (dst1,dst2,dst3) Parameters: In: WSM.Point3d, WSM.Point3d, WSM.Point3d, WSM.Point3d, WSM.Point3d, WSM.Point3d Out: WSM.Transf3d

Parameters
[in]src1WSM.Point3d
[in]src2WSM.Point3d
[in]src3WSM.Point3d
[in]dst1WSM.Point3d
[in]dst2WSM.Point3d
[in]dst3WSM.Point3d
Returns
WSM.Transf3d.align(src1, src2, src3, dst1, dst2, dst3)
json WSM.Transf3d.MakeAlignedTransformFromPointsAndVectors ( src1  ,
src2  ,
src3  ,
dst1  ,
dst2  ,
dst3   
)

Returns a transform that aligns a point and two vectors to another point and two vectors The transformation maps points and vectors as follows:

Point src1 maps to point dst1 Vector src2 maps to vector dst2 Plane (src1,src2,src3) maps to plane (dst1,dst2,dst3) In: WSM.Point3d, WSM.Vector3d, WSM.Vector3d, WSM.Point3d, WSM.Vector3d, WSM.Vector3d Out: WSM.Transf3d

Parameters
[in]src1WSM.Point3d
[in]src2WSM.Vector3d
[in]src3WSM.Vector3d
[in]dst1WSM.Point3d
[in]dst2WSM.Vector3d
[in]dst3WSM.Vector3d
Returns
WSM.Transf3d.align(src1, src2, src3, dst1, dst2, dst3)
json WSM.Transf3d.MakeMirrorTransform ( plane  )

Returns a mirror transform.

The mirroring is defined by the given WSM.Plane Parameters: In: WSM.Plane Out: WSM.Transf3d

Parameters
[in]planeWSM.Plane
Returns
WSM.Transf3d.mirroring(plane)
json WSM.Transf3d.MakeRigidTransform ( origin  ,
xDir  ,
yDir  ,
zDir   
)

Create a rigid transformation.

A wrapper for the Transf3d(Point, Vec, Vec, Vec) constructor. Refer to Transf3d for more information. Parameters: In: origin In: xDir In: yDir In: zDir Out: transf3d

Parameters
[in]originWSM.Point3d
[in]xDirWSM.Vector3d
[in]yDirWSM.Vector3d
[in]zDirWSM.Vector3d
Returns
transf3d

A wrapper for the Transf3d(Point, Vec, Vec, Vec) constructor. Refer to Transf3d for more information. Parameters: In: WSM.Point3d origin In: WSM.Vector3d xDir In: WSM.Vector3d yDir In: WSM.Vector3d zDir Out: WSM.Transf3d

Parameters
[in]originWSM.Point3d
[in]xDirWSM.Vector3d
[in]yDirWSM.Vector3d
[in]zDirWSM.Vector3d
Returns
transf3d
json WSM.Transf3d.MakeRotationTransform ( axis  ,
angle   
)

Create a transform for rotation Parameters: In: axis In: angle Out: transf3d.

Parameters
[in]axisWSM.Line3d
[in]angledouble
Returns
transf3d
json WSM.Transf3d.MakeScalingTransform ( scaleCenter  ,
factorVec   
)

Create a transform for scaling Parameters: In: scaleCenter In: factorVec (x, y, z scaling factors) Out: transf3d.

Create a scale transform from a center and x,y,z scale factors Parameters: In: WSM.Point3d scaleCenter In: WSM.Vector3d factorVec Out: WSM.Transf3d.

Parameters
[in]scaleCenterWSM.Point3d
[in]factorVecWSM.Vector3d
Returns
transf3d
json WSM.Transf3d.MakeTranslationTransform ( vector  )

Returns a translation transform.

Parameters: In: WSM.Vector3d Out: WSM.Transf3d

Parameters
[in]vectorWSM.Vector3d
Returns
WSM.Transf3d.translation(vector)
json WSM.Transf3d.Multiply ( trans  ,
geomObject   
)
json WSM.Transf3d.SetOrigin ( trans  ,
origin   
)

Sets the origin of a transform.

Returns the transform with the new origin. Parameters: In: WSM.Transf3d, WSM.Point3d Out: WSM.Transf3d

Parameters
[in]transWSM.Transf3d
[in]originWSM.Point3d
Returns
trans
json WSM.Transf3d.SetValue ( trans  ,
i1  ,
i2  ,
value   
)

Returns the given transform with the new value set at the (i1, i2) position.

Parameters: In: WSM.Transf3d, size_t, size_t, double Out: WSM.Transf3d

Parameters
[in]transWSM.Transf3d
[in]i1int
[in]i2int
[in]valuedouble
Returns
trans
json WSM.Transf3d.Transf3d ( arg0  ,
arg1  ,
arg2  ,
arg3   
)