Class that performs the "layout" of Formboard geometry. More...

Inheritance diagram for NXOpen.Formboard.FormboardLayoutBuilder:

Public Types
enum	BranchAngle { AsDesigned, StandardAngles, MaximumAngles, RandomAngles }
	Methods for determining which angles to apply at each branch of the Formboard. More...

enum	BranchShape { Straight, Angled }
	Shape option for the branches. More...

enum	MainRunType { Longest, Thickest, UserSelection }
	Selection method for the set of segments that define the main run of the formboard geometry. More...

Public Member Functions
unsafe void	CreateDefaultGeometry ()
	Creates the initial set of formboard geometry using the current default values stored in the builder. More...

unsafe void	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. More...

unsafe void	UpdateLayout ()
	Updates the orientation and placement of the formboard geometry to match the current set of layout options stored within the builder. More...

Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...

unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Formboard.FormboardLayoutBuilder.BranchAngle	BranchAngleMethod `[get, set]`
	Returns or sets the branch angle type. More...

unsafe NXOpen.Formboard.FormboardLayoutBuilder.BranchShape	BranchShapeType `[get, set]`
	Returns or sets the branch shape type. More...

unsafe NXOpen.Formboard.LayoutLengthOptions	LengthOptions `[get]`
	Returns the length options for the layout operation. More...

unsafe NXOpen.Routing.SelectControlPoint	MainRunEndSelection `[get]`
	Returns the end of the main run. More...

unsafe NXOpen.Formboard.FormboardLayoutBuilder.MainRunType	MainRunMethod `[get, set]`
	Returns or sets the main run method. More...

unsafe NXOpen.Point	MainRunOrigin `[get, set]`
	Returns or sets the main run origin. More...

unsafe NXOpen.Routing.SelectControlPoint	MainRunStartSelection `[get]`
	Returns the start of the main run. More...

unsafe NXOpen.Expression	MaximumRandomAngle `[get]`
	Returns the maximum random angle. More...

unsafe NXOpen.Expression	MinimumRandomAngle `[get]`
	Returns the minimum random angle. More...

unsafe NXOpen.Expression	PrimaryStandardAngle `[get]`
	Returns the primary standard angle. More...

unsafe bool	ReverseMainRun `[get, set]`
	Returns or sets the flag that determines whether the main run is "reversed" or not. More...

unsafe NXOpen.Expression	SecondaryStandardAngle `[get]`
	Returns the secondary standard angle. More...

unsafe NXOpen.Expression	TertiaryStandardAngle `[get]`
	Returns the tertiary standard angle. More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

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

Created in NX7.5.0

Member Enumeration Documentation

enum NXOpen.Formboard.FormboardLayoutBuilder.BranchAngle

Methods for determining which angles to apply at each branch of the Formboard.

Enumerator
AsDesigned	Use the angle equal to the 3D angle of the branch in the 3D harness.
StandardAngles	Apply a standard angle to the branch, the level of the branch determines which angle to apply.
MaximumAngles	Apply the largest possible angle values at every branch to force the harness to spread out.
RandomAngles	Randomly choose an angle for each branch.

enum NXOpen.Formboard.FormboardLayoutBuilder.BranchShape

Shape option for the branches.

Enumerator
Straight	Each branch forms a straight line.
Angled	Branch becomes angled at each location that forms a new branch.

enum NXOpen.Formboard.FormboardLayoutBuilder.MainRunType

Selection method for the set of segments that define the main run of the formboard geometry.

Enumerator
Longest	Path of longest wire.
Thickest	Path of longest wire contained within the thickest bundle.
UserSelection	Manual selection of path.

Member Function Documentation

unsafe void NXOpen.Formboard.FormboardLayoutBuilder.CreateDefaultGeometry ( )

inline

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.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

unsafe void NXOpen.Formboard.FormboardLayoutBuilder.TranslateToNewOrigin ( )

inline

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.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

unsafe void NXOpen.Formboard.FormboardLayoutBuilder.UpdateLayout ( )

inline

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

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

Property Documentation

unsafe NXOpen.Formboard.FormboardLayoutBuilder.BranchAngle NXOpen.Formboard.FormboardLayoutBuilder.BranchAngleMethod

getset

Returns or sets the branch angle type.

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

Created in NX7.5.0

License requirements to get this property: routing_harness ("Routing Harness")

License requirements to set this property: routing_harness ("Routing Harness")

unsafe NXOpen.Formboard.FormboardLayoutBuilder.BranchShape NXOpen.Formboard.FormboardLayoutBuilder.BranchShapeType

getset

Returns or sets the branch shape type.

Created in NX7.5.0

License requirements to get this property: routing_harness ("Routing Harness")

License requirements to set this property: routing_harness ("Routing Harness")

unsafe NXOpen.Formboard.LayoutLengthOptions NXOpen.Formboard.FormboardLayoutBuilder.LengthOptions

get

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.

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

unsafe NXOpen.Routing.SelectControlPoint NXOpen.Formboard.FormboardLayoutBuilder.MainRunEndSelection

get

Returns the end of the main run.

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

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

unsafe NXOpen.Formboard.FormboardLayoutBuilder.MainRunType NXOpen.Formboard.FormboardLayoutBuilder.MainRunMethod

getset

Returns or sets the main run method.

Created in NX7.5.0

License requirements to get this property: routing_harness ("Routing Harness")

License requirements to set this property: routing_harness ("Routing Harness")

unsafe NXOpen.Point NXOpen.Formboard.FormboardLayoutBuilder.MainRunOrigin

getset

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.

Created in NX7.5.0

License requirements to get this property: routing_harness ("Routing Harness")

License requirements to set this property: routing_harness ("Routing Harness")

unsafe NXOpen.Routing.SelectControlPoint NXOpen.Formboard.FormboardLayoutBuilder.MainRunStartSelection

get

Returns the start of the main run.

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

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

unsafe NXOpen.Expression NXOpen.Formboard.FormboardLayoutBuilder.MaximumRandomAngle

get

Returns the maximum random angle.

Used when NXOpen.Formboard.FormboardLayoutBuilder.BranchAngle is NXOpen.Formboard.FormboardLayoutBuilder.BranchAngle.RandomAngles .

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

unsafe NXOpen.Expression NXOpen.Formboard.FormboardLayoutBuilder.MinimumRandomAngle

get

Returns the minimum random angle.

Used when NXOpen.Formboard.FormboardLayoutBuilder.BranchAngle is NXOpen.Formboard.FormboardLayoutBuilder.BranchAngle.RandomAngles .

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

unsafe NXOpen.Expression NXOpen.Formboard.FormboardLayoutBuilder.PrimaryStandardAngle

get

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

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

unsafe bool NXOpen.Formboard.FormboardLayoutBuilder.ReverseMainRun

getset

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.

Created in NX7.5.0

License requirements to get this property: routing_harness ("Routing Harness")

License requirements to set this property: routing_harness ("Routing Harness")

unsafe NXOpen.Expression NXOpen.Formboard.FormboardLayoutBuilder.SecondaryStandardAngle

get

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.FormboardLayoutBuilder.BranchAngle is NXOpen.Formboard.FormboardLayoutBuilder.BranchAngle.StandardAngles .

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

unsafe NXOpen.Expression NXOpen.Formboard.FormboardLayoutBuilder.TertiaryStandardAngle

get

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.FormboardLayoutBuilder.BranchAngle is NXOpen.Formboard.FormboardLayoutBuilder.BranchAngle.StandardAngles .

Created in NX7.5.0

License requirements: routing_harness ("Routing Harness")

The documentation for this class was generated from the following file:

Formboard_FormboardLayoutBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation