PointOnSurfaceBuilder Class

class NXOpen.Motion.PointOnSurfaceBuilder

Bases: NXOpen.Motion.MotionBuilder

Represents a NXOpen.Motion.PointOnSurfaceBuilder

To create a new instance of this class, use NXOpen.Motion.PointOnSurfaceCollection.CreatePointOnSurfaceBuilder()

New in version NX6.0.0.

Properties

Property Description
DisplayScale Returns or sets the icon display scale
GroupName Returns or sets the group name
GroupType Returns or sets the group type
Link Returns the link
Name Returns or sets the name
Point Returns or sets the selected point
Tag Returns the Tag for this object.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetFaces Returns the selected faces
GetObject Returns the object currently being edited by this builder.
SetFaces Set the faces
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

Name

PointOnSurfaceBuilder.Name

Returns or sets the name

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

Getter Method

Signature Name

Returns:
Return type:str

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Name

Parameters:name (str) –

New in version NX6.0.0.

License requirements: mechanisms (“MECHANISMS”)

Point

PointOnSurfaceBuilder.Point

Returns or sets the selected point

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

Getter Method

Signature Point

Returns:
Return type:NXOpen.Point

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Point

Parameters:point (NXOpen.Point) –

New in version NX6.0.0.

License requirements: mechanisms (“MECHANISMS”)

Method Detail

GetFaces

PointOnSurfaceBuilder.GetFaces

Returns the selected faces

Signature GetFaces()

Returns:
Return type:list of NXOpen.Face

New in version NX6.0.0.

License requirements: None.

SetFaces

PointOnSurfaceBuilder.SetFaces

Set the faces

Signature SetFaces(faces)

Parameters:faces (list of NXOpen.Face) –

New in version NX6.0.0.

License requirements: mechanisms (“MECHANISMS”)

Validate

PointOnSurfaceBuilder.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.