FormboardLayoutBuilder Class

class NXOpen.Formboard.FormboardLayoutBuilder

Bases: NXOpen.Builder

Class that performs the “layout” of Formboard geometry.

Creates all geometry chosen by the user to flatten into a drawing and orients the geometry to match the criteria specified in this builder class. This builder must only be instantiated and used after the harnesses have been specified and stored using the NXOpen.Formboard.FormboardManager.StoreHarnessesToFlatten() method. To create a new instance of this class, use NXOpen.Formboard.FormboardManager.CreateLayoutBuilder()

New in version NX7.5.0.

Properties

Property	Description
BranchAngleMethod	Returns or sets the branch angle type.
BranchShapeType	Returns or sets the branch shape type.
LengthOptions	Returns the length options for the layout operation.
MainRunEndSelection	Returns the end of the main run.
MainRunMethod	Returns or sets the main run method.
MainRunOrigin	Returns or sets the main run origin.
MainRunStartSelection	Returns the start of the main run.
MaximumRandomAngle	Returns the maximum random angle.
MinimumRandomAngle	Returns the minimum random angle.
PrimaryStandardAngle	Returns the primary standard angle.
ReverseMainRun	Returns or sets the flag that determines whether the main run is reversed or not.
SecondaryStandardAngle	Returns the secondary standard angle.
Tag	Returns the Tag for this object.
TertiaryStandardAngle	Returns the tertiary standard angle.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
CreateDefaultGeometry	Creates the initial set of formboard geometry using the current default values stored in 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.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
TranslateToNewOrigin	Translates the formboard geometry so that it matches the new main run origin, this is a more lightweight operation than the full UpdateLayout operation.
UpdateLayout	Updates the orientation and placement of the formboard geometry to match the current set of layout options stored within the builder.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

FormboardLayoutBuilderBranchAngle Enumeration	Methods for determining which angles to apply at each branch of the Formboard.
FormboardLayoutBuilderBranchShape Enumeration	Shape option for the branches.
FormboardLayoutBuilderMainRunType Enumeration	Selection method for the set of segments that define the main run of the formboard geometry.

Property Detail

BranchAngleMethod

FormboardLayoutBuilder.BranchAngleMethod

Returns or sets the branch angle type.

Specifies how the layout algorithm determines the angle between each child branch and its parent branch.

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

Getter Method

Signature BranchAngleMethod

Returns: Return type:NXOpen.Formboard.FormboardLayoutBuilderBranchAngle

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

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

Setter Method

Signature BranchAngleMethod

Parameters:branchAngle (NXOpen.Formboard.FormboardLayoutBuilderBranchAngle) –

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

BranchShapeType

FormboardLayoutBuilder.BranchShapeType

Returns or sets the branch shape type.

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

Getter Method

Signature BranchShapeType

Returns: Return type:NXOpen.Formboard.FormboardLayoutBuilderBranchShape

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

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

Setter Method

Signature BranchShapeType

Parameters:branchShape (NXOpen.Formboard.FormboardLayoutBuilderBranchShape) –

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

LengthOptions

FormboardLayoutBuilder.LengthOptions

Returns the length options for the layout operation.

The length options only have any effect if this is the first time that the Formboard geometry is being created in the drawing.

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

Getter Method

Signature LengthOptions

Returns: Return type:NXOpen.Formboard.LayoutLengthOptions

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

MainRunEndSelection

FormboardLayoutBuilder.MainRunEndSelection

Returns the end of the main run.

Contains the ending control point that defines the main run of the Formboard if the NXOpen.Formboard.FormboardLayoutBuilderMainRunType is NXOpen.Formboard.FormboardLayoutBuilderMainRunType.UserSelection.

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

Getter Method

Signature MainRunEndSelection

Returns: Return type:NXOpen.Routing.SelectControlPoint

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

MainRunMethod

FormboardLayoutBuilder.MainRunMethod

Returns or sets the main run method.

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

Getter Method

Signature MainRunMethod

Returns: Return type:NXOpen.Formboard.FormboardLayoutBuilderMainRunType

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

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

Setter Method

Signature MainRunMethod

Parameters:mainRunType (NXOpen.Formboard.FormboardLayoutBuilderMainRunType) –

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

MainRunOrigin

FormboardLayoutBuilder.MainRunOrigin

Returns or sets the main run origin.

The location in modeling space of the start of the main run. The layout operation translates the main run such that it start RCP is located at this location.

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

Getter Method

Signature MainRunOrigin

Returns: Return type:NXOpen.Point

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

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

Setter Method

Signature MainRunOrigin

Parameters:mainRunOrigin (NXOpen.Point) –

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

MainRunStartSelection

FormboardLayoutBuilder.MainRunStartSelection

Returns the start of the main run.

Contains the starting control point that defines the main run of the Formboard if the NXOpen.Formboard.FormboardLayoutBuilderMainRunType is NXOpen.Formboard.FormboardLayoutBuilderMainRunType.UserSelection.

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

Getter Method

Signature MainRunStartSelection

Returns: Return type:NXOpen.Routing.SelectControlPoint

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

MaximumRandomAngle

FormboardLayoutBuilder.MaximumRandomAngle

Returns the maximum random angle.

Used when NXOpen.Formboard.FormboardLayoutBuilderBranchAngle is NXOpen.Formboard.FormboardLayoutBuilderBranchAngle.RandomAngles.

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

Getter Method

Signature MaximumRandomAngle

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

MinimumRandomAngle

FormboardLayoutBuilder.MinimumRandomAngle

Returns the minimum random angle.

Used when NXOpen.Formboard.FormboardLayoutBuilderBranchAngle is NXOpen.Formboard.FormboardLayoutBuilderBranchAngle.RandomAngles.

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

Getter Method

Signature MinimumRandomAngle

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

PrimaryStandardAngle

FormboardLayoutBuilder.PrimaryStandardAngle

Returns the primary standard angle.

The layout algorithm snaps the angle of the branch to a multiple of this angle. Only used when the NXOpen.Formboard.FormboardLayoutBuilder.BranchAngleMethod() is NXOpen.Formboard.FormboardLayoutBuilderBranchAngle.StandardAngles.

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

Getter Method

Signature PrimaryStandardAngle

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

ReverseMainRun

FormboardLayoutBuilder.ReverseMainRun

Returns or sets the flag that determines whether the main run is “reversed” or not.

If true then the direction and order of the main run path is reversed. The end of the main run becomes the start and vice-versa. The list of path segments is not modified or re-ordered, only the order in which the path segments is evaluated when laying out the geometry.

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

Getter Method

Signature ReverseMainRun

Returns: Return type:bool

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

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

Setter Method

Signature ReverseMainRun

Parameters:reverseMainRun (bool) –

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

SecondaryStandardAngle

FormboardLayoutBuilder.SecondaryStandardAngle

Returns the secondary standard angle.

The layout algorithm snaps the angle of the branch to a multiple of this angle when all multiples of the primary angle have been used.

Only used when the NXOpen.Formboard.FormboardLayoutBuilderBranchAngle is NXOpen.Formboard.FormboardLayoutBuilderBranchAngle.StandardAngles.

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

Getter Method

Signature SecondaryStandardAngle

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

TertiaryStandardAngle

FormboardLayoutBuilder.TertiaryStandardAngle

Returns the tertiary standard angle.

The layout algorithm snaps the angle of the branch to a multiple of this angle when all multiples of the primary and secondary angles have been used.

Only used when the NXOpen.Formboard.FormboardLayoutBuilderBranchAngle is NXOpen.Formboard.FormboardLayoutBuilderBranchAngle.StandardAngles.

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

Getter Method

Signature TertiaryStandardAngle

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

Method Detail

CreateDefaultGeometry

FormboardLayoutBuilder.CreateDefaultGeometry

Creates the initial set of formboard geometry using the current default values stored in the builder.

This geometry is necessary for the UI to allow the user to see and select formboard geometry, for example to define a Main Run. Does nothing if the work part already contains formboard geometry.

Signature CreateDefaultGeometry()

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

TranslateToNewOrigin

FormboardLayoutBuilder.TranslateToNewOrigin

Translates the formboard geometry so that it matches the new main run origin, this is a more lightweight operation than the full UpdateLayout operation.

The assumption here is that the only change to the builder is with the main run origin.

Signature TranslateToNewOrigin()

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

UpdateLayout

FormboardLayoutBuilder.UpdateLayout

Updates the orientation and placement of the formboard geometry to match the current set of layout options stored within the builder.

Signature UpdateLayout()

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

Validate

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