AutoOpenPlane (Rhino.Scripting.Fsharp)

AutoOpenPlane Module

Namespace: Rhino.Scripting.FSharp
Assembly: Rhino.Scripting.FSharp.dll

When Rhino.Scripting.FSharp is opened this module will be auto-opened. It only contains extension members for type Plane.

Type extensions

Type extension	Description
`this.Angle90ToLine` Full Usage: `this.Angle90ToLine` Parameters: ln : `Line` Returns: `float` Modifiers: inline	Returns the angle to a Line in Degree, ignoring the ZAxis's orientation. So 0.0 if the line is parallele to the Plane. And 90 degrees if the line is perpendicular to the plane. Extended Type: `Plane` ln : `Line` Returns: `float`
`this.Angle90ToPlane` Full Usage: `this.Angle90ToPlane` Parameters: pl : `Plane` Returns: `float` Modifiers: inline	Returns the angle to another Plane in Degree, ignoring the normal's orientation. So 0.0 if the planes are parallel. And 90 degrees if the planes are perpendicular to ech other. Extended Type: `Plane` pl : `Plane` Returns: `float`
`this.Angle90ToVec` Full Usage: `this.Angle90ToVec` Parameters: v : `Vector3d` Returns: `float` Modifiers: inline	Returns the angle to 3D vector in Degree, ignoring the plane's orientation. So 0.0 if the vector is parallele to the Plane. And 90 degrees if the vector is perpendicular to the plane. Extended Type: `Plane` v : `Vector3d` Returns: `float`
`this.ClosestPoint` Full Usage: `this.ClosestPoint` Parameters: pt : `Point3d` Returns: `Point3d` Modifiers: inline	Returns the closest point on the plane from a test point. Extended Type: `Plane` pt : `Point3d` Returns: `Point3d`
`this.DistanceToPt` Full Usage: `this.DistanceToPt` Parameters: pt : `Point3d` Returns: `float` Modifiers: inline	Returns signed distance of point to plane, also indicating on which side it is. Extended Type: `Plane` pt : `Point3d` Returns: `float`
`this.EvaluateAt` Full Usage: `this.EvaluateAt` Parameters: px : `float` py : `float` pz : `float` Returns: `Point3d` Modifiers: inline	Evaluate at 3D parameter. Extended Type: `Plane` px : `float` py : `float` pz : `float` Returns: `Point3d`
`this.EvaluateAtXY` Full Usage: `this.EvaluateAtXY` Parameters: px : `float` py : `float` Returns: `Point3d` Modifiers: inline	Evaluate at 2D parameter (Z parameter = 0.0) Extended Type: `Plane` px : `float` py : `float` Returns: `Point3d`
`this.IsCoincidentTo` Full Usage: `this.IsCoincidentTo` Parameters: other : `Plane` 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 minium cosine value. See Rhino.Scripting.FSharp:.Cosine module. Extended Type: `Plane` other : `Plane` distanceTolerance : `float` minCosine : `float<MeasureProduct<cosine, MeasureOne>>` Returns: `bool`
`this.PlaneAtClPt` Full Usage: `this.PlaneAtClPt` Parameters: pt : `Point3d` Returns: `Plane` Modifiers: inline	First finds the closet point on plane from a test point. Then returns a new plane with Origin at this point and the same Axes vectors. Extended Type: `Plane` pt : `Point3d` Returns: `Plane`
`this.PointParameters` Full Usage: `this.PointParameters` Parameters: pt : `Point3d` Returns: `float * float * float` Modifiers: inline	Returns the X, Y and Z parameters of a point with regards to the plane. Extended Type: `Plane` pt : `Point3d` Returns: `float * float * float`
`Plane.WorldBack()` Full Usage: `Plane.WorldBack()` Parameters: () : `unit` Returns: `Plane` 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: `Plane` () : `unit` Returns: `Plane`
`Plane.WorldBottom()` Full Usage: `Plane.WorldBottom()` Parameters: () : `unit` Returns: `Plane` 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: `Plane` () : `unit` Returns: `Plane`
`Plane.WorldFront()` Full Usage: `Plane.WorldFront()` Parameters: () : `unit` Returns: `Plane` 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: `Plane` () : `unit` Returns: `Plane`
`Plane.WorldLeft()` Full Usage: `Plane.WorldLeft()` Parameters: () : `unit` Returns: `Plane` 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: `Plane` () : `unit` Returns: `Plane`
`Plane.WorldMinusXMinusY()` Full Usage: `Plane.WorldMinusXMinusY()` Parameters: () : `unit` Returns: `Plane` Modifiers: inline	WorldXY rotated 180 degrees round Z-axis. Extended Type: `Plane` () : `unit` Returns: `Plane`
`Plane.WorldMinusYX()` Full Usage: `Plane.WorldMinusYX()` Parameters: () : `unit` Returns: `Plane` Modifiers: inline	WorldXY rotated 270 degrees round Z-axis Counter-Clockwise from top. Extended Type: `Plane` () : `unit` Returns: `Plane`
`Plane.WorldRight()` Full Usage: `Plane.WorldRight()` Parameters: () : `unit` Returns: `Plane` 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: `Plane` () : `unit` Returns: `Plane`
`Plane.WorldTop()` Full Usage: `Plane.WorldTop()` Parameters: () : `unit` Returns: `obj`	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 Plane.WorldXY Extended Type: `Plane` () : `unit` Returns: `obj`
`Plane.WorldXMinusY()` Full Usage: `Plane.WorldXMinusY()` Parameters: () : `unit` Returns: `Plane` Modifiers: inline	WorldXY rotated 180 degrees round X-axis, Z points down now. Extended Type: `Plane` () : `unit` Returns: `Plane`
`Plane.WorldXY()` Full Usage: `Plane.WorldXY()` Parameters: () : `unit` Returns: `Plane`	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 Plane.WorldTop Extended Type: `Plane` () : `unit` Returns: `Plane`
`Plane.WorldYMinusX()` Full Usage: `Plane.WorldYMinusX()` Parameters: () : `unit` Returns: `Plane` Modifiers: inline	WorldXY rotated 90 degrees round Z-axis Counter-Clockwise from top. Extended Type: `Plane` () : `unit` Returns: `Plane`
`Plane.areCoincident tol a b` Full Usage: `Plane.areCoincident tol a b` Parameters: tol : `float` a : `Plane` b : `Plane` Returns: `bool` Modifiers: inline	Checks if two 3D Parametrized Planes are coincident within the distance tolerance.. This means that the Z-axes are parallel within 0.25 degrees and the distance of second origin to the first plane is less than the tolerance. Extended Type: `Plane` tol : `float` a : `Plane` b : `Plane` Returns: `bool`
`Plane.createOriginNormal (origin, normal)` Full Usage: `Plane.createOriginNormal (origin, normal)` Parameters: origin : `Point3d` normal : `Vector3d` Returns: `Plane`	Creates a Parametrized Plane from a point and vector representing the normal (or Z-axis). 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 Y-axis and the given normal (or Z-axis) will be used. Fails if the vectors are shorter than 1e-5. Extended Type: `Plane` origin : `Point3d` normal : `Vector3d` Returns: `Plane`
`Plane.createOriginNormalXaxis (origin, normal, xAxis)` Full Usage: `Plane.createOriginNormalXaxis (origin, normal, xAxis)` Parameters: origin : `Point3d` normal : `Vector3d` xAxis : `Vector3d` Returns: `Plane`	Creates a Parametrized Plane from a point and unit-vector representing the Z-axis. 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-5 or normal and X are parallel. Extended Type: `Plane` origin : `Point3d` normal : `Vector3d` xAxis : `Vector3d` Returns: `Plane`
`Plane.createOriginXaxisYaxis (origin, xAxis, yAxis)` Full Usage: `Plane.createOriginXaxisYaxis (origin, xAxis, yAxis)` Parameters: origin : `Point3d` xAxis : `Vector3d` yAxis : `Vector3d` Returns: `Plane`	Creates a Parametrized Plane from a point and vector representing the X-axis. The resulting Plane 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-5. Extended Type: `Plane` origin : `Point3d` xAxis : `Vector3d` yAxis : `Vector3d` Returns: `Plane`
`Plane.createThreePoints origin xPt yPt` Full Usage: `Plane.createThreePoints origin xPt yPt` Parameters: origin : `Point3d` xPt : `Point3d` yPt : `Point3d` Returns: `Plane`	Builds Plane at first point, X-axis to second point, Y-axis to third point or at lest in plane with third point. Fails if points are closer than 1e-5. Extended Type: `Plane` origin : `Point3d` xPt : `Point3d` yPt : `Point3d` Returns: `Plane`
`Plane.doLinePlaneIntersect ln pl` Full Usage: `Plane.doLinePlaneIntersect ln pl` Parameters: ln : `Line` pl : `Plane` Returns: `bool` Modifiers: inline	Checks if a finite Line intersects with Plane in one point. Returns false for NaN values or (almost) parallel or coincident lines. Extended Type: `Plane` ln : `Line` pl : `Plane` Returns: `bool`
`Plane.equals tol a b` Full Usage: `Plane.equals tol a b` Parameters: tol : `float` a : `Plane` b : `Plane` Returns: `bool` Modifiers: inline	Checks if two Parametrized Planes are equal within tolerance distance For the tips of its units vectors and its origin. Use a tolerance of 0.0 to check for an exact match. Extended Type: `Plane` tol : `float` a : `Plane` b : `Plane` Returns: `bool`
`Plane.flipOnX pl` Full Usage: `Plane.flipOnX pl` Parameters: pl : `Plane` Returns: `Plane` Modifiers: inline	Rotate the Plane 180 degrees on its X-axis. Called flip because Z-axis points in the opposite direction. Extended Type: `Plane` pl : `Plane` Returns: `Plane`
`Plane.flipOnY pl` Full Usage: `Plane.flipOnY pl` Parameters: pl : `Plane` Returns: `Plane` Modifiers: inline	Rotate the Plane 180 degrees on its Y-axis. Called flip because Z-axis points in the opposite direction. Extended Type: `Plane` pl : `Plane` Returns: `Plane`
`Plane.intersect a b` Full Usage: `Plane.intersect a b` Parameters: a : `Plane` b : `Plane` Returns: `Line option`	Returns the line of intersection between two planes. Returns None if they are parallel or coincident. Extended Type: `Plane` a : `Plane` b : `Plane` Returns: `Line option`
`Plane.intersectLine ln pl` Full Usage: `Plane.intersectLine ln pl` Parameters: ln : `Line` pl : `Plane` Returns: `Point3d option`	Returns intersection point of infinite Line with Plane. Returns None if they are parallel. Extended Type: `Plane` ln : `Line` pl : `Plane` Returns: `Point3d option`
`Plane.intersectLineParameter ln pl` Full Usage: `Plane.intersectLineParameter ln pl` Parameters: ln : `Line` pl : `Plane` Returns: `float option`	Returns the parameter on the line. The parameter is the intersection point of the infinite Line with the Plane. Returns None if they are parallel or coincident. Extended Type: `Plane` ln : `Line` pl : `Plane` Returns: `float option`
`Plane.intersectLineParameters ln pl` Full Usage: `Plane.intersectLineParameters ln pl` Parameters: ln : `Line` pl : `Plane` Returns: `(float * float * float) option`	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 Line with the Plane. Returns None if they are parallel or coincident. Extended Type: `Plane` ln : `Line` pl : `Plane` Returns: `(float * float * float) option`
`Plane.offset d pl` Full Usage: `Plane.offset d pl` Parameters: d : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Move Plane along the local Z-axis by the given distance. Same as Plane.translateZ. Extended Type: `Plane` d : `float` pl : `Plane` Returns: `Plane`
`Plane.rotateOnZ180 pl` Full Usage: `Plane.rotateOnZ180 pl` Parameters: pl : `Plane` Returns: `Plane` Modifiers: inline	Rotate the Plane 180 degrees on its Z-axis. Extended Type: `Plane` pl : `Plane` Returns: `Plane`
`Plane.rotateZ angDegree pl` Full Usage: `Plane.rotateZ angDegree pl` Parameters: angDegree : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Rotate about Z axis by angle in degree. Counter clockwise in top view (for WorldXY Plane). Extended Type: `Plane` angDegree : `float` pl : `Plane` Returns: `Plane`
`Plane.rotateZ180IfYNegative pl` Full Usage: `Plane.rotateZ180IfYNegative pl` Parameters: pl : `Plane` Returns: `Plane` 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: `Plane` pl : `Plane` Returns: `Plane`
`Plane.setOrig pt pl` Full Usage: `Plane.setOrig pt pl` Parameters: pt : `Point3d` pl : `Plane` Returns: `Plane` Modifiers: inline	Return a new plane with given Origin Extended Type: `Plane` pt : `Point3d` pl : `Plane` Returns: `Plane`
`Plane.setOrigX x pl` Full Usage: `Plane.setOrigX x pl` Parameters: x : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Return a new plane with given Origin X value changed. Extended Type: `Plane` x : `float` pl : `Plane` Returns: `Plane`
`Plane.setOrigY y pl` Full Usage: `Plane.setOrigY y pl` Parameters: y : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Return a new plane with given Origin Y value changed. Extended Type: `Plane` y : `float` pl : `Plane` Returns: `Plane`
`Plane.setOrigZ z pl` Full Usage: `Plane.setOrigZ z pl` Parameters: z : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Return a new plane with given Origin Z value changed. Extended Type: `Plane` z : `float` pl : `Plane` Returns: `Plane`
`Plane.setOrigin pt pl` Full Usage: `Plane.setOrigin pt pl` Parameters: pt : `Point3d` pl : `Plane` Returns: `Plane` Modifiers: inline	Returns a new plane with given Origin. Extended Type: `Plane` pt : `Point3d` pl : `Plane` Returns: `Plane`
`Plane.setOriginX x pl` Full Usage: `Plane.setOriginX x pl` Parameters: x : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Returns a new plane with given Origin X value changed. Extended Type: `Plane` x : `float` pl : `Plane` Returns: `Plane`
`Plane.setOriginY y pl` Full Usage: `Plane.setOriginY y pl` Parameters: y : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Returns a new plane with given Origin Y value changed. Extended Type: `Plane` y : `float` pl : `Plane` Returns: `Plane`
`Plane.setOriginZ z pl` Full Usage: `Plane.setOriginZ z pl` Parameters: z : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Returns a new plane with given Origin Z value changed. Extended Type: `Plane` z : `float` pl : `Plane` Returns: `Plane`
`Plane.translateBy v pl` Full Usage: `Plane.translateBy v pl` Parameters: v : `Vector3d` pl : `Plane` Returns: `Plane` Modifiers: inline	Return a new plane with Origin translated by Vector3d. Extended Type: `Plane` v : `Vector3d` pl : `Plane` Returns: `Plane`
`Plane.translateByWorldX x pl` Full Usage: `Plane.translateByWorldX x pl` Parameters: x : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Return a new plane with Origin translated in World X direction. Extended Type: `Plane` x : `float` pl : `Plane` Returns: `Plane`
`Plane.translateByWorldY y pl` Full Usage: `Plane.translateByWorldY y pl` Parameters: y : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Return a new plane with Origin translated in World Y direction. Extended Type: `Plane` y : `float` pl : `Plane` Returns: `Plane`
`Plane.translateByWorldZ z pl` Full Usage: `Plane.translateByWorldZ z pl` Parameters: z : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Return a new plane with Origin translated in World Z direction. Extended Type: `Plane` z : `float` pl : `Plane` Returns: `Plane`
`Plane.translateX d pl` Full Usage: `Plane.translateX d pl` Parameters: d : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Move Plane along the local X-axis by the given distance. Extended Type: `Plane` d : `float` pl : `Plane` Returns: `Plane`
`Plane.translateY d pl` Full Usage: `Plane.translateY d pl` Parameters: d : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Move Plane along the local Y-axis by the given distance. Extended Type: `Plane` d : `float` pl : `Plane` Returns: `Plane`
`Plane.translateZ d pl` Full Usage: `Plane.translateZ d pl` Parameters: d : `float` pl : `Plane` Returns: `Plane` Modifiers: inline	Move Plane along the local Z-axis by the given distance. Same as Plane.offset. Extended Type: `Plane` d : `float` pl : `Plane` Returns: `Plane`