NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions | List of all members
NXOpen::Motion::PostProcess Class Reference

Represents the motion post process
To obtain an instance of this class, refer to NXOpen::Motion::MotionSession

Created in NX7.5.0. More...

Classes

struct  EnvelopeTolerance
 Contains settings for envelope tolerance. More...
 

Public Types

enum  EnvelopeAccuracyModes { EnvelopeAccuracyModesLow, EnvelopeAccuracyModesMedium, EnvelopeAccuracyModesHigh, EnvelopeAccuracyModesCustom }
 The modes for envelope accuracy. More...
 
enum  EnvelopeToleranceTypes { EnvelopeToleranceTypesPercentage, EnvelopeToleranceTypesAbsolute }
 Envelope tolerance types. More...
 
typedef NXOpen::Callback1
< void, int > 
UserFunctionBeforeDialogDestroy
 Post process user function callback before dialog destroy, This callback function will be call when user click the user button. More...
 

Public Member Functions

NXOpen::Assemblies::ArrangementCaptureArrangement (const NXString &arrangementName, int animationStep)
 Capture or update an arrangement from motion result of active solution. More...
 
NXOpen::Assemblies::ArrangementCaptureArrangement (const char *arrangementName, int animationStep)
 Capture or update an arrangement from motion result of active solution. More...
 
NXOpen::Assemblies::ArrangementCaptureArrangement (const NXString &arrangementName, int arrangementType, int animationStep)
 Capture or update an arrangement from motion result of active solution. More...
 
NXOpen::Assemblies::ArrangementCaptureArrangement (const char *arrangementName, int arrangementType, int animationStep)
 Capture or update an arrangement from motion result of active solution. More...
 
void CreateEnvelope (NXOpen::Motion::IPostControl *tPostControl, NXOpen::NXObject *destinationPart, bool addToRefSets, NXOpen::NXObject *referenceFrameObj, const std::vector< NXOpen::NXObject * > &sourceObjs, int stepFrom, int stepTo, const NXOpen::Motion::PostProcess::EnvelopeTolerance &toleranceSetting, std::vector< NXOpen::NXObject * > &sweptBodies, std::vector< NXOpen::NXObject * > &skipedObj, std::vector< NXOpen::NXObject * > &failedObjs, bool *aborted)
 Creates envelopes for the given objects
Created in NX11.0.0. More...
 
NXOpen::NXObjectCreateSequence (const NXString &sequenceName)
 Create sequence. More...
 
NXOpen::NXObjectCreateSequence (const char *sequenceName)
 Create sequence. More...
 
NXOpen::Assemblies::ExplosionExplodeMechanism (const NXString &explosionName)
 Explode mechanism. More...
 
NXOpen::Assemblies::ExplosionExplodeMechanism (const char *explosionName)
 Explode mechanism. More...
 
void ExportRealTimeMovie (const NXString &movieName)
 Export a real-time movie
Created in NX11.0.0. More...
 
void ExportRealTimeMovie (const char *movieName)
 Export a real-time movie
Created in NX11.0.0. More...
 
void ExportToMovie (const NXString &movieName)
 Export to movie
Created in NX9.0.0. More...
 
void ExportToMovie (const char *movieName)
 Export to movie
Created in NX9.0.0. More...
 
bool GetInterferenceOption ()
 Get interference option for animation/articulation/spreadsheet run. More...
 
bool GetMeasureOption ()
 Get measure option animation/articulation/spreadsheet run. More...
 
int GetSpeed ()
 Get the animation speed for motion animation. More...
 
bool GetStopOnEventOption ()
 Get stop on event option animation/articulation/spreadsheet run. More...
 
bool GetTraceOption ()
 Get trace option animation/articulation/spreadsheet run. More...
 
void ListInterference ()
 List interference
Created in NX9.0.0. More...
 
void ListMeasure ()
 List measure
Created in NX9.0.0. More...
 
void RegisterUserButton (const NXString &buttonName, const NXString &buttonTips, const NXString &buttonMenuScriptName, const NXOpen::Motion::PostProcess::UserFunctionBeforeDialogDestroy &functionBeforeUIDestroy)
 Register user button for post process. More...
 
void RegisterUserButton (const char *buttonName, const char *buttonTips, const char *buttonMenuScriptName, const NXOpen::Motion::PostProcess::UserFunctionBeforeDialogDestroy &functionBeforeUIDestroy)
 Register user button for post process. More...
 
void SetInterferenceOption (bool interferenceOn)
 Set interference option for animation/articulation/spreadsheet run
Created in NX9.0.0. More...
 
void SetMeasureOption (bool measureOn)
 Set measure option animation/articulation/spreadsheet run
Created in NX9.0.0. More...
 
void SetSpeed (int speed)
 Set the animation speed for motion animation
Created in NX9.0.0. More...
 
void SetStopOnEventOption (bool stopOnEventOn)
 Set articulation stop on event option animation/articulation/spreadsheet run
Created in NX9.0.0. More...
 
void SetTraceOption (bool traceOn)
 Set articulation trace option animation/articulation/spreadsheet run
Created in NX9.0.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
void TraceCurrentPosition ()
 Trace current position
Created in NX9.0.0. More...
 
void TraceEntireMechanism ()
 Trace entire mechanism
Created in NX9.0.0. More...
 
void TraceIntersectionCurve ()
 Trace intersection curve
Created in NX9.0.0. More...
 
void UpdateDesignPosition ()
 Update design position
More...
 

Detailed Description

Represents the motion post process
To obtain an instance of this class, refer to NXOpen::Motion::MotionSession

Created in NX7.5.0.


Member Typedef Documentation

Post process user function callback before dialog destroy, This callback function will be call when user click the user button.

The input integer value can be used as current animation step number
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")

Member Enumeration Documentation

The modes for envelope accuracy.

Enumerator
EnvelopeAccuracyModesLow 

low

EnvelopeAccuracyModesMedium 

medium

EnvelopeAccuracyModesHigh 

high

EnvelopeAccuracyModesCustom 

custom

Envelope tolerance types.

Enumerator
EnvelopeToleranceTypesPercentage 

percentage

EnvelopeToleranceTypesAbsolute 

absolute

Member Function Documentation

NXOpen::Assemblies::Arrangement* NXOpen::Motion::PostProcess::CaptureArrangement ( const NXString arrangementName,
int  animationStep 
)

Capture or update an arrangement from motion result of active solution.

If an arrangement with the given name is present, updates the arrangement. Otherwise new arrangement of the standard type is created.

Returns
Assembly arrangement
Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
arrangementNameName for arrangement
animationStepAnimation step
NXOpen::Assemblies::Arrangement* NXOpen::Motion::PostProcess::CaptureArrangement ( const char *  arrangementName,
int  animationStep 
)

Capture or update an arrangement from motion result of active solution.

If an arrangement with the given name is present, updates the arrangement. Otherwise new arrangement of the standard type is created.

Returns
Assembly arrangement
Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
arrangementNameName for arrangement
animationStepAnimation step
NXOpen::Assemblies::Arrangement* NXOpen::Motion::PostProcess::CaptureArrangement ( const NXString arrangementName,
int  arrangementType,
int  animationStep 
)

Capture or update an arrangement from motion result of active solution.

If an arrangement with the given name is present, updates the arrangement. The arrangement type cannot be changed during update. If an arrangement with the given name is not present, new arrangement is created. The new arrangement could be isolated or standard type. It depends on the arrangementType argument

Returns
Assembly arrangement
Created in NX9.0.1.

License requirements : mechanisms ("MECHANISMS")
Parameters
arrangementNameName for arrangement
arrangementTypeArrangement type
animationStepAnimation step
NXOpen::Assemblies::Arrangement* NXOpen::Motion::PostProcess::CaptureArrangement ( const char *  arrangementName,
int  arrangementType,
int  animationStep 
)

Capture or update an arrangement from motion result of active solution.

If an arrangement with the given name is present, updates the arrangement. The arrangement type cannot be changed during update. If an arrangement with the given name is not present, new arrangement is created. The new arrangement could be isolated or standard type. It depends on the arrangementType argument

Returns
Assembly arrangement
Created in NX9.0.1.

License requirements : mechanisms ("MECHANISMS")
Parameters
arrangementNameName for arrangement
arrangementTypeArrangement type
animationStepAnimation step
void NXOpen::Motion::PostProcess::CreateEnvelope ( NXOpen::Motion::IPostControl tPostControl,
NXOpen::NXObject destinationPart,
bool  addToRefSets,
NXOpen::NXObject referenceFrameObj,
const std::vector< NXOpen::NXObject * > &  sourceObjs,
int  stepFrom,
int  stepTo,
const NXOpen::Motion::PostProcess::EnvelopeTolerance toleranceSetting,
std::vector< NXOpen::NXObject * > &  sweptBodies,
std::vector< NXOpen::NXObject * > &  skipedObj,
std::vector< NXOpen::NXObject * > &  failedObjs,
bool *  aborted 
)

Creates envelopes for the given objects
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
tPostControlThe IPostControl object
destinationPartThe part to save swept the objects into
addToRefSetsIndicates whether the output should be added to Model/Lightweight reference sets or not
referenceFrameObjThe object acts as reference frame
sourceObjsThe objects swept bodies are created from
stepFromThe step index where the envelope starts
stepToThe step index where the envelope stops
toleranceSettingThe tolerance settings
sweptBodiesThe resulting swept bodies
skipedObjThe objects skipped because invisible or not moving
failedObjsThe objects failed because of an algorithm failure
abortedTrue if user hits the stop button, false otherwise
NXOpen::NXObject* NXOpen::Motion::PostProcess::CreateSequence ( const NXString sequenceName)

Create sequence.

Returns
Sequence
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
sequenceNameThe sequence name
NXOpen::NXObject* NXOpen::Motion::PostProcess::CreateSequence ( const char *  sequenceName)

Create sequence.

Returns
Sequence
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
sequenceNameThe sequence name
NXOpen::Assemblies::Explosion* NXOpen::Motion::PostProcess::ExplodeMechanism ( const NXString explosionName)

Explode mechanism.

Returns
NXOpen::Assemblies::Explosion
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
explosionNameName for explosion
NXOpen::Assemblies::Explosion* NXOpen::Motion::PostProcess::ExplodeMechanism ( const char *  explosionName)

Explode mechanism.

Returns
NXOpen::Assemblies::Explosion
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")
Parameters
explosionNameName for explosion
void NXOpen::Motion::PostProcess::ExportRealTimeMovie ( const NXString movieName)

Export a real-time movie
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
movieNameName for movie to export
void NXOpen::Motion::PostProcess::ExportRealTimeMovie ( const char *  movieName)

Export a real-time movie
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
movieNameName for movie to export
void NXOpen::Motion::PostProcess::ExportToMovie ( const NXString movieName)

Export to movie
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
movieNameName for movie to export
void NXOpen::Motion::PostProcess::ExportToMovie ( const char *  movieName)

Export to movie
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
movieNameName for movie to export
bool NXOpen::Motion::PostProcess::GetInterferenceOption ( )

Get interference option for animation/articulation/spreadsheet run.

Returns
Interference on/off options
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")
bool NXOpen::Motion::PostProcess::GetMeasureOption ( )

Get measure option animation/articulation/spreadsheet run.

Returns
Measure on/off options
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")
int NXOpen::Motion::PostProcess::GetSpeed ( )

Get the animation speed for motion animation.

Returns
The animation speed
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")
bool NXOpen::Motion::PostProcess::GetStopOnEventOption ( )

Get stop on event option animation/articulation/spreadsheet run.

Returns
Stop on event on/off options
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")
bool NXOpen::Motion::PostProcess::GetTraceOption ( )

Get trace option animation/articulation/spreadsheet run.

Returns
Trace on/off options
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")
void NXOpen::Motion::PostProcess::ListInterference ( )

List interference
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::PostProcess::ListMeasure ( )

List measure
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::PostProcess::RegisterUserButton ( const NXString buttonName,
const NXString buttonTips,
const NXString buttonMenuScriptName,
const NXOpen::Motion::PostProcess::UserFunctionBeforeDialogDestroy functionBeforeUIDestroy 
)

Register user button for post process.

If the functionBeforeUIDestroy is register, the motion post animation, articulation, spreadsheet run UI will display the user button as the buttonName and buttonTips setting. and in this button action, it will invoke the register function and the function by menu script registered
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
buttonNamethe name displayed on the button
buttonTipsthe button tool tip
buttonMenuScriptNamethe menu script name of the button
functionBeforeUIDestroyUser function for this button before dialog destroy
void NXOpen::Motion::PostProcess::RegisterUserButton ( const char *  buttonName,
const char *  buttonTips,
const char *  buttonMenuScriptName,
const NXOpen::Motion::PostProcess::UserFunctionBeforeDialogDestroy functionBeforeUIDestroy 
)

Register user button for post process.

If the functionBeforeUIDestroy is register, the motion post animation, articulation, spreadsheet run UI will display the user button as the buttonName and buttonTips setting. and in this button action, it will invoke the register function and the function by menu script registered
Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
buttonNamethe name displayed on the button
buttonTipsthe button tool tip
buttonMenuScriptNamethe menu script name of the button
functionBeforeUIDestroyUser function for this button before dialog destroy
void NXOpen::Motion::PostProcess::SetInterferenceOption ( bool  interferenceOn)

Set interference option for animation/articulation/spreadsheet run
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
interferenceOnInterference on/off options
void NXOpen::Motion::PostProcess::SetMeasureOption ( bool  measureOn)

Set measure option animation/articulation/spreadsheet run
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
measureOnMeasure on/off options
void NXOpen::Motion::PostProcess::SetSpeed ( int  speed)

Set the animation speed for motion animation
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
speedThe animation speed
void NXOpen::Motion::PostProcess::SetStopOnEventOption ( bool  stopOnEventOn)

Set articulation stop on event option animation/articulation/spreadsheet run
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
stopOnEventOnStop on event on/off options
void NXOpen::Motion::PostProcess::SetTraceOption ( bool  traceOn)

Set articulation trace option animation/articulation/spreadsheet run
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
traceOnTrace on/off options
tag_t NXOpen::Motion::PostProcess::Tag ( ) const

Returns the tag of this object.

void NXOpen::Motion::PostProcess::TraceCurrentPosition ( )

Trace current position
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::PostProcess::TraceEntireMechanism ( )

Trace entire mechanism
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::PostProcess::TraceIntersectionCurve ( )

Trace intersection curve
Created in NX9.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::PostProcess::UpdateDesignPosition ( )

Update design position

Deprecated:
Deprecated in NX12.0.0.

This functionality is no longer supported.


Created in NX9.0.0.

License requirements : mechanisms ("MECHANISMS")


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