NXOpen .NET Reference  12.0.0
Classes | Public Types | Public Member Functions | Properties | List of all members
NXOpen.Motion.PostProcess Class Reference

Represents the motion post process More...

Inheritance diagram for NXOpen.Motion.PostProcess:

Classes

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

Public Types

enum  EnvelopeAccuracyModes { Low, Medium, High, Custom }
 The modes for envelope accuracy More...
 
enum  EnvelopeToleranceTypes { Percentage, Absolute }
 Envelope tolerance types More...
 

Public Member Functions

delegate void UserFunctionBeforeDialogDestroy (int userData)
 Post process user function callback before dialog destroy, This callback function will be call when user click the user button. More...
 
unsafe
NXOpen.Assemblies.Arrangement 
CaptureArrangement (string arrangementName, int animationStep)
 Capture or update an arrangement from motion result of active solution. More...
 
unsafe
NXOpen.Assemblies.Arrangement 
CaptureArrangement (string arrangementName, int arrangementType, int animationStep)
 Capture or update an arrangement from motion result of active solution. More...
 
unsafe void CreateEnvelope (NXOpen.Motion.IPostControl tPostControl, NXOpen.NXObject destinationPart, bool addToRefSets, NXOpen.NXObject referenceFrameObj, NXOpen.NXObject[] sourceObjs, int stepFrom, int stepTo, NXOpen.Motion.PostProcess.EnvelopeTolerance toleranceSetting, out NXOpen.NXObject[] sweptBodies, out NXOpen.NXObject[] skipedObj, out NXOpen.NXObject[] failedObjs, out bool aborted)
 Creates envelopes for the given objects More...
 
unsafe void UpdateDesignPosition ()
 Update design position More...
 
unsafe NXOpen.NXObject CreateSequence (string sequenceName)
 Create sequence More...
 
unsafe void TraceCurrentPosition ()
 Trace current position More...
 
unsafe void TraceEntireMechanism ()
 Trace entire mechanism More...
 
unsafe void TraceIntersectionCurve ()
 Trace intersection curve More...
 
unsafe NXOpen.Assemblies.Explosion ExplodeMechanism (string explosionName)
 Explode mechanism More...
 
unsafe void ExportToMovie (string movieName)
 Export to movie More...
 
unsafe void ListMeasure ()
 List measure More...
 
unsafe void ListInterference ()
 List interference More...
 
unsafe bool GetInterferenceOption ()
 Get interference option for animation/articulation/spreadsheet run More...
 
unsafe void SetInterferenceOption (bool interferenceOn)
 Set interference option for animation/articulation/spreadsheet run More...
 
unsafe bool GetMeasureOption ()
 Get measure option animation/articulation/spreadsheet run More...
 
unsafe void SetMeasureOption (bool measureOn)
 Set measure option animation/articulation/spreadsheet run More...
 
unsafe bool GetTraceOption ()
 Get trace option animation/articulation/spreadsheet run More...
 
unsafe void SetTraceOption (bool traceOn)
 Set articulation trace option animation/articulation/spreadsheet run More...
 
unsafe bool GetStopOnEventOption ()
 Get stop on event option animation/articulation/spreadsheet run More...
 
unsafe void SetStopOnEventOption (bool stopOnEventOn)
 Set articulation stop on event option animation/articulation/spreadsheet run More...
 
unsafe int GetSpeed ()
 Get the animation speed for motion animation More...
 
unsafe void SetSpeed (int speed)
 Set the animation speed for motion animation More...
 
unsafe void RegisterUserButton (string buttonName, string buttonTips, string buttonMenuScriptName, NXOpen.Motion.PostProcess.UserFunctionBeforeDialogDestroy functionBeforeUIDestroy)
 Register user button for post process. More...
 
unsafe void ExportRealTimeMovie (string movieName)
 Export a real-time movie More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. 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 Enumeration Documentation

The modes for envelope accuracy

Enumerator
Low 
Medium 
High 
Custom 

Envelope tolerance types

Enumerator
Percentage 
Absolute 

Member Function Documentation

unsafe NXOpen.Assemblies.Arrangement NXOpen.Motion.PostProcess.CaptureArrangement ( string  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.

Created in NX7.5.0

License requirements: mechanisms ("MECHANISMS")

Parameters
arrangementNameName for arrangement
animationStepAnimation step
Returns
Assembly arrangement
unsafe NXOpen.Assemblies.Arrangement NXOpen.Motion.PostProcess.CaptureArrangement ( string  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

Created in NX9.0.1

License requirements: mechanisms ("MECHANISMS")

Parameters
arrangementNameName for arrangement
arrangementTypeArrangement type
animationStepAnimation step
Returns
Assembly arrangement
unsafe void NXOpen.Motion.PostProcess.CreateEnvelope ( NXOpen.Motion.IPostControl  tPostControl,
NXOpen.NXObject  destinationPart,
bool  addToRefSets,
NXOpen.NXObject  referenceFrameObj,
NXOpen.NXObject[]  sourceObjs,
int  stepFrom,
int  stepTo,
NXOpen.Motion.PostProcess.EnvelopeTolerance  toleranceSetting,
out NXOpen.NXObject[]  sweptBodies,
out NXOpen.NXObject[]  skipedObj,
out NXOpen.NXObject[]  failedObjs,
out 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
unsafe NXOpen.NXObject NXOpen.Motion.PostProcess.CreateSequence ( string  sequenceName)

Create sequence

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
sequenceNameThe sequence name
Returns
Sequence
unsafe NXOpen.Assemblies.Explosion NXOpen.Motion.PostProcess.ExplodeMechanism ( string  explosionName)

Explode mechanism

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
explosionNameName for explosion
Returns
NXOpen.Assemblies.Explosion
unsafe void NXOpen.Motion.PostProcess.ExportRealTimeMovie ( string  movieName)

Export a real-time movie

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Parameters
movieNameName for movie to export
unsafe void NXOpen.Motion.PostProcess.ExportToMovie ( string  movieName)

Export to movie

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

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

Get interference option for animation/articulation/spreadsheet run

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

Returns
Interference on/off options
unsafe bool NXOpen.Motion.PostProcess.GetMeasureOption ( )

Get measure option animation/articulation/spreadsheet run

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

Returns
Measure on/off options
unsafe int NXOpen.Motion.PostProcess.GetSpeed ( )

Get the animation speed for motion animation

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

Returns
The animation speed
unsafe bool NXOpen.Motion.PostProcess.GetStopOnEventOption ( )

Get stop on event option animation/articulation/spreadsheet run

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

Returns
Stop on event on/off options
unsafe bool NXOpen.Motion.PostProcess.GetTraceOption ( )

Get trace option animation/articulation/spreadsheet run

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

Returns
Trace on/off options
unsafe void NXOpen.Motion.PostProcess.ListInterference ( )

List interference

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe void NXOpen.Motion.PostProcess.ListMeasure ( )

List measure

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe void NXOpen.Motion.PostProcess.RegisterUserButton ( string  buttonName,
string  buttonTips,
string  buttonMenuScriptName,
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
unsafe 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
unsafe 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
unsafe 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
unsafe 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
unsafe 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
unsafe void NXOpen.Motion.PostProcess.TraceCurrentPosition ( )

Trace current position

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe void NXOpen.Motion.PostProcess.TraceEntireMechanism ( )

Trace entire mechanism

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe void NXOpen.Motion.PostProcess.TraceIntersectionCurve ( )

Trace intersection curve

Created in NX9.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe void NXOpen.Motion.PostProcess.UpdateDesignPosition ( )

Update design position

Created in NX9.0.0

Deprecated in NX12.0.0. This functionality is no longer supported.

License requirements: mechanisms ("MECHANISMS")

delegate void NXOpen.Motion.PostProcess.UserFunctionBeforeDialogDestroy ( int  userData)

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")

Parameters
userData

Property Documentation

Tag NXOpen.Motion.PostProcess.Tag
get

Returns the tag of this object.


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