Plane (hwx.inspire.core)

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

Attributes

active: Bool

moveWithPart: Bool

name: Attribute

origin: Location

part: Attribute

position: Attribute

systemType: Enum

type: Enum

visible: Bool

Public Methods

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

Attribute Details

active : Bool

Returns or sets the object activeness.

Setting this on or off sets all children. Setting to True sets all the parents active too.

moveWithPart : Bool

Whether the system is moving with the associated part or not.

name : Attribute

Returns or sets the name of the object.

It can be any text string, including spaces, although it’s best to avoid using the following characters: ” ‘ * ? and $.

While these characters are allowed, they could create difficulties when you export the model to other applications.

origin : Location (units=”length”)

The origin of this system in local coordinate system.

part : Attribute

The part associated with this system.

position : Attribute

The global transform as a Matrix44.

systemType : Enum

The type of the system.

type : Enum

The type of the system.

visible : Bool

Determines whether the object is visible in the graphics window.

Setting this on or off sets all children. Setting to True sets all the parents visible too.

Method Details

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

Create a reference plane.

param features

Features to create a reference plane.

type features

list[Feature]

param planeMethod

Valid values are: - OFFSET - THREE_POINTS - MIDPLANE - NORMAL_TO_EDGE - AT_AN_ANGLE - NORMAL_TO_EDGE_AT_POINT - CYLINDER_TANGENT - PARALLEL_TO_SCREEN - UNREFERENCED

type planeMethod

str

param ratio

Applicable for MidPlane and CurveNormal method. If value is a string it can be a Model Variable or a value with units.

type ratio

float | str

param offset

offset value. Applicable for Offset method.

type offset

float | str

param rotationAngle

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.

type rotationAngle

float | str

param flipTangent

If True, flip the tangent for cylinder tangent method.

type flipTangent

bool

param noOfPlanes

Number of planes. Only applicable for OFFSET and AT_AN_ANGLE planeMethod.

type noOfPlanes

int