Plane

class rhino3dm.Plane
Plane()

Plane constructor

Plane(origin, normal)

Constructs a plane from a point and a normal vector.

Parameters:
Plane(origin, xPoint, yPoint)

Initializes a plane from three non-collinear points.

Parameters:

  • origin (rhino3dm.Point3d) – Origin point of the plane.

  • xPoint (rhino3dm.Point3d) – Second point in the plane. The x-axis will be parallel to x_point-origin.

  • yPoint (rhino3dm.Point3d) – Third point on the plane that is not collinear with the first two points. taxis*(y_point-origin) will be > 0.

Plane(origin, xDirection, yDirection)

Constructs a plane from a point and two vectors in the plane.

Parameters:

  • origin (rhino3dm.Point3d) – Origin point of the plane.

  • xDirection (rhino3dm.Vector3d) – Non-zero vector in the plane that determines the x-axis direction.

  • yDirection (rhino3dm.Vector3d) – Non-zero vector not parallel to x_dir that is used to determine the y-axis direction. y_dir does not need to be perpendicular to x_dir.

Plane()

Constructs a plane from an equation Ax+By+Cz+D=0.

Origin

rhino3dm.Point3d: Gets or sets the origin point of this plane.

XAxis

rhino3dm.Vector3d: Gets or sets the X axis vector of this plane.

YAxis

rhino3dm.Vector3d: Gets or sets the Y axis vector of this plane.

ZAxis

rhino3dm.Vector3d: Gets or sets the Z axis vector of this plane.

static WorldXY()

[todo] add documentation

static WorldYZ()

[todo] add documentation

static WorldZX()

[todo] add documentation

static Unset()

[todo] add documentation

PointAt(u, v)

Evaluate a point on the plane.

Parameters:

  • u (float) – evaluation parameter.

  • v (float) – evaluation parameter.

Returns:

plane.origin + u*plane.xaxis + v*plane.yaxis.

Return type:

rhino3dm.Point3d

PointAt(u, v, w)

Evaluate a point on the plane.

Returns:

plane.origin + u*plane.xaxis + v*plane.yaxis.

Return type:

rhino3dm.Point3d

Rotate(angle, axis)

Rotate the plane about its origin point.

Parameters:

  • sinAngle (float) – Sin(angle).

  • cosAngle (float) – Cos(angle).

  • axis (rhino3dm.Vector3d) – Axis of rotation.

Returns:

True on success, False on failure.

Return type:

bool

Encode()

[todo] add documentation

static Decode(jsonObject)

[todo] add documentation