OrientBranchBuilder Class

class NXOpen.Formboard.OrientBranchBuilder

Bases: NXOpen.Builder

Builder for “Orient Branch” operation used in formboard.

Allows user to orient the branch by different methods.

To create a new instance of this class, use NXOpen.Formboard.FormboardManager.CreateOrientBranchBuilder()

Default values.

Property	Value
BranchAngleType	AnglefromReferenceVector
RotationAngle.Value	0

New in version NX7.5.0.

Properties

Property	Description
BranchAngleType	Returns or sets the user selected NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod
FromPoint	Returns or sets the user selected from point when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.TwoPoints < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.
FromVector	Returns or sets the user selected from vector when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.AlignAxisToVector < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.
RefRotationAngle	Returns the angle for the rotation of branch when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.AnglefromReferenceVector < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.
ReferenceVector	Returns or sets the user selected reference vector when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.AnglefromReferenceVector < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.
RotationAngle	Returns the angle for the rotation of branch when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.Angle < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.
SelectBranch	Returns the user selected branch NXOpen.Routing.ISegment for rotation.
Tag	Returns the Tag for this object.
ToPoint	Returns or sets the user selected to point when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.TwoPoints < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.
ToVector	Returns or sets the user selected to vector when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.AlignAxisToVector < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.

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.
InitializeFromSegment	Initializes or resets ( start or stop ) drag operation based on the input branch segment.
SetBranchSeedObject	Sets the selected branch NXOpen.Routing.ISegment when a branch is selected by branch method by Routing Object Collector.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
StartDrag	Starts the drag operation of selected object.
StopDrag	Stop the drag operation of selected object.
UnSuppressConstraints	Suppress the NXOpen.Positioning.Constraint associated with selected branch NXOpen.Routing.ISegment when a branch is selected by branch method by Routing Object Collector.
UpdateRotationAngle	Rotates the branch by an appropriate rotation and transformation which depends on the NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod selected by user.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

OrientBranchBuilderBranchAngleMethod Enumeration

Enum to define the type of method to orient branch.

Property Detail

BranchAngleType

OrientBranchBuilder.BranchAngleType

Returns or sets the user selected NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod

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

Getter Method

Signature BranchAngleType

Returns: Return type:NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

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

Setter Method

Signature BranchAngleType

Parameters:branchAngleType (NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod) –

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

FromPoint

OrientBranchBuilder.FromPoint

Returns or sets the user selected from point when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.TwoPoints < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.

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

Getter Method

Signature FromPoint

Returns: Return type:NXOpen.Point

New in version NX7.5.0.

Deprecated since version NX8.5.0: This :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.TwoPoints < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>` is no longer supported.

License requirements: routing_harness (“Routing Harness”)

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

Setter Method

Signature FromPoint

Parameters:fromPoint (NXOpen.Point) –

New in version NX7.5.0.

Deprecated since version NX8.5.0: This :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.TwoPoints < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>` is no longer supported.

License requirements: routing_harness (“Routing Harness”)

FromVector

OrientBranchBuilder.FromVector

Returns or sets the user selected from vector when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.AlignAxisToVector < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.

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

Getter Method

Signature FromVector

Returns: Return type:NXOpen.Direction

New in version NX7.5.0.

Deprecated since version NX8.5.0: This builder attribute is no longer required.

License requirements: routing_harness (“Routing Harness”)

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

Setter Method

Signature FromVector

Parameters:fromVector (NXOpen.Direction) –

New in version NX7.5.0.

Deprecated since version NX8.5.0: This builder attribute is no longer required.

License requirements: routing_harness (“Routing Harness”)

RefRotationAngle

OrientBranchBuilder.RefRotationAngle

Returns the angle for the rotation of branch when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.AnglefromReferenceVector < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.

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

Getter Method

Signature RefRotationAngle

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

ReferenceVector

OrientBranchBuilder.ReferenceVector

Returns or sets the user selected reference vector when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.AnglefromReferenceVector < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.

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

Getter Method

Signature ReferenceVector

Returns: Return type:NXOpen.Direction

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

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

Setter Method

Signature ReferenceVector

Parameters:referenceVector (NXOpen.Direction) –

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

RotationAngle

OrientBranchBuilder.RotationAngle

Returns the angle for the rotation of branch when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.Angle < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.

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

Getter Method

Signature RotationAngle

Returns: Return type:NXOpen.Expression

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

SelectBranch

OrientBranchBuilder.SelectBranch

Returns the user selected branch NXOpen.Routing.ISegment for rotation.

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

Getter Method

Signature SelectBranch

Returns: Return type:NXOpen.Routing.RouteObjectCollector

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

ToPoint

OrientBranchBuilder.ToPoint

Returns or sets the user selected to point when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.TwoPoints < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.

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

Getter Method

Signature ToPoint

Returns: Return type:NXOpen.Point

New in version NX7.5.0.

Deprecated since version NX8.5.0: This :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.TwoPoints < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>` is no longer supported.

License requirements: routing_harness (“Routing Harness”)

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

Setter Method

Signature ToPoint

Parameters:toPoint (NXOpen.Point) –

New in version NX7.5.0.

Deprecated since version NX8.5.0: This :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.TwoPoints < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>` is no longer supported.

License requirements: routing_harness (“Routing Harness”)

ToVector

OrientBranchBuilder.ToVector

Returns or sets the user selected to vector when NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod is :py:class:` NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod.AlignAxisToVector < NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod>`.

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

Getter Method

Signature ToVector

Returns: Return type:NXOpen.Direction

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

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

Setter Method

Signature ToVector

Parameters:toVector (NXOpen.Direction) –

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

Method Detail

InitializeFromSegment

OrientBranchBuilder.InitializeFromSegment

Initializes or resets ( start or stop ) drag operation based on the input branch segment.

Signature InitializeFromSegment()

New in version NX7.5.0.

Deprecated since version NX9.0.1: This method is no longer required.

License requirements: routing_harness (“Routing Harness”)

SetBranchSeedObject

OrientBranchBuilder.SetBranchSeedObject

Sets the selected branch NXOpen.Routing.ISegment when a branch is selected by branch method by Routing Object Collector.

Signature SetBranchSeedObject(segmentTag)

Parameters:segmentTag (NXOpen.Routing.ISegment) – selected seed object

New in version NX7.5.0.

License requirements: routing_harness (“Routing Harness”)

StartDrag

OrientBranchBuilder.StartDrag

Starts the drag operation of selected object.

Does nothing if drag has already been started.

Signature StartDrag()

New in version NX7.5.0.

Deprecated since version NX9.0.1: This method is no longer required.

License requirements: routing_harness (“Routing Harness”)

StopDrag

OrientBranchBuilder.StopDrag

Stop the drag operation of selected object.

Does nothing if drag has not been started.

Signature StopDrag()

New in version NX7.5.0.

Deprecated since version NX9.0.1: This method is no longer required.

License requirements: routing_harness (“Routing Harness”)

UnSuppressConstraints

OrientBranchBuilder.UnSuppressConstraints

Suppress the NXOpen.Positioning.Constraint associated with selected branch NXOpen.Routing.ISegment when a branch is selected by branch method by Routing Object Collector.

Signature UnSuppressConstraints()

New in version NX7.5.3.

Deprecated since version NX7.5.3: This method is no longer relevant and calls to this can be safely removed.

License requirements: routing_harness (“Routing Harness”)

UpdateRotationAngle

OrientBranchBuilder.UpdateRotationAngle

Rotates the branch by an appropriate rotation and transformation which depends on the NXOpen.Formboard.OrientBranchBuilderBranchAngleMethod selected by user.

Signature UpdateRotationAngle(angle)

Parameters:angle (float) – angle for rotation

New in version NX7.5.0.

Deprecated since version NX9.0.1: This method is no longer required.

License requirements: routing_harness (“Routing Harness”)

Validate

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