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

Builder for "Orient Branch" operation used in formboard. More...

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

List of all members.

Public Types

enum  BranchAngleMethod { BranchAngleMethodAngle, BranchAngleMethodTwoPoints, BranchAngleMethodAlignAxisToVector, BranchAngleMethodAnglefromReferenceVector }
 Enum to define the type of method to orient branch. More...

Public Member Functions

NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod BranchAngleType ()
 Returns the user selected Formboard::OrientBranchBuilder::BranchAngleMethod
Created in NX7.5.0.
NXOpen::PointFromPoint ()
 Returns the user selected from point when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints .
NXOpen::DirectionFromVector ()
 Returns the user selected from vector when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAlignAxisToVector .
void InitializeFromSegment ()
 Initializes or resets ( start or stop ) drag operation based on the input branch segment.
NXOpen::DirectionReferenceVector ()
 Returns the user selected reference vector when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAnglefromReferenceVector .
NXOpen::ExpressionRefRotationAngle ()
 Returns the angle for the rotation of branch when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAnglefromReferenceVector .
NXOpen::ExpressionRotationAngle ()
 Returns the angle for the rotation of branch when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAngle .
NXOpen::Routing::RouteObjectCollectorSelectBranch ()
 Returns the user selected branch Routing::ISegment for rotation.
void SetBranchAngleType (NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod branchAngleType)
 Sets the user selected Formboard::OrientBranchBuilder::BranchAngleMethod
Created in NX7.5.0.
void SetBranchSeedObject (NXOpen::Routing::ISegment *segmentTag)
 Sets the selected branch Routing::ISegment when a branch is selected by branch method by Routing Object Collector.
void SetFromPoint (NXOpen::Point *fromPoint)
 Sets the user selected from point when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints .
void SetFromVector (NXOpen::Direction *fromVector)
 Sets the user selected from vector when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAlignAxisToVector .
void SetReferenceVector (NXOpen::Direction *referenceVector)
 Sets the user selected reference vector when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAnglefromReferenceVector .
void SetToPoint (NXOpen::Point *toPoint)
 Sets the user selected to point when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints .
void SetToVector (NXOpen::Direction *toVector)
 Sets the user selected to vector when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAlignAxisToVector .
void StartDrag ()
 Starts the drag operation of selected object.
void StopDrag ()
 Stop the drag operation of selected object.
NXOpen::PointToPoint ()
 Returns the user selected to point when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints .
NXOpen::DirectionToVector ()
 Returns the user selected to vector when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAlignAxisToVector .
void UnSuppressConstraints ()
 Suppress the Positioning::Constraint associated with selected branch Routing::ISegment when a branch is selected by branch method by Routing Object Collector.
void UpdateRotationAngle (double angle)
 Rotates the branch by an appropriate rotation and transformation which depends on the Formboard::OrientBranchBuilder::BranchAngleMethod selected by user.

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 Formboard::FormboardManager::CreateOrientBranchBuilder
Default values.

Property Value

BranchAngleType

Angle

RotationAngle.Value

0


Created in NX7.5.0.


Member Enumeration Documentation

Enum to define the type of method to orient branch.

Enumerator:
BranchAngleMethodAngle 

method to rotate branch by angle

BranchAngleMethodTwoPoints 

method to rotate branch by and angle between two points

BranchAngleMethodAlignAxisToVector 

method to rotate branch by an angle between two vectors

BranchAngleMethodAnglefromReferenceVector 

method to rotate branch with respect to selected vectors


Member Function Documentation

Returns the user selected Formboard::OrientBranchBuilder::BranchAngleMethod
Created in NX7.5.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Returns the user selected from point when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Returns the user selected from vector when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAlignAxisToVector .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

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


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Returns the user selected reference vector when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAnglefromReferenceVector .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Returns the angle for the rotation of branch when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAnglefromReferenceVector .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Returns the angle for the rotation of branch when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAngle .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

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


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Sets the user selected Formboard::OrientBranchBuilder::BranchAngleMethod
Created in NX7.5.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
branchAngleTypebranchangletype

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


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
segmentTagselected seed object

Sets the user selected from point when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
fromPointfrompoint

Sets the user selected from vector when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAlignAxisToVector .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
fromVectorfromvector

Sets the user selected reference vector when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAnglefromReferenceVector .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
referenceVectorreferencevector

Sets the user selected to point when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
toPointtopoint

Sets the user selected to vector when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAlignAxisToVector .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
toVectortovector

Starts the drag operation of selected object.

Does nothing if drag has already been started.


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Stop the drag operation of selected object.

Does nothing if drag has not been started.


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Returns the user selected to point when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Returns the user selected to vector when Formboard::OrientBranchBuilder::BranchAngleMethod is Formboard::OrientBranchBuilder::BranchAngleMethodAlignAxisToVector .


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

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


Deprecated:
Deprecated in NX7.5.3.


Created in NX7.5.3.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Rotates the branch by an appropriate rotation and transformation which depends on the Formboard::OrientBranchBuilder::BranchAngleMethod selected by user.


Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Parameters:
angleangle for rotation

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