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

Inheritance diagram for NXOpen::Formboard::OrientBranchBuilder:

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

Public Member Functions
NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod	BranchAngleType ()
	Returns the user selected NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod Created in NX7.5.0. More...

NXOpen::Point *	FromPoint ()
	Returns the user selected from point when NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod is NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints . More...

NXOpen::Direction *	FromVector ()
	Returns the user selected from vector when NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod is NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodAlignAxisToVector . More...

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

NXOpen::Direction *	ReferenceVector ()
	Returns the user selected reference vector when NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod is NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodAnglefromReferenceVector . More...

NXOpen::Expression *	RefRotationAngle ()
	Returns the angle for the rotation of branch when NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod is NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodAnglefromReferenceVector . More...

NXOpen::Expression *	RotationAngle ()
	Returns the angle for the rotation of branch when NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod is NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodAngle . More...

NXOpen::Routing::RouteObjectCollector *	SelectBranch ()
	Returns the user selected branch NXOpen::Routing::ISegment for rotation. More...

void	SetBranchAngleType (NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod branchAngleType)
	Sets the user selected NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod Created in NX7.5.0. More...

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

void	SetFromPoint (NXOpen::Point *fromPoint)
	Sets the user selected from point when NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod is NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints . More...

void	SetFromVector (NXOpen::Direction *fromVector)
	Sets the user selected from vector when NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod is NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodAlignAxisToVector . More...

void	SetReferenceVector (NXOpen::Direction *referenceVector)
	Sets the user selected reference vector when NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod is NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodAnglefromReferenceVector . More...

void	SetToPoint (NXOpen::Point *toPoint)
	Sets the user selected to point when NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod is NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints . More...

void	SetToVector (NXOpen::Direction *toVector)
	Sets the user selected to vector when NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod is NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodAlignAxisToVector . More...

void	StartDrag ()
	Starts the drag operation of selected object. More...

void	StopDrag ()
	Stop the drag operation of selected object. More...

NXOpen::Point *	ToPoint ()
	Returns the user selected to point when NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod is NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints . More...

NXOpen::Direction *	ToVector ()
	Returns the user selected to vector when NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod is NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodAlignAxisToVector . More...

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

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

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

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

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

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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 NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod

Enum to define the type of method to orient branch.

Enumerator
BranchAngleMethodAnglefromReferenceVector	method to rotate branch with respect to selected vectors
BranchAngleMethodAngle	method to rotate branch by angle
BranchAngleMethodAlignAxisToVector	method to rotate branch by an angle between two vectors
BranchAngleMethodTwoPoints	method to rotate branch by and angle between two points

Member Function Documentation

NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod NXOpen::Formboard::OrientBranchBuilder::BranchAngleType ( )

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

License requirements : routing_harness ("Routing Harness")

NXOpen::Point* NXOpen::Formboard::OrientBranchBuilder::FromPoint ( )

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

Deprecated:: Deprecated in NX8.5.0. This NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints is no longer supported.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Direction* NXOpen::Formboard::OrientBranchBuilder::FromVector ( )

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

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

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

void NXOpen::Formboard::OrientBranchBuilder::InitializeFromSegment ( )

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

Deprecated:: Deprecated in NX9.0.1. This method is no longer required.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Direction* NXOpen::Formboard::OrientBranchBuilder::ReferenceVector ( )

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

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Expression* NXOpen::Formboard::OrientBranchBuilder::RefRotationAngle ( )

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

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Expression* NXOpen::Formboard::OrientBranchBuilder::RotationAngle ( )

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

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Routing::RouteObjectCollector* NXOpen::Formboard::OrientBranchBuilder::SelectBranch ( )

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

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

void NXOpen::Formboard::OrientBranchBuilder::SetBranchAngleType ( NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethod branchAngleType )

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

License requirements : routing_harness ("Routing Harness")

Parameters

branchAngleType branchangletype

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

void NXOpen::Formboard::OrientBranchBuilder::SetFromPoint ( NXOpen::Point * fromPoint )

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

Deprecated:: Deprecated in NX8.5.0. This NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints is no longer supported.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

fromPoint frompoint

void NXOpen::Formboard::OrientBranchBuilder::SetFromVector ( NXOpen::Direction * fromVector )

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

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

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

fromVector fromvector

void NXOpen::Formboard::OrientBranchBuilder::SetReferenceVector ( NXOpen::Direction * referenceVector )

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

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

referenceVector referencevector

void NXOpen::Formboard::OrientBranchBuilder::SetToPoint ( NXOpen::Point * toPoint )

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

Deprecated:: Deprecated in NX8.5.0. This NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints is no longer supported.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

toPoint topoint

void NXOpen::Formboard::OrientBranchBuilder::SetToVector ( NXOpen::Direction * toVector )

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

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

toVector tovector

void NXOpen::Formboard::OrientBranchBuilder::StartDrag ( )

Starts the drag operation of selected object.

Does nothing if drag has already been started.

Deprecated:: Deprecated in NX9.0.1. This method is no longer required.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

void NXOpen::Formboard::OrientBranchBuilder::StopDrag ( )

Stop the drag operation of selected object.

Does nothing if drag has not been started.

Deprecated:: Deprecated in NX9.0.1. This method is no longer required.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Point* NXOpen::Formboard::OrientBranchBuilder::ToPoint ( )

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

Deprecated:: Deprecated in NX8.5.0. This NXOpen::Formboard::OrientBranchBuilder::BranchAngleMethodTwoPoints is no longer supported.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

NXOpen::Direction* NXOpen::Formboard::OrientBranchBuilder::ToVector ( )

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

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

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.

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

Created in NX7.5.3.

License requirements : routing_harness ("Routing Harness")

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.

Deprecated:: Deprecated in NX9.0.1. This method is no longer required.

Created in NX7.5.0.

License requirements : routing_harness ("Routing Harness")

Parameters

angle angle for rotation

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

Formboard_OrientBranchBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation