Plane (hwx.inspire.geometry)#

class Plane(features, planeMethod, ratio=0.5, offset=0, rotationAngle=0, flipTangent=False, noOfPlanes=1)#

Bases: BaseSystem

Reference planes can be used with the Sketch, Slice, and Mirror tools to create or modify geometry, or to create section cuts.

__new__(cls, features, planeMethod, ratio=0.5, offset=0, rotationAngle=0, flipTangent=False, noOfPlanes=1)#

Create a reference plane.

Parameters:

  • features (list[Feature]) – Features to create a reference plane.

  • planeMethod (str) – Valid values are: - OFFSET - THREE_POINTS - MIDPLANE - NORMAL_TO_EDGE - AT_AN_ANGLE - NORMAL_TO_EDGE_AT_POINT - CYLINDER_TANGENT - PARALLEL_TO_SCREEN - UNREFERENCED

  • ratio (float | str) – Applicable for MidPlane and CurveNormal method. If value is a string it can be a Model Variable or a value with units.

  • offset (float | str) – offset value. Applicable for Offset method.

  • rotationAngle (float | str) – Angle in degree. Applicable for At an angle method. If value is a string it can be a Model Variable or a value with units.

  • flipTangent (bool) – If True, flip the tangent for cylinder tangent method.

  • noOfPlanes (int) – Number of planes. Only applicable for OFFSET and AT_AN_ANGLE planeMethod.

Example

from hwx import inspire

model = inspire.newModel()
model.createSolidBlock()
feature = model.getFeatures(type="FeaturePlanar")[0]
inspire.geometry.Plane(feature, "OFFSET", offset=0.05)
print("Reference plane has been created by offset method")
inspire.orientView(direction="isometric")