AutoOpenPPlane Module
When Euclid is opened this module will be auto-opened. It only contains extension members for type PPlane.
Type extensions
| Type extension |
Description
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Full Usage:
this.DistanceToXYZ
Parameters:
float
y : float
z : float
Returns: float
Modifiers: inline |
Returns absolute distance of point to plane.
Extended Type:
|
Full Usage:
this.DistanceToXYZSigned
Parameters:
float
y : float
z : float
Returns: float
Modifiers: inline |
Returns signed distance of point to plane, also indicating on which side it is.
Extended Type:
|
|
|
Full Usage:
this.EvaluateAtXYZ
Parameters:
float
py : float
pz : float
Returns: Pnt
Modifiers: inline |
|
Full Usage:
this.IsCoincidentTo
Parameters:
PPlane
distanceTolerance : float
minCosine : float<MeasureProduct<cosine, MeasureOne>>
Returns: bool
Modifiers: inline |
Checks if two PPlanes are coincident within the distance tolerance. 1e-6 by default. This means that their Z-axes are parallel within the angle tolerance and the distance of second origin to the first plane is less than the distance tolerance. The default angle tolerance is 0.25 degrees. This tolerance can be customized by an optional minimum cosine value. See Euclid.Cosine module. The static counterpart is PPlane.areCoincident.
Extended Type:
|
Full Usage:
this.MoveX
Parameters:
float
-
The distance to move by.
Returns: PPlane
A new moved plane.
Modifiers: inline |
|
Full Usage:
this.MoveY
Parameters:
float
-
The distance to move by.
Returns: PPlane
A new moved plane.
Modifiers: inline |
|
Full Usage:
this.MoveZ
Parameters:
float
-
The distance to move by.
Returns: PPlane
A new moved plane.
Modifiers: inline |
|
|
|
Full Usage:
this.PointParameters
Parameters:
Pnt
Returns: float * float * float
Modifiers: inline |
|
Full Usage:
this.Rotate
Parameters:
Quaternion
-
The rotation to apply.
Returns: PPlane
A new rotated plane.
Modifiers: inline |
Rotates the plane by a Quaternion around the world origin. The origin and all three axes are rotated.
Extended Type:
|
Full Usage:
this.RotateAround
Parameters:
Pnt
-
The center point of the rotation.
q : Quaternion
-
The rotation to apply.
Returns: PPlane
A new rotated plane.
|
Rotates the plane by a Quaternion around a given center point. The origin and all three axes are rotated.
Extended Type:
|
Full Usage:
this.Scale
Parameters:
float
-
The scale factor.
Returns: PPlane
A new scaled plane.
Modifiers: inline |
|
|
|
Full Usage:
this.TransformRigid
Parameters:
RigidMatrix
-
The rigid transformation to apply.
Returns: PPlane
A new transformed plane.
Modifiers: inline |
Transforms the plane by the given RigidMatrix. The returned PPlane has orthogonal unit-vectors.
Extended Type:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Full Usage:
PPlane.areCoincident distanceTolerance minCosine a b
Parameters:
float
minCosine : float<MeasureProduct<cosine, MeasureOne>>
a : PPlane
b : PPlane
Returns: bool
Modifiers: inline |
Checks if two PPlanes are coincident within the given tolerances. This means that their Z-axes are parallel within the angle tolerance and the distance of second origin to the first plane is less than the distance tolerance. Use a precomputed value from Euclid.Cosine module as tolerance. The instance counterpart is PPlane.IsCoincidentTo.
Extended Type:
|
|
|
|
|
|
|
|
Creates a Parametrized Plane from a vector representing the normal (or Z-axis) and an origin point. The X-axis will be found by taking the Cross Product of the World Z-axis and the given normal (or Z-axis). This will make the X-axis horizontal. If this fails because they are coincident, the Cross Product of the World X-axis and the given normal (or Z-axis) will be used. Fails if the vectors are shorter than 1e-6.
Extended Type:
|
|
Creates a Parametrized Plane from a unit-vector representing the normal (or Z-axis) and an origin point. The X-axis will be found by taking the Cross Product of the World Z-axis and the given normal (or Z-axis). This will make the X-axis horizontal. If this fails because they are coincident, the Cross Product of the World X-axis and the given normal (or Z-axis) will be used.
Extended Type:
|
|
Creates a Parametrized Plane from a unit-vector representing the Z-axis, a unit-vector as X-axis hint and an origin point. The given X vector does not need to be perpendicular to the normal vector, just not parallel. Fails if normal and xAxis are parallel within 1 degree.
Extended Type:
|
|
Creates a Parametrized Plane from a unit-vector representing the X-axis, a unit-vector as Y-axis hint and an origin point. The resulting PPlane will have the X-axis in direction of X vector. The X and Y vectors will define the plane and the side that Z will be on. The given Y vector does not need to be perpendicular to the X vector, just not parallel. Fails if the vectors are parallel within 1 degree.
Extended Type:
|
|
Creates a Parametrized Plane from a vector representing the Z-axis, a vector as X-axis hint and an origin point. The given X vector does not need to be perpendicular to the normal vector, just not parallel. Fails if the vectors are shorter than 1e-6 or normal and X are parallel.
Extended Type:
|
|
Creates a Parametrized Plane from a vector representing the X-axis, a vector as Y-axis hint and an origin point. The resulting PPlane will have the X-axis in direction of X vector. The X and Y vectors will define the plane and the side that Z will be on. The given Y vector does not need to be perpendicular to the X vector, just not parallel. Fails if the vectors are shorter than 1e-6.
Extended Type:
|
|
|
|
|
Full Usage:
PPlane.distanceToXYZ x y z pl
Parameters:
float
y : float
z : float
pl : PPlane
Returns: float
Modifiers: inline |
|
Full Usage:
PPlane.distanceToXYZSigned x y z pl
Parameters:
float
y : float
z : float
pl : PPlane
Returns: float
Modifiers: inline |
|
|
|
|
|
|
Checks if two Parametrized Planes are equal within tolerance. The tolerance applies to each coordinate of the origin and of the X-axis and Y-axis separately, not to the Euclidean distance between them. Use PPlane.equalsExact to check for an exact match.
Extended Type:
|
|
|
|
|
|
|
|
|
|
|
|
Returns intersection point of a finite line with the Plane. Intersection just below 0.0 or just above 1.0 within tolerance of 1e-6 are clamped to 0.0 or 1.0. Fails if they are parallel, if the line is too short, or if the domain of intersection is outside 0.0 to 1.0. Use PPlane.tryIntersectLine to get ValueNone instead.
Extended Type:
|
|
|
|
Returns the line parameter and the X and Y parameters on the Plane. as tuple (pLn, pPlX, pPlY). The parameters is the intersection point of the infinite ray with the PPlane. Fails if they are parallel or coincident, or if the line is too short. Use PPlane.tryIntersectRayAllParameters to get ValueNone instead.
Extended Type:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Full Usage:
PPlane.rotate q pl
Parameters:
Quaternion
-
The rotation to apply.
pl : PPlane
-
The plane to rotate.
Returns: PPlane
A new rotated plane.
Modifiers: inline |
Rotates the plane by a Quaternion around the world origin. The origin and all three axes are rotated.
Extended Type:
|
Full Usage:
PPlane.rotateAround cen q pl
Parameters:
Pnt
-
The center point of the rotation.
q : Quaternion
-
The rotation to apply.
pl : PPlane
-
The plane to rotate.
Returns: PPlane
A new rotated plane.
Modifiers: inline |
Rotates the plane by a Quaternion around a given center point. The origin and all three axes are rotated.
Extended Type:
|
|
|
|
|
|
Rotates the plane about its own Z-axis by an angle in degrees. The origin stays the same. Positive angles rotate counter-clockwise in top view (for the WorldXY plane).
Extended Type:
|
|
Rotates the plane about its own Z-axis by an angle in radians. The origin stays the same. Positive angles rotate counter-clockwise in top view (for the WorldXY plane).
Extended Type:
|
|
|
|
|
|
Transforms the plane by the given RigidMatrix. The returned PPlane has orthogonal unit-vectors.
Extended Type:
|
|
|
|
Returns intersection point of a finite line with the Plane. Returns ValueNone if they are parallel or the domain of intersection is outside 0.0 to 1.0. Intersection just below 0.0 or just above 1.0 within tolerance of 1e-6 are clamped to 0.0 or 1.0. Returns ValueNone if the line is too short.
Extended Type:
|
|
|
|
Returns the line parameter and the X and Y parameters on the Plane. as tuple (pLn, pPlX, pPlY). The parameters is the intersection point of the infinite ray with the PPlane. Returns ValueNone if they are parallel or coincident.
Extended Type:
|
|
|
|
|
|
|
|
Euclid