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

Inheritance diagram for NXOpen::Formboard::FormboardLayoutBuilder:

Public Types
enum	BranchAngle { BranchAngleAsDesigned, BranchAngleStandardAngles, BranchAngleMaximumAngles, BranchAngleRandomAngles }
	Methods for determining which angles to apply at each branch of the Formboard. More...

enum	BranchShape { BranchShapeStraight, BranchShapeAngled }
	Shape option for the branches. More...

enum	MainRunType { MainRunTypeLongest, MainRunTypeThickest, MainRunTypeUserSelection }
	Selection method for the set of segments that define the main run of the formboard geometry. More...

Public Member Functions
NXOpen::Formboard::FormboardLayoutBuilder::BranchAngle	BranchAngleMethod ()
	Returns the branch angle type.

NXOpen::Formboard::FormboardLayoutBuilder::BranchShape	BranchShapeType ()
	Returns the branch shape type.

void	CreateDefaultGeometry ()
	Creates the initial set of formboard geometry using the current default values stored in the builder.

NXOpen::Formboard::LayoutLengthOptions *	LengthOptions ()
	Returns the length options for the layout operation.

NXOpen::Routing::SelectControlPoint *	MainRunEndSelection ()
	Returns the end of the main run.

NXOpen::Formboard::FormboardLayoutBuilder::MainRunType	MainRunMethod ()
	Returns the main run method.

NXOpen::Point *	MainRunOrigin ()
	Returns the main run origin.

NXOpen::Routing::SelectControlPoint *	MainRunStartSelection ()
	Returns the start of the main run.

NXOpen::Expression *	MaximumRandomAngle ()
	Returns the maximum random angle.

NXOpen::Expression *	MinimumRandomAngle ()
	Returns the minimum random angle.

NXOpen::Expression *	PrimaryStandardAngle ()
	Returns the primary standard angle.

bool	ReverseMainRun ()
	Returns the flag that determines whether the main run is "reversed" or not.

NXOpen::Expression *	SecondaryStandardAngle ()
	Returns the secondary standard angle.

void	SetBranchAngleMethod (NXOpen::Formboard::FormboardLayoutBuilder::BranchAngle branchAngle)
	Sets the branch angle type.

void	SetBranchShapeType (NXOpen::Formboard::FormboardLayoutBuilder::BranchShape branchShape)
	Sets the branch shape type.

void	SetMainRunMethod (NXOpen::Formboard::FormboardLayoutBuilder::MainRunType mainRunType)
	Sets the main run method.

void	SetMainRunOrigin (NXOpen::Point *mainRunOrigin)
	Sets the main run origin.

void	SetReverseMainRun (bool reverseMainRun)
	Sets the flag that determines whether the main run is "reversed" or not.

NXOpen::Expression *	TertiaryStandardAngle ()
	Returns the tertiary standard angle.

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.

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

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

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

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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 Formboard::FormboardManager::StoreHarnessesToFlatten method.
To create a new instance of this class, use 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:

BranchAngleAsDesigned	Use the angle equal to the 3D angle of the branch in the 3D harness.
BranchAngleStandardAngles	Apply a standard angle to the branch, the level of the branch determines which angle to apply.
BranchAngleMaximumAngles	Apply the largest possible angle values at every branch to force the harness to spread out.
BranchAngleRandomAngles	Randomly choose an angle for each branch.

enum NXOpen::Formboard::FormboardLayoutBuilder::BranchShape

Shape option for the branches.

Enumerator:

BranchShapeStraight	Each branch forms a straight line.
BranchShapeAngled	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:

MainRunTypeLongest	Path of longest wire.
MainRunTypeThickest	Path of longest wire contained within the thickest bundle.
MainRunTypeUserSelection	Manual selection of path.

Member Function Documentation

NXOpen::Formboard::FormboardLayoutBuilder::BranchAngle NXOpen::Formboard::FormboardLayoutBuilder::BranchAngleMethod ( )

Returns 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 : routing_harness ("Routing Harness")

NXOpen::Formboard::FormboardLayoutBuilder::BranchShape NXOpen::Formboard::FormboardLayoutBuilder::BranchShapeType ( )

Returns the branch shape type.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

void NXOpen::Formboard::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.
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Formboard::LayoutLengthOptions* NXOpen::Formboard::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.
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Routing::SelectControlPoint* NXOpen::Formboard::FormboardLayoutBuilder::MainRunEndSelection ( )

Returns the end of the main run.

Contains the ending control point that defines the main run of the Formboard if the Formboard::FormboardLayoutBuilder::MainRunType is Formboard::FormboardLayoutBuilder::MainRunTypeUserSelection .
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Formboard::FormboardLayoutBuilder::MainRunType NXOpen::Formboard::FormboardLayoutBuilder::MainRunMethod ( )

Returns the main run method.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Point* NXOpen::Formboard::FormboardLayoutBuilder::MainRunOrigin ( )

Returns 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 : routing_harness ("Routing Harness")

NXOpen::Routing::SelectControlPoint* NXOpen::Formboard::FormboardLayoutBuilder::MainRunStartSelection ( )

Returns the start of the main run.

Contains the starting control point that defines the main run of the Formboard if the Formboard::FormboardLayoutBuilder::MainRunType is Formboard::FormboardLayoutBuilder::MainRunTypeUserSelection .
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Expression* NXOpen::Formboard::FormboardLayoutBuilder::MaximumRandomAngle ( )

Returns the maximum random angle.

Used when Formboard::FormboardLayoutBuilder::BranchAngle is Formboard::FormboardLayoutBuilder::BranchAngleRandomAngles .

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Expression* NXOpen::Formboard::FormboardLayoutBuilder::MinimumRandomAngle ( )

Returns the minimum random angle.

Used when Formboard::FormboardLayoutBuilder::BranchAngle is Formboard::FormboardLayoutBuilder::BranchAngleRandomAngles .

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Expression* NXOpen::Formboard::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 Formboard::FormboardLayoutBuilder::BranchAngleMethod is Formboard::FormboardLayoutBuilder::BranchAngleStandardAngles .
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

bool NXOpen::Formboard::FormboardLayoutBuilder::ReverseMainRun ( )

Returns 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 : routing_harness ("Routing Harness")

NXOpen::Expression* NXOpen::Formboard::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 Formboard::FormboardLayoutBuilder::BranchAngle is Formboard::FormboardLayoutBuilder::BranchAngleStandardAngles .
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

void NXOpen::Formboard::FormboardLayoutBuilder::SetBranchAngleMethod ( NXOpen::Formboard::FormboardLayoutBuilder::BranchAngle branchAngle )

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 : routing_harness ("Routing Harness")

Parameters

branchAngle branchangle

void NXOpen::Formboard::FormboardLayoutBuilder::SetBranchShapeType ( NXOpen::Formboard::FormboardLayoutBuilder::BranchShape branchShape )

Sets the branch shape type.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

branchShape branchshape

void NXOpen::Formboard::FormboardLayoutBuilder::SetMainRunMethod ( NXOpen::Formboard::FormboardLayoutBuilder::MainRunType mainRunType )

Sets the main run method.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

mainRunType mainruntype

void NXOpen::Formboard::FormboardLayoutBuilder::SetMainRunOrigin ( NXOpen::Point * mainRunOrigin )

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 : routing_harness ("Routing Harness")

Parameters

mainRunOrigin mainrunorigin

void NXOpen::Formboard::FormboardLayoutBuilder::SetReverseMainRun ( bool reverseMainRun )

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 : routing_harness ("Routing Harness")

Parameters

reverseMainRun reversemainrun

NXOpen::Expression* NXOpen::Formboard::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 Formboard::FormboardLayoutBuilder::BranchAngle is Formboard::FormboardLayoutBuilder::BranchAngleStandardAngles .
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

void NXOpen::Formboard::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.
Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

void NXOpen::Formboard::FormboardLayoutBuilder::UpdateLayout ( )

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")

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

Formboard_FormboardLayoutBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation