FacePlaneToolBuilder Class

class NXOpen.GeometricUtilities.FacePlaneToolBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

a sub-component of BooleanToolBuilder.

It provides two basic tools * creation methods i.e. collector sets of faces/datum planes, or a new plane * created on the fly.

New in version NX6.0.0.

Properties

Property Description
Tag Returns the Tag for this object.
ToolFaces Returns the sets of tool faces or datum planes
ToolPlane Returns or sets the new plane created on the fly.

Methods

Method Description
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

ToolFaces

FacePlaneToolBuilder.ToolFaces

Returns the sets of tool faces or datum planes

-------------------------------------

Getter Method

Signature ToolFaces

Returns:
Return type:NXOpen.GeometricUtilities.FaceSetData

New in version NX6.0.0.

License requirements: None.

ToolPlane

FacePlaneToolBuilder.ToolPlane

Returns or sets the new plane created on the fly.

Note: only one plane is get/set

-------------------------------------

Getter Method

Signature ToolPlane

Returns:
Return type:NXOpen.Plane

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ToolPlane

Parameters:toolPlane (NXOpen.Plane) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Method Detail

Validate

FacePlaneToolBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.