NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::GeometricUtilities::ModlMotion Class Reference

Represents a GeometricUtilities::ModlMotion. More...

Inheritance diagram for NXOpen::GeometricUtilities::ModlMotion:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  Delta { DeltaReferenceAcsWorkPart, DeltaReferenceAcsDisplayPart, DeltaReferenceWcsWorkPart, DeltaReferenceWcsDisplayPart }
 Represents the options of Delta XYZ. More...
enum  Options {
  OptionsDistanceAngle, OptionsDistance, OptionsAngle, OptionsDistanceBetweenPoints,
  OptionsRadialDistance, OptionsPointToPoint, OptionsRotateByThreePoints, OptionsAlignAxisVector,
  OptionsCsysToCsys, OptionsDynamic, OptionsDeltaXyz, OptionsNone
}
 Represents the options of Motion. More...

Public Member Functions

NXOpen::AxisAlignVector ()
 Returns the axis of GeometricUtilities::ModlMotion::OptionsAlignAxisVector motion option.
NXOpen::ExpressionAngle ()
 Returns the angle of GeometricUtilities::ModlMotion::OptionsAngle motion option.
NXOpen::AxisAngularAxis ()
 Returns the angular axis of GeometricUtilities::ModlMotion::OptionsAngle motion option.
NXOpen::GeometricUtilities::ModlMotion::Delta DeltaEnum ()
 Returns the delta enum
Created in NX6.0.2.
double DeltaX ()
 Returns the delta x
Created in NX6.0.2.
NXOpen::ExpressionDeltaXc ()
 Returns the delta xc
Created in NX7.0.0.
double DeltaY ()
 Returns the delta y
Created in NX6.0.2.
NXOpen::ExpressionDeltaYc ()
 Returns the delta yc
Created in NX7.0.0.
double DeltaZ ()
 Returns the delta z
Created in NX6.0.2.
NXOpen::ExpressionDeltaZc ()
 Returns the delta zc
Created in NX7.0.0.
NXOpen::GeometricUtilities::ModlDistanceAngleDistanceAngle ()
 Returns the distance-angle of GeometricUtilities::ModlMotion::OptionsDistanceAngle motion option.
NXOpen::ExpressionDistanceBetweenPointsDistance ()
 Returns the distance of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.
NXOpen::PointDistanceBetweenPointsMeasurePoint ()
 Returns the measure point of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.
NXOpen::ExpressionDistanceBetweenPointsOriginDistance ()
 Returns the distance between origin point and face of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.
NXOpen::PointDistanceBetweenPointsOriginPoint ()
 Returns the origin point of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.
NXOpen::DirectionDistanceBetweenPointsVector ()
 Returns the direction of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.
NXOpen::ExpressionDistanceValue ()
 Returns the distance value of GeometricUtilities::ModlMotion::OptionsDistance motion option.
NXOpen::DirectionDistanceVector ()
 Returns the direction of GeometricUtilities::ModlMotion::OptionsDistance motion option.
NXOpen::PointEndPoint ()
 Returns the end point of GeometricUtilities::ModlMotion::OptionsRotateByThreePoints motion option.
NXOpen::CoordinateSystemFromCsys ()
 Returns the "from csys" of GeometricUtilities::ModlMotion::OptionsCsysToCsys motion option .
NXOpen::PointFromPoint ()
 Returns the "from point" of GeometricUtilities::ModlMotion::OptionsPointToPoint motion option.
NXOpen::Matrix3x3 ManipulatorMatrix ()
 Returns the matrix of manipulator for GeometricUtilities::ModlMotion::OptionsDynamic motion option.
NXOpen::Point3d ManipulatorOrigin ()
 Returns the origin point of manipulator for GeometricUtilities::ModlMotion::OptionsDynamic motion option.
bool MoveHandle ()
 Returns the move handle toggle of GeometricUtilities::ModlMotion::OptionsDynamic motion option.If true,moves only manipulator handle.
NXOpen::GeometricUtilities::ModlMotion::Options Option ()
 Returns the options.
NXOpen::GeometricUtilities::OrientXpressBuilderOrientXpress ()
 Returns the orientXpress.
NXOpen::AxisRadialAxis ()
 Returns the axis of GeometricUtilities::ModlMotion::OptionsRadialDistance motion option.
NXOpen::ExpressionRadialDistance ()
 Returns the distance value of GeometricUtilities::ModlMotion::OptionsRadialDistance motion option.
NXOpen::PointRadialMeasurePoint ()
 Returns the measure point of GeometricUtilities::ModlMotion::OptionsRadialDistance motion option.
NXOpen::ExpressionRadialOriginDistance ()
 Returns the distance between axis point and face of GeometricUtilities::ModlMotion::OptionsRadialDistance motion option.
void ResetMotionToThreeDimensions ()
 Reset motion to three dimensions
Created in NX6.0.0.
NXOpen::AxisRotateVector ()
 Returns the direction of GeometricUtilities::ModlMotion::OptionsRotateByThreePoints motion option.
void SetAlignVector (NXOpen::Axis *alignVector)
 Sets the axis of GeometricUtilities::ModlMotion::OptionsAlignAxisVector motion option.
void SetAngularAxis (NXOpen::Axis *angularAxis)
 Sets the angular axis of GeometricUtilities::ModlMotion::OptionsAngle motion option.
void SetDeltaEnum (NXOpen::GeometricUtilities::ModlMotion::Delta deltaEnum)
 Sets the delta enum
Created in NX6.0.2.
void SetDeltaX (double deltaX)
 Sets the delta x
Created in NX6.0.2.
void SetDeltaY (double deltaY)
 Sets the delta y
Created in NX6.0.2.
void SetDeltaZ (double deltaZ)
 Sets the delta z
Created in NX6.0.2.
void SetDependentView (NXOpen::View *view)
 Set the view for view dependent drafting objects
Created in NX7.5.0.
void SetDistanceBetweenPointsMeasurePoint (NXOpen::Point *measurePoint)
 Sets the measure point of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.
void SetDistanceBetweenPointsOriginPoint (NXOpen::Point *originPoint)
 Sets the origin point of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.
void SetDistanceBetweenPointsVector (NXOpen::Direction *vector)
 Sets the direction of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.
void SetDistanceVector (NXOpen::Direction *distanceVector)
 Sets the direction of GeometricUtilities::ModlMotion::OptionsDistance motion option.
void SetEndPoint (NXOpen::Point *endPoint)
 Sets the end point of GeometricUtilities::ModlMotion::OptionsRotateByThreePoints motion option.
void SetFromCsys (NXOpen::CoordinateSystem *fromcsys)
 Sets the "from csys" of GeometricUtilities::ModlMotion::OptionsCsysToCsys motion option .
void SetFromPoint (NXOpen::Point *fromPoint)
 Sets the "from point" of GeometricUtilities::ModlMotion::OptionsPointToPoint motion option.
void SetManipulatorMatrix (const NXOpen::Matrix3x3 &manipulatorMatrix)
 Sets the matrix of manipulator for GeometricUtilities::ModlMotion::OptionsDynamic motion option.
void SetManipulatorOrigin (const NXOpen::Point3d &manipulatorOrigin)
 Sets the origin point of manipulator for GeometricUtilities::ModlMotion::OptionsDynamic motion option.
void SetMotionToTwoDimensions (NXOpen::Plane *plane)
 Set motion to two dimensions along the given plane
Created in NX6.0.0.
void SetMoveHandle (bool moveHandle)
 Sets the move handle toggle of GeometricUtilities::ModlMotion::OptionsDynamic motion option.If true,moves only manipulator handle.
void SetOption (NXOpen::GeometricUtilities::ModlMotion::Options type)
 Sets the options.
void SetRadialAxis (NXOpen::Axis *radialAxis)
 Sets the axis of GeometricUtilities::ModlMotion::OptionsRadialDistance motion option.
void SetRadialMeasurePoint (NXOpen::Point *radialMeasuPoint)
 Sets the measure point of GeometricUtilities::ModlMotion::OptionsRadialDistance motion option.
void SetRotateVector (NXOpen::Axis *rotateVector)
 Sets the direction of GeometricUtilities::ModlMotion::OptionsRotateByThreePoints motion option.
void SetStartPoint (NXOpen::Point *startPoint)
 Sets the start point of GeometricUtilities::ModlMotion::OptionsRotateByThreePoints motion option.
void SetToCsys (NXOpen::CoordinateSystem *tocsys)
 Sets the "to csys" where object is moved for motion option GeometricUtilities::ModlMotion::OptionsCsysToCsys .
void SetToPoint (NXOpen::Point *toPoint)
 Sets the point where object is moved for motion option GeometricUtilities::ModlMotion::OptionsPointToPoint
Created in NX6.0.0.
void SetToVector (NXOpen::Direction *toVector)
 Sets the vector of GeometricUtilities::ModlMotion::OptionsAlignAxisVector motion option.
void SetUpdateOption (NXOpen::SmartObject::UpdateOption option)
 Set the update option for defining the update behavior for the object.
NXOpen::PointStartPoint ()
 Returns the start point of GeometricUtilities::ModlMotion::OptionsRotateByThreePoints motion option.
NXOpen::CoordinateSystemToCsys ()
 Returns the "to csys" where object is moved for motion option GeometricUtilities::ModlMotion::OptionsCsysToCsys .
NXOpen::PointToPoint ()
 Returns the point where object is moved for motion option GeometricUtilities::ModlMotion::OptionsPointToPoint
Created in NX6.0.0.
NXOpen::DirectionToVector ()
 Returns the vector of GeometricUtilities::ModlMotion::OptionsAlignAxisVector motion option.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

Represents a GeometricUtilities::ModlMotion.


Created in NX6.0.0.


Member Enumeration Documentation

Represents the options of Delta XYZ.

Enumerator:
DeltaReferenceAcsWorkPart 

Reference CSYS is absolute coordinate system in the work part.

DeltaReferenceAcsDisplayPart 

Reference CSYS is absolute coordinate system in the display part.

DeltaReferenceWcsWorkPart 

Reference CSYS is work coordinate system in the work part.

DeltaReferenceWcsDisplayPart 

Reference CSYS is work coordinate system in the display part.

Represents the options of Motion.

Enumerator:
OptionsDistanceAngle 

Move by Distance-Angle.

OptionsDistance 

Move by Distance.

OptionsAngle 

Move by Angle.

OptionsDistanceBetweenPoints 

Move by Distance between Points.

OptionsRadialDistance 

Move by Radial Distance.

OptionsPointToPoint 

Move by Point to Point.

OptionsRotateByThreePoints 

Move by Rotate by Three Points.

OptionsAlignAxisVector 

Move by Align Axis to Vector.

OptionsCsysToCsys 

Move by CSYS to CSYS.

OptionsDynamic 

Move by Dynamic.

OptionsDeltaXyz 

Move by delta XYZ.

OptionsNone 

No move.


Member Function Documentation

Returns the axis of GeometricUtilities::ModlMotion::OptionsAlignAxisVector motion option.


Created in NX6.0.0.

License requirements : None

Returns the angle of GeometricUtilities::ModlMotion::OptionsAngle motion option.


Created in NX6.0.0.

License requirements : None

Returns the angular axis of GeometricUtilities::ModlMotion::OptionsAngle motion option.


Created in NX6.0.0.

License requirements : None

Returns the delta enum
Created in NX6.0.2.



License requirements : None

Returns the delta x
Created in NX6.0.2.



License requirements : None

Returns the delta xc
Created in NX7.0.0.



License requirements : None

Returns the delta y
Created in NX6.0.2.



License requirements : None

Returns the delta yc
Created in NX7.0.0.



License requirements : None

Returns the delta z
Created in NX6.0.2.



License requirements : None

Returns the delta zc
Created in NX7.0.0.



License requirements : None

Returns the distance-angle of GeometricUtilities::ModlMotion::OptionsDistanceAngle motion option.


Created in NX6.0.0.

License requirements : None

Returns the distance of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.


Created in NX6.0.0.

License requirements : None

Returns the measure point of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.


Created in NX6.0.0.

License requirements : None

Returns the distance between origin point and face of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.


Created in NX6.0.0.

License requirements : None

Returns the origin point of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.


Created in NX6.0.0.

License requirements : None

Returns the direction of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.


Created in NX6.0.0.

License requirements : None

Returns the distance value of GeometricUtilities::ModlMotion::OptionsDistance motion option.


Created in NX6.0.0.

License requirements : None

Returns the direction of GeometricUtilities::ModlMotion::OptionsDistance motion option.


Created in NX6.0.0.

License requirements : None

Returns the end point of GeometricUtilities::ModlMotion::OptionsRotateByThreePoints motion option.


Created in NX6.0.0.

License requirements : None

Returns the "from csys" of GeometricUtilities::ModlMotion::OptionsCsysToCsys motion option .


Created in NX6.0.0.

License requirements : None

Returns the "from point" of GeometricUtilities::ModlMotion::OptionsPointToPoint motion option.


Created in NX6.0.0.

License requirements : None

Returns the matrix of manipulator for GeometricUtilities::ModlMotion::OptionsDynamic motion option.


Created in NX6.0.0.

License requirements : None

Returns the origin point of manipulator for GeometricUtilities::ModlMotion::OptionsDynamic motion option.


Created in NX6.0.0.

License requirements : None

Returns the move handle toggle of GeometricUtilities::ModlMotion::OptionsDynamic motion option.If true,moves only manipulator handle.

If false, moves both manipulator handle and object.
Created in NX6.0.0.

License requirements : None

Returns the options.

Control the Motion methods.
Created in NX6.0.0.

License requirements : None

Returns the orientXpress.

OrientXpress used as overlay in Motion.
Created in NX6.0.0.

License requirements : None

Returns the axis of GeometricUtilities::ModlMotion::OptionsRadialDistance motion option.


Created in NX6.0.0.

License requirements : None

Returns the distance value of GeometricUtilities::ModlMotion::OptionsRadialDistance motion option.


Created in NX6.0.0.

License requirements : None

Returns the measure point of GeometricUtilities::ModlMotion::OptionsRadialDistance motion option.


Created in NX6.0.0.

License requirements : None

Returns the distance between axis point and face of GeometricUtilities::ModlMotion::OptionsRadialDistance motion option.


Created in NX6.0.0.

License requirements : None

Reset motion to three dimensions
Created in NX6.0.0.



License requirements : None

Returns the direction of GeometricUtilities::ModlMotion::OptionsRotateByThreePoints motion option.


Created in NX6.0.0.

License requirements : None

Sets the axis of GeometricUtilities::ModlMotion::OptionsAlignAxisVector motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
alignVectoralignvector

Sets the angular axis of GeometricUtilities::ModlMotion::OptionsAngle motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
angularAxisangularaxis

Sets the delta enum
Created in NX6.0.2.



License requirements : None

Parameters:
deltaEnumdeltaenum

Sets the delta x
Created in NX6.0.2.



License requirements : None

Parameters:
deltaXdeltax

Sets the delta y
Created in NX6.0.2.



License requirements : None

Parameters:
deltaYdeltay

Sets the delta z
Created in NX6.0.2.



License requirements : None

Parameters:
deltaZdeltaz

Set the view for view dependent drafting objects
Created in NX7.5.0.



License requirements : None

Parameters:
viewview where to paste

Sets the measure point of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
measurePointmeasurepoint

Sets the origin point of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
originPointoriginpoint

Sets the direction of GeometricUtilities::ModlMotion::OptionsDistanceBetweenPoints motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
vectorvector

Sets the direction of GeometricUtilities::ModlMotion::OptionsDistance motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
distanceVectordistancevector

Sets the end point of GeometricUtilities::ModlMotion::OptionsRotateByThreePoints motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
endPointendpoint

Sets the "from csys" of GeometricUtilities::ModlMotion::OptionsCsysToCsys motion option .


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
fromcsysfromcsys

Sets the "from point" of GeometricUtilities::ModlMotion::OptionsPointToPoint motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
fromPointfrompoint

Sets the matrix of manipulator for GeometricUtilities::ModlMotion::OptionsDynamic motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
manipulatorMatrixmanipulatormatrix

Sets the origin point of manipulator for GeometricUtilities::ModlMotion::OptionsDynamic motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
manipulatorOriginmanipulatororigin

Set motion to two dimensions along the given plane
Created in NX6.0.0.



License requirements : None

Parameters:
planePlane to which motion needs to be restricted

Sets the move handle toggle of GeometricUtilities::ModlMotion::OptionsDynamic motion option.If true,moves only manipulator handle.

If false, moves both manipulator handle and object.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
moveHandlemovehandle

Sets the options.

Control the Motion methods.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
typetype

Sets the axis of GeometricUtilities::ModlMotion::OptionsRadialDistance motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
radialAxisradialaxis

Sets the measure point of GeometricUtilities::ModlMotion::OptionsRadialDistance motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
radialMeasuPointradialmeasupoint

Sets the direction of GeometricUtilities::ModlMotion::OptionsRotateByThreePoints motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
rotateVectorrotatevector

Sets the start point of GeometricUtilities::ModlMotion::OptionsRotateByThreePoints motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
startPointstartpoint

Sets the "to csys" where object is moved for motion option GeometricUtilities::ModlMotion::OptionsCsysToCsys .


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
tocsystocsys

Sets the point where object is moved for motion option GeometricUtilities::ModlMotion::OptionsPointToPoint
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
toPointtopoint

Sets the vector of GeometricUtilities::ModlMotion::OptionsAlignAxisVector motion option.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
toVectortovector

Set the update option for defining the update behavior for the object.

As an example, in modeling application, the update option should be "WithinModeling" and in drafting application it should be "AfterModeling".
Created in NX6.0.0.

License requirements : None

Parameters:
optionUpdate option

Returns the start point of GeometricUtilities::ModlMotion::OptionsRotateByThreePoints motion option.


Created in NX6.0.0.

License requirements : None

Returns the "to csys" where object is moved for motion option GeometricUtilities::ModlMotion::OptionsCsysToCsys .


Created in NX6.0.0.

License requirements : None

Returns the point where object is moved for motion option GeometricUtilities::ModlMotion::OptionsPointToPoint
Created in NX6.0.0.



License requirements : None

Returns the vector of GeometricUtilities::ModlMotion::OptionsAlignAxisVector motion option.


Created in NX6.0.0.

License requirements : None

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.

Returns:
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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