NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Formboard::FormboardLayoutBuilder Class Reference

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

Inheritance diagram for NXOpen::Formboard::FormboardLayoutBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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::LayoutLengthOptionsLengthOptions ()
 Returns the length options for the layout operation.
NXOpen::Routing::SelectControlPointMainRunEndSelection ()
 Returns the end of the main run.
NXOpen::Formboard::FormboardLayoutBuilder::MainRunType MainRunMethod ()
 Returns the main run method.
NXOpen::PointMainRunOrigin ()
 Returns the main run origin.
NXOpen::Routing::SelectControlPointMainRunStartSelection ()
 Returns the start of the main run.
NXOpen::ExpressionMaximumRandomAngle ()
 Returns the maximum random angle.
NXOpen::ExpressionMinimumRandomAngle ()
 Returns the minimum random angle.
NXOpen::ExpressionPrimaryStandardAngle ()
 Returns the primary standard angle.
bool ReverseMainRun ()
 Returns the flag that determines whether the main run is "reversed" or not.
NXOpen::ExpressionSecondaryStandardAngle ()
 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::ExpressionTertiaryStandardAngle ()
 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.

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

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.

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.

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

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 : None

Returns the branch shape type.


Created in NX7.5.0.

License requirements : None

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 : None

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 : None

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 : None

Returns the main run method.


Created in NX7.5.0.

License requirements : None

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 : None

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 : None

Returns the maximum random angle.

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


Created in NX7.5.0.

License requirements : None

Returns the minimum random angle.

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


Created in NX7.5.0.

License requirements : None

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 : None

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 : None

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 : None

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 : None

Parameters:
branchAnglebranchangle

Sets the branch shape type.


Created in NX7.5.0.

License requirements : None

Parameters:
branchShapebranchshape

Sets the main run method.


Created in NX7.5.0.

License requirements : None

Parameters:
mainRunTypemainruntype

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 : None

Parameters:
mainRunOriginmainrunorigin

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 : None

Parameters:
reverseMainRunreversemainrun

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 : None

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 : None

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 : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.