InsertComponentBuilder Class

class NXOpen.Layout2d.InsertComponentBuilder

Bases: NXOpen.Builder

Represents a Builder for Insert Component functionality which will insert a 2D * Component instance in the active sketch

To create a new instance of this class, use NXOpen.Layout2d.ComponentCollection.CreateInsertComponentBuilder()

New in version NX10.0.0.

Properties

Property Description
Angle Returns or sets the component rotation angle, measured counterclockwise, around the anchor point, from the sketch +X direction to component’s X axis
Settings Returns the Component settings block builder which holds the component settings builder
Sketch Returns or sets the sketch to insert the 2D Component
SpecifyPoint Returns or sets the point specified to put the 2D Component instance
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.
GetObject Returns the object currently being edited by this builder.
SetLocation Sets the location type of the 2D Component indicating local, native or team center
SetPath Sets the path of the reuse library for the 2D Component
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

Angle

InsertComponentBuilder.Angle

Returns or sets the component rotation angle, measured counterclockwise, around the anchor point, from the sketch +X direction to component’s X axis

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

Getter Method

Signature Angle

Returns:
Return type:float

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature Angle

Parameters:angle (float) –

New in version NX12.0.0.

License requirements: nx_layout (“NX Layout”)

Settings

InsertComponentBuilder.Settings

Returns the Component settings block builder which holds the component settings builder

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

Getter Method

Signature Settings

Returns:
Return type:NXOpen.Layout2d.ComponentSettingsBlockBuilder

New in version NX10.0.0.

License requirements: None.

Sketch

InsertComponentBuilder.Sketch

Returns or sets the sketch to insert the 2D Component

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

Getter Method

Signature Sketch

Returns:
Return type:NXOpen.Sketch

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature Sketch

Parameters:sketch (NXOpen.Sketch) –

New in version NX10.0.0.

License requirements: nx_layout (“NX Layout”)

SpecifyPoint

InsertComponentBuilder.SpecifyPoint

Returns or sets the point specified to put the 2D Component instance

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

Getter Method

Signature SpecifyPoint

Returns:
Return type:NXOpen.Point3d

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature SpecifyPoint

Parameters:specifyPoint (NXOpen.Point3d) –

New in version NX10.0.0.

License requirements: nx_layout (“NX Layout”)

Method Detail

SetLocation

InsertComponentBuilder.SetLocation

Sets the location type of the 2D Component indicating local, native or team center

Signature SetLocation(locationType)

Parameters:locationType (NXOpen.Layout2d.Layout2dDefinitionLocation) –

New in version NX10.0.0.

License requirements: nx_layout (“NX Layout”)

SetPath

InsertComponentBuilder.SetPath

Sets the path of the reuse library for the 2D Component

Signature SetPath(path)

Parameters:path (str) – the path of the 2D Component

New in version NX10.0.0.

License requirements: nx_layout (“NX Layout”)

Validate

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