Logo Euclid

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

this.Angle90ToLine

Full Usage: this.Angle90ToLine

Parameters:
Returns: float
Modifiers: inline

Returns the angle to a Line3D in degrees, ignoring the ZAxis's orientation. So 0.0 if the line is parallel to the Plane. And 90 degrees if the line is perpendicular to the plane.

Extended Type: PPlane

ln : Line3D
Returns: float

this.Angle90ToPlane

Full Usage: this.Angle90ToPlane

Parameters:
Returns: float
Modifiers: inline

Returns the angle to another Plane in degrees, ignoring the normal's orientation. So 0.0 if the planes are parallel. And 90 degrees if the planes are perpendicular to each other.

Extended Type: PPlane

pl : PPlane
Returns: float

this.Angle90ToVec

Full Usage: this.Angle90ToVec

Parameters:
Returns: float
Modifiers: inline

Returns the angle to 3D vector in degrees, ignoring the plane's orientation. So 0.0 if the vector is parallel to the Plane. And 90 degrees if the vector is perpendicular to the plane.

Extended Type: PPlane

v : Vec
Returns: float

this.Angle90ToVec

Full Usage: this.Angle90ToVec

Parameters:
Returns: float
Modifiers: inline

Returns the angle to 3D unit-vector in degrees, ignoring the plane's orientation. So 0.0 if the vector is parallel to the Plane. And 90 degrees if the vector is perpendicular to the plane.

Extended Type: PPlane

v : UnitVec
Returns: float

this.ClosestParameters

Full Usage: this.ClosestParameters

Parameters:
Returns: float * float

Returns the X and Y parameters of the closest point on the PPlane to a given point.

Extended Type: PPlane

p : Pnt
Returns: float * float

this.ClosestPoint

Full Usage: this.ClosestPoint

Parameters:
Returns: Pnt
Modifiers: inline

Returns the closest point on the plane from a test point.

Extended Type: PPlane

pnt : Pnt
Returns: Pnt

this.DistanceToPnt

Full Usage: this.DistanceToPnt

Parameters:
Returns: float
Modifiers: inline

Returns absolute distance of point to plane.

Extended Type: PPlane

pnt : Pnt
Returns: float

this.DistanceToPntSigned

Full Usage: this.DistanceToPntSigned

Parameters:
Returns: float
Modifiers: inline

Returns signed distance of point to plane, also indicating on which side it is.

Extended Type: PPlane

pnt : Pnt
Returns: float

this.DistanceToXYZ

Full Usage: this.DistanceToXYZ

Parameters:
    x : float
    y : float
    z : float

Returns: float
Modifiers: inline

Returns absolute distance of point to plane.

Extended Type: PPlane

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

this.DistanceToXYZSigned

Full Usage: this.DistanceToXYZSigned

Parameters:
    x : 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: PPlane

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

this.EvaluateAt

Full Usage: this.EvaluateAt

Parameters:
    px : float
    py : float

Returns: Pnt
Modifiers: inline

Evaluate at 2D parameter (Z parameter = 0.0)

Extended Type: PPlane

px : float
py : float
Returns: Pnt

this.EvaluateAtXYZ

Full Usage: this.EvaluateAtXYZ

Parameters:
    px : float
    py : float
    pz : float

Returns: Pnt
Modifiers: inline

Evaluate at 3D parameter.

Extended Type: PPlane

px : float
py : float
pz : float
Returns: Pnt

this.IsCoincidentTo

Full Usage: this.IsCoincidentTo

Parameters:
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: PPlane

other : PPlane
distanceTolerance : float
minCosine : float<MeasureProduct<cosine, MeasureOne>>
Returns: bool

this.Move

Full Usage: this.Move

Parameters:
    v : Vec - The vector to move by.

Returns: PPlane A new moved plane.
Modifiers: inline

Moves the origin of the plane by a vector in world space. The axes stay the same.

Extended Type: PPlane

v : Vec

The vector to move by.

Returns: PPlane

A new moved plane.

this.MoveX

Full Usage: this.MoveX

Parameters:
    distance : float - The distance to move by.

Returns: PPlane A new moved plane.
Modifiers: inline

Moves the origin of the plane along the world X-axis. The axes stay the same.

Extended Type: PPlane

distance : float

The distance to move by.

Returns: PPlane

A new moved plane.

this.MoveY

Full Usage: this.MoveY

Parameters:
    distance : float - The distance to move by.

Returns: PPlane A new moved plane.
Modifiers: inline

Moves the origin of the plane along the world Y-axis. The axes stay the same.

Extended Type: PPlane

distance : float

The distance to move by.

Returns: PPlane

A new moved plane.

this.MoveZ

Full Usage: this.MoveZ

Parameters:
    distance : float - The distance to move by.

Returns: PPlane A new moved plane.
Modifiers: inline

Moves the origin of the plane along the world Z-axis. The axes stay the same.

Extended Type: PPlane

distance : float

The distance to move by.

Returns: PPlane

A new moved plane.

this.PlaneAtClosestPnt

Full Usage: this.PlaneAtClosestPnt

Parameters:
Returns: PPlane
Modifiers: inline

First finds the closest point on plane from a test point. Then returns a new plane with Origin at this point and the same Axes vectors.

Extended Type: PPlane

pnt : Pnt
Returns: PPlane

this.PointParameters

Full Usage: this.PointParameters

Parameters:
Returns: float * float * float
Modifiers: inline

Returns the X, Y and Z parameters of a point with regards to the plane.

Extended Type: PPlane

pnt : Pnt
Returns: float * float * float

this.Rotate

Full Usage: this.Rotate

Parameters:
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: PPlane

q : Quaternion

The rotation to apply.

Returns: PPlane

A new rotated plane.

this.RotateAround

Full Usage: this.RotateAround

Parameters:
    cen : 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: PPlane

cen : Pnt

The center point of the rotation.

q : Quaternion

The rotation to apply.

Returns: PPlane

A new rotated plane.

this.Scale

Full Usage: this.Scale

Parameters:
    factor : float - The scale factor.

Returns: PPlane A new scaled plane.
Modifiers: inline

Scales the origin of the plane by a factor from the world origin. The axes stay the same.

Extended Type: PPlane

factor : float

The scale factor.

Returns: PPlane

A new scaled plane.

this.ScaleOn

Full Usage: this.ScaleOn

Parameters:
    cen : Pnt - The center point of the scaling.
    factor : float - The scale factor.

Returns: PPlane A new scaled plane.
Modifiers: inline

Scales the origin of the plane by a factor from a center point. The axes stay the same.

Extended Type: PPlane

cen : Pnt

The center point of the scaling.

factor : float

The scale factor.

Returns: PPlane

A new scaled plane.

this.TransformRigid

Full Usage: this.TransformRigid

Parameters:
Returns: PPlane A new transformed plane.
Modifiers: inline

Transforms the plane by the given RigidMatrix. The returned PPlane has orthogonal unit-vectors.

Extended Type: PPlane

m : RigidMatrix

The rigid transformation to apply.

Returns: PPlane

A new transformed plane.

PPlane.WorldBack()

Full Usage: PPlane.WorldBack()

Parameters:
    () : unit

Returns: PPlane
Modifiers: inline

Returns the Coordinate System Plane of a Back view. X-axis = minus World X-axis Y-axis = World Z-axis Z-axis = World Y-axis

Extended Type: PPlane

() : unit
Returns: PPlane

PPlane.WorldBottom()

Full Usage: PPlane.WorldBottom()

Parameters:
    () : unit

Returns: PPlane
Modifiers: inline

Returns the Coordinate System Plane of a Bottom view. X-axis = World X-axis Y-axis = minus World Y-axis Z-axis = minus World Z-axis

Extended Type: PPlane

() : unit
Returns: PPlane

PPlane.WorldFront()

Full Usage: PPlane.WorldFront()

Parameters:
    () : unit

Returns: PPlane
Modifiers: inline

Returns the Coordinate System Plane of a Front view. X-axis = World X-axis Y-axis = World Z-axis Z-axis = minus World Y-axis

Extended Type: PPlane

() : unit
Returns: PPlane

PPlane.WorldLeft()

Full Usage: PPlane.WorldLeft()

Parameters:
    () : unit

Returns: PPlane
Modifiers: inline

Returns the Coordinate System Plane of a Left view. X-axis = minus World Y-axis Y-axis = World Z-axis Z-axis = minus World X-axis

Extended Type: PPlane

() : unit
Returns: PPlane

PPlane.WorldMinusXMinusY()

Full Usage: PPlane.WorldMinusXMinusY()

Parameters:
    () : unit

Returns: PPlane
Modifiers: inline

WorldXY rotated 180 degrees round Z-axis. X-axis = minus World X-axis Y-axis = minus World Y-axis Z-axis = World Z-axis

Extended Type: PPlane

() : unit
Returns: PPlane

PPlane.WorldMinusYX()

Full Usage: PPlane.WorldMinusYX()

Parameters:
    () : unit

Returns: PPlane
Modifiers: inline

WorldXY rotated 270 degrees round Z-axis counter-clockwise from top. X-axis = minus World Y-axis Y-axis = World X-axis Z-axis = World Z-axis

Extended Type: PPlane

() : unit
Returns: PPlane

PPlane.WorldRight()

Full Usage: PPlane.WorldRight()

Parameters:
    () : unit

Returns: PPlane
Modifiers: inline

Returns the Coordinate System Plane of a Right view. X-axis = World Y-axis Y-axis = World Z-axis Z-axis = World X-axis

Extended Type: PPlane

() : unit
Returns: PPlane

PPlane.WorldTop()

Full Usage: PPlane.WorldTop()

Parameters:
    () : unit

Returns: PPlane
Modifiers: inline

Returns the World Coordinate System Plane at World Origin. X-axis = World X-axis Y-axis = World Y-axis Z-axis = World Z-axis same as PPlane.WorldXY

Extended Type: PPlane

() : unit
Returns: PPlane

PPlane.WorldXMinusY()

Full Usage: PPlane.WorldXMinusY()

Parameters:
    () : unit

Returns: PPlane
Modifiers: inline

WorldXY rotated 180 degrees round X-axis, Z points down now. X-axis = World X-axis Y-axis = minus World Y-axis Z-axis = minus World Z-axis

Extended Type: PPlane

() : unit
Returns: PPlane

PPlane.WorldXY()

Full Usage: PPlane.WorldXY()

Parameters:
    () : unit

Returns: PPlane
Modifiers: inline

Returns the World Coordinate System Plane at World Origin. X-axis = World X-axis Y-axis = World Y-axis Z-axis = World Z-axis same as PPlane.WorldTop

Extended Type: PPlane

() : unit
Returns: PPlane

PPlane.WorldYMinusX()

Full Usage: PPlane.WorldYMinusX()

Parameters:
    () : unit

Returns: PPlane
Modifiers: inline

WorldXY rotated 90 degrees round Z-axis counter-clockwise from top. X-axis = World Y-axis Y-axis = minus World X-axis Z-axis = World Z-axis

Extended Type: PPlane

() : unit
Returns: PPlane

PPlane.angle90ToLine ln pl

Full Usage: PPlane.angle90ToLine ln pl

Parameters:
Returns: float
Modifiers: inline

Returns the angle to a Line3D in degrees, ignoring the ZAxis's orientation. So 0.0 if the line is parallel to the Plane. And 90 degrees if the line is perpendicular to the plane.

Extended Type: PPlane

ln : Line3D
pl : PPlane
Returns: float

PPlane.angle90ToPlane other pl

Full Usage: PPlane.angle90ToPlane other pl

Parameters:
Returns: float
Modifiers: inline

Returns the angle to another Plane in degrees, ignoring the normal's orientation. So 0.0 if the planes are parallel. And 90 degrees if the planes are perpendicular to each other.

Extended Type: PPlane

other : PPlane
pl : PPlane
Returns: float

PPlane.angle90ToUnitVec v pl

Full Usage: PPlane.angle90ToUnitVec v pl

Parameters:
Returns: float
Modifiers: inline

Returns the angle to 3D unit-vector in degrees, ignoring the plane's orientation. So 0.0 if the vector is parallel to the Plane. And 90 degrees if the vector is perpendicular to the plane.

Extended Type: PPlane

v : UnitVec
pl : PPlane
Returns: float

PPlane.angle90ToVec v pl

Full Usage: PPlane.angle90ToVec v pl

Parameters:
Returns: float
Modifiers: inline

Returns the angle to 3D vector in degrees, ignoring the plane's orientation. So 0.0 if the vector is parallel to the Plane. And 90 degrees if the vector is perpendicular to the plane.

Extended Type: PPlane

v : Vec
pl : PPlane
Returns: float

PPlane.areCoincident distanceTolerance minCosine a b

Full Usage: PPlane.areCoincident distanceTolerance minCosine a b

Parameters:
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: PPlane

distanceTolerance : float
minCosine : float<MeasureProduct<cosine, MeasureOne>>
a : PPlane
b : PPlane
Returns: bool

PPlane.closestParameters p pl

Full Usage: PPlane.closestParameters p pl

Parameters:
Returns: float * float
Modifiers: inline

Returns the X and Y parameters of the closest point on the PPlane to a given point.

Extended Type: PPlane

p : Pnt
pl : PPlane
Returns: float * float

PPlane.closestPoint pnt pl

Full Usage: PPlane.closestPoint pnt pl

Parameters:
Returns: Pnt
Modifiers: inline

Returns the closest point on the plane from a test point.

Extended Type: PPlane

pnt : Pnt
pl : PPlane
Returns: Pnt

PPlane.createFrom3Pnts origin xPnt yPnt

Full Usage: PPlane.createFrom3Pnts origin xPnt yPnt

Parameters:
Returns: PPlane

Builds Plane at first point, X-axis to second point, Y-axis to third point or at least in plane with third point. Fails if points are closer than 1e-6.

Extended Type: PPlane

origin : Pnt
xPnt : Pnt
yPnt : Pnt
Returns: PPlane

PPlane.createFromNormal normal origin

Full Usage: PPlane.createFromNormal normal origin

Parameters:
Returns: PPlane

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: PPlane

normal : Vec
origin : Pnt
Returns: PPlane

PPlane.createFromUnitNormal normal origin

Full Usage: PPlane.createFromUnitNormal normal origin

Parameters:
Returns: PPlane

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: PPlane

normal : UnitVec
origin : Pnt
Returns: PPlane

PPlane.createFromUnitXAxisAndNormal normal xAxis origin

Full Usage: PPlane.createFromUnitXAxisAndNormal normal xAxis origin

Parameters:
Returns: PPlane

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: PPlane

normal : UnitVec
xAxis : UnitVec
origin : Pnt
Returns: PPlane

PPlane.createFromUnitXAxisAndYAxis xAxis yAxis origin

Full Usage: PPlane.createFromUnitXAxisAndYAxis xAxis yAxis origin

Parameters:
Returns: PPlane

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: PPlane

xAxis : UnitVec
yAxis : UnitVec
origin : Pnt
Returns: PPlane

PPlane.createFromXAxisAndNormal normal xAxis origin

Full Usage: PPlane.createFromXAxisAndNormal normal xAxis origin

Parameters:
Returns: PPlane

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: PPlane

normal : Vec
xAxis : Vec
origin : Pnt
Returns: PPlane

PPlane.createFromXAxisAndYAxis xAxis yAxis origin

Full Usage: PPlane.createFromXAxisAndYAxis xAxis yAxis origin

Parameters:
Returns: PPlane

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: PPlane

xAxis : Vec
yAxis : Vec
origin : Pnt
Returns: PPlane

PPlane.distanceToPnt pnt pl

Full Usage: PPlane.distanceToPnt pnt pl

Parameters:
Returns: float
Modifiers: inline

Returns absolute distance of point to plane.

Extended Type: PPlane

pnt : Pnt
pl : PPlane
Returns: float

PPlane.distanceToPntSigned pnt pl

Full Usage: PPlane.distanceToPntSigned pnt pl

Parameters:
Returns: float
Modifiers: inline

Returns signed distance of point to plane, also indicating on which side it is.

Extended Type: PPlane

pnt : Pnt
pl : PPlane
Returns: float

PPlane.distanceToXYZ x y z pl

Full Usage: PPlane.distanceToXYZ x y z pl

Parameters:
    x : float
    y : float
    z : float
    pl : PPlane

Returns: float
Modifiers: inline

Returns absolute distance of point to plane.

Extended Type: PPlane

x : float
y : float
z : float
pl : PPlane
Returns: float

PPlane.distanceToXYZSigned x y z pl

Full Usage: PPlane.distanceToXYZSigned x y z pl

Parameters:
    x : float
    y : float
    z : float
    pl : PPlane

Returns: float
Modifiers: inline

Returns signed distance of point to plane, also indicating on which side it is.

Extended Type: PPlane

x : float
y : float
z : float
pl : PPlane
Returns: float

PPlane.doLinePlaneIntersect ln pl

Full Usage: PPlane.doLinePlaneIntersect ln pl

Parameters:
Returns: bool
Modifiers: inline

Checks if a finite Line3D intersects with Plane in one point. Returns FALSE for NaN values or (almost) parallel or coincident lines.

Extended Type: PPlane

ln : Line3D
pl : PPlane
Returns: bool

PPlane.equalsExact a b

Full Usage: PPlane.equalsExact a b

Parameters:
Returns: bool
Modifiers: inline

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

Extended Type: PPlane

a : PPlane
b : PPlane
Returns: bool

PPlane.equalsWithin tol a b

Full Usage: PPlane.equalsWithin tol a b

Parameters:
Returns: bool
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: PPlane

tol : float
a : PPlane
b : PPlane
Returns: bool

PPlane.evaluateAt px py pl

Full Usage: PPlane.evaluateAt px py pl

Parameters:
    px : float
    py : float
    pl : PPlane

Returns: Pnt
Modifiers: inline

Evaluate at 2D parameter (Z parameter = 0.0)

Extended Type: PPlane

px : float
py : float
pl : PPlane
Returns: Pnt

PPlane.evaluateAtXYZ px py pz pl

Full Usage: PPlane.evaluateAtXYZ px py pz pl

Parameters:
    px : float
    py : float
    pz : float
    pl : PPlane

Returns: Pnt
Modifiers: inline

Evaluate at 3D parameter.

Extended Type: PPlane

px : float
py : float
pz : float
pl : PPlane
Returns: Pnt

PPlane.flipOnLocalX pl

Full Usage: PPlane.flipOnLocalX pl

Parameters:
Returns: PPlane
Modifiers: inline

Rotate the Plane 180 degrees on its own X-axis. Called flip because Z-axis points in the opposite direction.

Extended Type: PPlane

pl : PPlane
Returns: PPlane

PPlane.flipOnLocalY pl

Full Usage: PPlane.flipOnLocalY pl

Parameters:
Returns: PPlane
Modifiers: inline

Rotate the Plane 180 degrees on its own Y-axis. Called flip because Z-axis points in the opposite direction.

Extended Type: PPlane

pl : PPlane
Returns: PPlane

PPlane.intersect a b

Full Usage: PPlane.intersect a b

Parameters:
Returns: Line3D

Returns the line of intersection between two planes. Fails if they are parallel or coincident. Use PPlane.tryIntersect to get ValueNone instead.

Extended Type: PPlane

a : PPlane
b : PPlane
Returns: Line3D

PPlane.intersectLine ln pl

Full Usage: PPlane.intersectLine ln pl

Parameters:
Returns: Pnt

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: PPlane

ln : Line3D
pl : PPlane
Returns: Pnt

PPlane.intersectRay ln pl

Full Usage: PPlane.intersectRay ln pl

Parameters:
Returns: float

Returns the parameter on the line. The parameter 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.tryIntersectRay to get ValueNone instead.

Extended Type: PPlane

ln : Line3D
pl : PPlane
Returns: float

PPlane.intersectRayAllParameters ln pl

Full Usage: PPlane.intersectRayAllParameters ln pl

Parameters:
Returns: float * float * float

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: PPlane

ln : Line3D
pl : PPlane
Returns: float * float * float

PPlane.move translation pl

Full Usage: PPlane.move translation pl

Parameters:
Returns: PPlane
Modifiers: inline

Move plane origin by vector in world space.

Extended Type: PPlane

translation : Vec
pl : PPlane
Returns: PPlane

PPlane.moveAlongLocalX d pl

Full Usage: PPlane.moveAlongLocalX d pl

Parameters:
Returns: PPlane
Modifiers: inline

Move Plane along the local X-axis by the given distance.

Extended Type: PPlane

d : float
pl : PPlane
Returns: PPlane

PPlane.moveAlongLocalY d pl

Full Usage: PPlane.moveAlongLocalY d pl

Parameters:
Returns: PPlane
Modifiers: inline

Move Plane along the local Y-axis by the given distance.

Extended Type: PPlane

d : float
pl : PPlane
Returns: PPlane

PPlane.moveAlongLocalZ d pl

Full Usage: PPlane.moveAlongLocalZ d pl

Parameters:
Returns: PPlane
Modifiers: inline

Move Plane along the local Z-axis by the given distance. Same as PPlane.offset.

Extended Type: PPlane

d : float
pl : PPlane
Returns: PPlane

PPlane.moveX x pl

Full Usage: PPlane.moveX x pl

Parameters:
Returns: PPlane
Modifiers: inline

Returns a new plane with Origin translated in World X direction.

Extended Type: PPlane

x : float
pl : PPlane
Returns: PPlane

PPlane.moveY y pl

Full Usage: PPlane.moveY y pl

Parameters:
Returns: PPlane
Modifiers: inline

Returns a new plane with Origin translated in World Y direction.

Extended Type: PPlane

y : float
pl : PPlane
Returns: PPlane

PPlane.moveZ z pl

Full Usage: PPlane.moveZ z pl

Parameters:
Returns: PPlane
Modifiers: inline

Returns a new plane with Origin translated in World Z direction.

Extended Type: PPlane

z : float
pl : PPlane
Returns: PPlane

PPlane.notEqualsWithin tol a b

Full Usage: PPlane.notEqualsWithin tol a b

Parameters:
Returns: bool
Modifiers: inline

Checks if two Parametrized Planes are NOT 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.

Extended Type: PPlane

tol : float
a : PPlane
b : PPlane
Returns: bool

PPlane.offset d pl

Full Usage: PPlane.offset d pl

Parameters:
Returns: PPlane
Modifiers: inline

Move Plane along the local Z-axis by the given distance. Same as PPlane.moveAlongLocalZ.

Extended Type: PPlane

d : float
pl : PPlane
Returns: PPlane

PPlane.planeAtClosestPnt pnt pl

Full Usage: PPlane.planeAtClosestPnt pnt pl

Parameters:
Returns: PPlane
Modifiers: inline

First finds the closest point on plane from a test point. Then returns a new plane with Origin at this point and the same Axes vectors.

Extended Type: PPlane

pnt : Pnt
pl : PPlane
Returns: PPlane

PPlane.pointParameters pnt pl

Full Usage: PPlane.pointParameters pnt pl

Parameters:
Returns: float * float * float
Modifiers: inline

Returns the X, Y and Z parameters of a point with regards to the plane.

Extended Type: PPlane

pnt : Pnt
pl : PPlane
Returns: float * float * float

PPlane.rotate q pl

Full Usage: PPlane.rotate q pl

Parameters:
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: PPlane

q : Quaternion

The rotation to apply.

pl : PPlane

The plane to rotate.

Returns: PPlane

A new rotated plane.

PPlane.rotateAround cen q pl

Full Usage: PPlane.rotateAround cen q pl

Parameters:
    cen : 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: PPlane

cen : 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.

PPlane.rotateOnLocalZ180 pl

Full Usage: PPlane.rotateOnLocalZ180 pl

Parameters:
Returns: PPlane
Modifiers: inline

Rotate the Plane 180 degrees on its Z-axis.

Extended Type: PPlane

pl : PPlane
Returns: PPlane

PPlane.rotateOnLocalZ180IfYNegative pl

Full Usage: PPlane.rotateOnLocalZ180IfYNegative pl

Parameters:
Returns: PPlane
Modifiers: inline

Rotate Plane 180 degrees around Z-axis if the Y-axis orientation does not match World Y (pl.Yax.Y < 0.0) To ensure that Y is always positive. For example for showing Text.

Extended Type: PPlane

pl : PPlane
Returns: PPlane

PPlane.rotateOnLocalZDegrees angDegree pl

Full Usage: PPlane.rotateOnLocalZDegrees angDegree pl

Parameters:
    angDegree : float - The rotation angle in degrees.
    pl : PPlane - The plane to rotate.

Returns: PPlane A new rotated plane.
Modifiers: inline

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: PPlane

angDegree : float

The rotation angle in degrees.

pl : PPlane

The plane to rotate.

Returns: PPlane

A new rotated plane.

PPlane.rotateOnLocalZRadians angRadians pl

Full Usage: PPlane.rotateOnLocalZRadians angRadians pl

Parameters:
    angRadians : float - The rotation angle in radians.
    pl : PPlane - The plane to rotate.

Returns: PPlane A new rotated plane.

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: PPlane

angRadians : float

The rotation angle in radians.

pl : PPlane

The plane to rotate.

Returns: PPlane

A new rotated plane.

PPlane.scale factor pl

Full Usage: PPlane.scale factor pl

Parameters:
Returns: PPlane
Modifiers: inline

Scales the PPlane's origin position by a given factor from the world origin (0,0,0). The axes directions remain unchanged.

Extended Type: PPlane

factor : float
pl : PPlane
Returns: PPlane

PPlane.scaleOn cen factor pl

Full Usage: PPlane.scaleOn cen factor pl

Parameters:
    cen : Pnt - The center point of the scaling.
    factor : float - The scale factor.
    pl : PPlane - The plane to scale.

Returns: PPlane A new scaled plane.
Modifiers: inline

Scales the origin of the plane by a factor from a center point. The axes stay the same.

Extended Type: PPlane

cen : Pnt

The center point of the scaling.

factor : float

The scale factor.

pl : PPlane

The plane to scale.

Returns: PPlane

A new scaled plane.

PPlane.transformRigid m pl

Full Usage: PPlane.transformRigid m pl

Parameters:
Returns: PPlane

Transforms the plane by the given RigidMatrix. The returned PPlane has orthogonal unit-vectors.

Extended Type: PPlane

m : RigidMatrix
pl : PPlane
Returns: PPlane

PPlane.tryIntersect a b

Full Usage: PPlane.tryIntersect a b

Parameters:
Returns: Line3D voption

Returns the line of intersection between two planes. Returns ValueNone if they are parallel or coincident.

Extended Type: PPlane

a : PPlane
b : PPlane
Returns: Line3D voption

PPlane.tryIntersectLine ln pl

Full Usage: PPlane.tryIntersectLine ln pl

Parameters:
Returns: Pnt voption

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: PPlane

ln : Line3D
pl : PPlane
Returns: Pnt voption

PPlane.tryIntersectRay ln pl

Full Usage: PPlane.tryIntersectRay ln pl

Parameters:
Returns: float voption

Returns the parameter on the line. The parameter is the intersection point of the infinite ray with the PPlane. Returns ValueNone if they are parallel or coincident.

Extended Type: PPlane

ln : Line3D
pl : PPlane
Returns: float voption

PPlane.tryIntersectRayAllParameters ln pl

Full Usage: PPlane.tryIntersectRayAllParameters ln pl

Parameters:
Returns: (float * float * float) voption

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: PPlane

ln : Line3D
pl : PPlane
Returns: (float * float * float) voption

PPlane.withOrigin pnt pl

Full Usage: PPlane.withOrigin pnt pl

Parameters:
Returns: PPlane
Modifiers: inline

Returns a new plane with given Origin. The axes stay the same.

Extended Type: PPlane

pnt : Pnt
pl : PPlane
Returns: PPlane

PPlane.withOriginX x pl

Full Usage: PPlane.withOriginX x pl

Parameters:
Returns: PPlane
Modifiers: inline

Returns a new plane with given Origin X value changed. The axes stay the same.

Extended Type: PPlane

x : float
pl : PPlane
Returns: PPlane

PPlane.withOriginY y pl

Full Usage: PPlane.withOriginY y pl

Parameters:
Returns: PPlane
Modifiers: inline

Returns a new plane with given Origin Y value changed. The axes stay the same.

Extended Type: PPlane

y : float
pl : PPlane
Returns: PPlane

PPlane.withOriginZ z pl

Full Usage: PPlane.withOriginZ z pl

Parameters:
Returns: PPlane
Modifiers: inline

Returns a new plane with given Origin Z value changed. The axes stay the same.

Extended Type: PPlane

z : float
pl : PPlane
Returns: PPlane

Type something to start searching.