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

Builder for flip component operation used in formboard. More...

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

List of all members.

Public Types

enum  AxisType { AxisTypePathLocations, AxisTypeCustom }
 Enum for the selection of axis type for flipping formboard component. More...

Public Member Functions

NXOpen::Formboard::FlipComponentBuilder::AxisType AxisTypeEnum ()
 Returns the user selected Formboard::FlipComponentBuilder::AxisType method
Created in NX7.5.0.
NXOpen::SelectNXObjectCompSel ()
 Returns the formboard component selected by user for flipping operation
Created in NX7.5.0.
std::vector< NXOpen::NXObject * > CreateDatumAxis ()
 Creates datums axis at locations where selected formboard component is connected to path.
NXOpen::AxisCustomAxis ()
 Returns the custom axis which is created when Formboard::FlipComponentBuilder::AxisType is Formboard::FlipComponentBuilder::AxisTypeCustom.
void FlipComponent ()
 Flips the selected formboard component by rotation angle about selected axis.
void InitializeFromComponent ()
 Initializes or resets ( start or stop ) drag operation based on the component selected for flipping operation.
NXOpen::SelectNXObjectPathAxisSel ()
 Returns the axis selected by user about which selected formboard component will be flipped.
void SetAxisTypeEnum (NXOpen::Formboard::FlipComponentBuilder::AxisType axisTypeEnum)
 Sets the user selected Formboard::FlipComponentBuilder::AxisType method
Created in NX7.5.0.
void SetCustomAxis (NXOpen::Axis *customAxis)
 Sets the custom axis which is created when Formboard::FlipComponentBuilder::AxisType is Formboard::FlipComponentBuilder::AxisTypeCustom.
void SetRotationAngle (double angle)
 Set the angle to rotate the component.
void StartDrag ()
 Starts the drag operation of selected object.
void StopDrag ()
 Stop the drag operation of selected object.

Detailed Description

Builder for flip component operation used in formboard.

Allows user to flip the component by 180 degrees about an axis which is orthogonal to Z axis so that after flipping , the component lies in XY plane.
To create a new instance of this class, use Formboard::FormboardManager::CreateFlipComponentBuilder
Default values.

Property Value

AxisTypeEnum

PathLocations


Created in NX7.5.0.


Member Enumeration Documentation

Enum for the selection of axis type for flipping formboard component.

Enumerator:
AxisTypePathLocations 

Flip component by path locations.

AxisTypeCustom 

Flip component by user defined custom axis.


Member Function Documentation

Returns the user selected Formboard::FlipComponentBuilder::AxisType method
Created in NX7.5.0.



License requirements : None

Returns the formboard component selected by user for flipping operation
Created in NX7.5.0.



License requirements : None

Creates datums axis at locations where selected formboard component is connected to path.

Returns:

Created in NX4.0.0.

License requirements : None

Returns the custom axis which is created when Formboard::FlipComponentBuilder::AxisType is Formboard::FlipComponentBuilder::AxisTypeCustom.


Created in NX7.5.0.

License requirements : None

Flips the selected formboard component by rotation angle about selected axis.


Created in NX7.5.0.

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

Initializes or resets ( start or stop ) drag operation based on the component selected for flipping operation.


Created in NX7.5.0.

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

Returns the axis selected by user about which selected formboard component will be flipped.


Created in NX7.5.0.

License requirements : None

Sets the user selected Formboard::FlipComponentBuilder::AxisType method
Created in NX7.5.0.



License requirements : None

Parameters:
axisTypeEnumaxistypeenum

Sets the custom axis which is created when Formboard::FlipComponentBuilder::AxisType is Formboard::FlipComponentBuilder::AxisTypeCustom.


Created in NX7.5.0.

License requirements : None

Parameters:
customAxiscustomaxis

Set the angle to rotate the component.


Created in NX7.5.3.

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

Parameters:
angleRotation angle

Starts the drag operation of selected object.

Does nothing if drag has already been started.


Created in NX7.5.0.

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

Stop the drag operation of selected object.

Does nothing if drag has not been started.


Created in NX7.5.0.

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


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