Builder for "Orient Branch" operation used in formboard. More...
Public Types | |
| enum | BranchAngleMethod { AnglefromReferenceVector, Angle, AlignAxisToVector, TwoPoints } |
| Enum to define the type of method to orient branch. More... | |
Public Member Functions | |
| unsafe void | UpdateRotationAngle (double angle) |
| Rotates the branch by an appropriate rotation and transformation which depends on the NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod selected by user. More... | |
| unsafe void | StartDrag () |
| Starts the drag operation of selected object. More... | |
| unsafe void | StopDrag () |
| Stop the drag operation of selected object. More... | |
| unsafe void | InitializeFromSegment () |
| Initializes or resets ( start or stop ) drag operation based on the input branch segment. More... | |
| unsafe void | SetBranchSeedObject (NXOpen.Routing.ISegment segmentTag) |
| Sets the selected branch NXOpen.Routing.ISegment when a branch is selected by branch method by Routing Object Collector. More... | |
| unsafe void | 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. 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... | |
Detailed Description
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 |
Created in NX7.5.0
Member Enumeration Documentation
Enum to define the type of method to orient branch.
Member Function Documentation
| unsafe void NXOpen.Formboard.OrientBranchBuilder.InitializeFromSegment | ( | ) |
Initializes or resets ( start or stop ) drag operation based on the input branch segment.
Created in NX7.5.0
Deprecated in NX9.0.1. This method is no longer required.
License requirements: routing_harness ("Routing Harness")
| unsafe void NXOpen.Formboard.OrientBranchBuilder.SetBranchSeedObject | ( | NXOpen.Routing.ISegment | segmentTag | ) |
Sets the selected branch NXOpen.Routing.ISegment when a branch is selected by branch method by Routing Object Collector.
Created in NX7.5.0
License requirements: routing_harness ("Routing Harness")
- Parameters
-
segmentTag selected seed object
| unsafe void NXOpen.Formboard.OrientBranchBuilder.StartDrag | ( | ) |
Starts the drag operation of selected object.
Does nothing if drag has already been started.
Created in NX7.5.0
Deprecated in NX9.0.1. This method is no longer required.
License requirements: routing_harness ("Routing Harness")
| unsafe void NXOpen.Formboard.OrientBranchBuilder.StopDrag | ( | ) |
Stop the drag operation of selected object.
Does nothing if drag has not been started.
Created in NX7.5.0
Deprecated in NX9.0.1. This method is no longer required.
License requirements: routing_harness ("Routing Harness")
| unsafe void NXOpen.Formboard.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.
Created in NX7.5.3
Deprecated in NX7.5.3. This method is no longer relevant and calls to this can be safely removed.
License requirements: routing_harness ("Routing Harness")
| unsafe void NXOpen.Formboard.OrientBranchBuilder.UpdateRotationAngle | ( | double | angle | ) |
Rotates the branch by an appropriate rotation and transformation which depends on the NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod selected by user.
Created in NX7.5.0
Deprecated in NX9.0.1. This method is no longer required.
License requirements: routing_harness ("Routing Harness")
- Parameters
-
angle angle for rotation
Property Documentation
|
getset |
Returns or sets the user selected NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod
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")
|
getset |
Returns or sets the user selected from point when NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod is NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod.TwoPoints .
Created in NX7.5.0
Deprecated in NX8.5.0. This NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod.TwoPoints is no longer supported.
License requirements to get this property: routing_harness ("Routing Harness")
License requirements to set this property: routing_harness ("Routing Harness")
|
getset |
Returns or sets the user selected from vector when NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod is NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod.AlignAxisToVector .
Created in NX7.5.0
Deprecated in NX8.5.0. This builder attribute is no longer required.
License requirements to get this property: routing_harness ("Routing Harness")
License requirements to set this property: routing_harness ("Routing Harness")
|
getset |
Returns or sets the user selected reference vector when NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod is NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod.AnglefromReferenceVector .
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")
|
get |
Returns the angle for the rotation of branch when NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod is NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod.AnglefromReferenceVector .
Created in NX7.5.0
License requirements: routing_harness ("Routing Harness")
|
get |
Returns the angle for the rotation of branch when NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod is NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod.Angle .
Created in NX7.5.0
License requirements: routing_harness ("Routing Harness")
|
get |
Returns the user selected branch NXOpen.Routing.ISegment for rotation.
Created in NX7.5.0
License requirements: routing_harness ("Routing Harness")
|
getset |
Returns or sets the user selected to point when NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod is NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod.TwoPoints .
Created in NX7.5.0
Deprecated in NX8.5.0. This NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod.TwoPoints is no longer supported.
License requirements to get this property: routing_harness ("Routing Harness")
License requirements to set this property: routing_harness ("Routing Harness")
|
getset |
Returns or sets the user selected to vector when NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod is NXOpen.Formboard.OrientBranchBuilder.BranchAngleMethod.AlignAxisToVector .
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")
The documentation for this class was generated from the following file:
- dotnet_pool/Formboard_OrientBranchBuilder.cs