Plane3D

Canonical path: NemAll_Python_Geometry.Plane3D

Representation class for 3D plane.

Point property writable

Point: Point3D

Get 3D Plane reference point

Vector property writable

Vector: Vector3D

Get the Normal Vector

CalcPlaneVectors

CalcPlaneVectors() -> tuple[Vector3D, Vector3D]

Calc X and Y axis vectors for plane

Returns:

• Vector3D –

  Vector of plane's X axis

• Vector3D –

  Vector of plane's Y axis

Examples:

plane_1 has a normal vector of (1, 0, 1) and a point (0, 0, 0). Calculate the vectors of the plane's coordinate system, like:

>>> plane_1.CalcPlaneVectors()
(Vector3D(0, 1, 0), Vector3D(-1, 0, 1))

GetPoint

GetPoint() -> Point3D

Get 3D Plane reference point

Returns:

• Point3D –

  Point3D.

GetTransformationMatrix

GetTransformationMatrix() -> Matrix3D

Get transformation matrix for given plane 3D

Returns:

• Matrix3D –

  Transformation matrix

Examples:

plane_1 has a normal vector of (1, 0, 1) and a point (0, 0, 0). Calculate the transformation matrix of the plane, like:

>>> plane_1.GetTransformationMatrix()
Matrix3D(
   0 1 0 0
   -0.707... 0 0.707... 0
   0.707... 0 0.707... 0
   0 0 0 1)

GetVector

GetVector() -> Vector3D

Get the Normal Vector

Returns:

• Vector3D –

  Vector3D.

Set

Set(point: Point3D, normalVector: Vector3D)

Initialize Plane from point and vector

Parameters:

• point (Point3D) –

  New point.

• normalVector (Vector3D) –

  New vector.

SetPoint

SetPoint(point: Point3D)

Set reference point

Parameters:

• point (Point3D) –

  New point.

SetVector

SetVector(vec: Vector3D)

Set the Normal Vector

Parameters:

• vec (Vector3D) –

  New vector.

__eq__

__eq__(plane: Plane3D) -> bool

Comparison of planes.

Be careful, this method work without tolerance!

Parameters:

• plane (Plane3D) –

  plane to be compared.

Returns:

• bool –

  True when planes are equal, otherwise false.

__init__ overloaded

__init__()

Initialize

__init__(plane: Plane3D)

Copy constructor

Parameters:

• plane (Plane3D) –

  Plane which will be copied.

__init__(point: Point3D, normalVector: Vector3D)

Constructor

Create 3D Plane with given point and vector

Parameters:

• point (Point3D) –

  Init point of the plane.

• normalVector (Vector3D) –

  Init vector of the plane.

__init__(point1: Point3D, point2: Point3D, point3: Point3D)

Constructor

Create 3D Plane from three points which lies on this plane. If plane can not be computed, then constructor throw geometry exception 'Incorrect parameters'.

Parameters:

• point1 (Point3D) –

  1st point on the plane.

• point2 (Point3D) –

  2nd point on the plane.

• point3 (Point3D) –

  3rd point on the plane.

__init__(axis: Axis3D)

Create a plane from a 3D axis

Parameters:

• axis (Axis3D) –

  Axis

__mul__ overloaded

__mul__(matrix: Matrix2D) -> Plane3D

2D matrix transformation.

Parameters:

• matrix (Matrix2D) –

  2D transformation Matrix

Returns:

• Plane3D –

  Copy of transformed 3D plane.

__mul__(matrix: Matrix3D) -> Plane3D

3D matrix transformation.

Parameters:

• matrix (Matrix3D) –

  3D transformation Matrix

Returns:

• Plane3D –

  Copy of transformed 3D plane.

__repr__

__repr__() -> str

Convert to string

Placeholder