PostProcess Class

class NXOpen.Motion.PostProcess

Bases: object

Represents the motion post process

To obtain an instance of this class, refer to NXOpen.Motion.MotionSession

New in version NX7.5.0.

Methods

Method Description
CaptureArrangement Capture or update an arrangement from motion result of active solution.
CreateEnvelope Creates envelopes for the given objects
CreateSequence Create sequence
ExplodeMechanism Explode mechanism
ExportRealTimeMovie Export a real-time movie
ExportToMovie Export to movie
GetInterferenceOption Get interference option for animation/articulation/spreadsheet run
GetMeasureOption Get measure option animation/articulation/spreadsheet run
GetSpeed Get the animation speed for motion animation
GetStopOnEventOption Get stop on event option animation/articulation/spreadsheet run
GetTraceOption Get trace option animation/articulation/spreadsheet run
ListInterference List interference
ListMeasure List measure
RegisterUserButton Register user button for post process.
SetInterferenceOption Set interference option for animation/articulation/spreadsheet run
SetMeasureOption Set measure option animation/articulation/spreadsheet run
SetSpeed Set the animation speed for motion animation
SetStopOnEventOption Set articulation stop on event option animation/articulation/spreadsheet run
SetTraceOption Set articulation trace option animation/articulation/spreadsheet run
TraceCurrentPosition Trace current position
TraceEntireMechanism Trace entire mechanism
TraceIntersectionCurve Trace intersection curve
UpdateDesignPosition Update design position

Enumerations

PostProcessEnvelopeAccuracyModes Enumeration The modes for envelope accuracy
PostProcessEnvelopeToleranceTypes Enumeration Envelope tolerance types

Structs

PostProcessEnvelopeTolerance_Struct Struct Contains settings for envelope tolerance

Method Detail

CaptureArrangement

PostProcess.CaptureArrangement

Overloaded method CaptureArrangement

  • CaptureArrangement(arrangementName, animationStep)
  • CaptureArrangement(arrangementName, arrangementType, 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.

Signature CaptureArrangement(arrangementName, animationStep)

Parameters:
  • arrangementName (str) – Name for arrangement
  • animationStep (int) – Animation step
Returns:

Assembly arrangement
Return type:

NXOpen.Assemblies.Arrangement

New in version NX7.5.0.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

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

Signature CaptureArrangement(arrangementName, arrangementType, animationStep)

Parameters:
  • arrangementName (str) – Name for arrangement
  • arrangementType (int) – Arrangement type
  • animationStep (int) – Animation step
Returns:

Assembly arrangement
Return type:

NXOpen.Assemblies.Arrangement

New in version NX9.0.1.

License requirements: mechanisms (“MECHANISMS”)

-------------------------------------

CreateEnvelope

PostProcess.CreateEnvelope

Creates envelopes for the given objects

Signature CreateEnvelope(tPostControl, destinationPart, addToRefSets, referenceFrameObj, sourceObjs, stepFrom, stepTo, toleranceSetting)

Parameters:
  • tPostControl (NXOpen.Motion.IPostControl) – The IPostControl object
  • destinationPart (NXOpen.NXObject) – The part to save swept the objects into
  • addToRefSets (bool) – Indicates whether the output should be added to Model/Lightweight reference sets or not
  • referenceFrameObj (NXOpen.NXObject) – The object acts as reference frame
  • sourceObjs (list of NXOpen.NXObject) – The objects swept bodies are created from
  • stepFrom (int) – The step index where the envelope starts
  • stepTo (int) – The step index where the envelope stops
  • toleranceSetting (NXOpen.Motion.PostProcessEnvelopeTolerance_Struct) – The tolerance settings
Returns:

a tuple
Return type:

A tuple consisting of (sweptBodies, skipedObj, failedObjs, aborted). sweptBodies is a list of NXOpen.NXObject. The resulting swept bodies skipedObj is a list of NXOpen.NXObject. The objects skipped because invisible or not moving failedObjs is a list of NXOpen.NXObject. The objects failed because of an algorithm failure aborted is a bool. True if user hits the stop button, false otherwise

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

CreateSequence

PostProcess.CreateSequence

Create sequence

Signature CreateSequence(sequenceName)

Parameters:sequenceName (str) – The sequence name
Returns:Sequence
Return type:NXOpen.NXObject

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExplodeMechanism

PostProcess.ExplodeMechanism

Explode mechanism

Signature ExplodeMechanism(explosionName)

Parameters:explosionName (str) – Name for explosion
Returns:NXOpen.Assemblies.Explosion
Return type:NXOpen.Assemblies.Explosion

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExportRealTimeMovie

PostProcess.ExportRealTimeMovie

Export a real-time movie

Signature ExportRealTimeMovie(movieName)

Parameters:movieName (str) – Name for movie to export

New in version NX11.0.0.

License requirements: mechanisms (“MECHANISMS”)

ExportToMovie

PostProcess.ExportToMovie

Export to movie

Signature ExportToMovie(movieName)

Parameters:movieName (str) – Name for movie to export

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

GetInterferenceOption

PostProcess.GetInterferenceOption

Get interference option for animation/articulation/spreadsheet run

Signature GetInterferenceOption()

Returns:Interference on/off options
Return type:bool

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

GetMeasureOption

PostProcess.GetMeasureOption

Get measure option animation/articulation/spreadsheet run

Signature GetMeasureOption()

Returns:Measure on/off options
Return type:bool

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

GetSpeed

PostProcess.GetSpeed

Get the animation speed for motion animation

Signature GetSpeed()

Returns:The animation speed
Return type:int

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

GetStopOnEventOption

PostProcess.GetStopOnEventOption

Get stop on event option animation/articulation/spreadsheet run

Signature GetStopOnEventOption()

Returns:Stop on event on/off options
Return type:bool

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

GetTraceOption

PostProcess.GetTraceOption

Get trace option animation/articulation/spreadsheet run

Signature GetTraceOption()

Returns:Trace on/off options
Return type:bool

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

ListInterference

PostProcess.ListInterference

List interference

Signature ListInterference()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

ListMeasure

PostProcess.ListMeasure

List measure

Signature ListMeasure()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

RegisterUserButton

PostProcess.RegisterUserButton

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

Signature RegisterUserButton(buttonName, buttonTips, buttonMenuScriptName, functionBeforeUIDestroy)

Parameters:
  • buttonName (str) – the name displayed on the button
  • buttonTips (str) – the button tool tip
  • buttonMenuScriptName (str) – the menu script name of the button
  • functionBeforeUIDestroy (CallableObject) – User function for this button before dialog destroy

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

SetInterferenceOption

PostProcess.SetInterferenceOption

Set interference option for animation/articulation/spreadsheet run

Signature SetInterferenceOption(interferenceOn)

Parameters:interferenceOn (bool) – Interference on/off options

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

SetMeasureOption

PostProcess.SetMeasureOption

Set measure option animation/articulation/spreadsheet run

Signature SetMeasureOption(measureOn)

Parameters:measureOn (bool) – Measure on/off options

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

SetSpeed

PostProcess.SetSpeed

Set the animation speed for motion animation

Signature SetSpeed(speed)

Parameters:speed (int) – The animation speed

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

SetStopOnEventOption

PostProcess.SetStopOnEventOption

Set articulation stop on event option animation/articulation/spreadsheet run

Signature SetStopOnEventOption(stopOnEventOn)

Parameters:stopOnEventOn (bool) – Stop on event on/off options

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

SetTraceOption

PostProcess.SetTraceOption

Set articulation trace option animation/articulation/spreadsheet run

Signature SetTraceOption(traceOn)

Parameters:traceOn (bool) – Trace on/off options

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

TraceCurrentPosition

PostProcess.TraceCurrentPosition

Trace current position

Signature TraceCurrentPosition()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

TraceEntireMechanism

PostProcess.TraceEntireMechanism

Trace entire mechanism

Signature TraceEntireMechanism()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

TraceIntersectionCurve

PostProcess.TraceIntersectionCurve

Trace intersection curve

Signature TraceIntersectionCurve()

New in version NX9.0.0.

License requirements: mechanisms (“MECHANISMS”)

UpdateDesignPosition

PostProcess.UpdateDesignPosition

Update design position

Signature UpdateDesignPosition()

New in version NX9.0.0.

Deprecated since version NX12.0.0: This functionality is no longer supported.

License requirements: mechanisms (“MECHANISMS”)