PlayButtonsBuilder Class¶
-
class
NXOpen.GeometricUtilities.PlayButtonsBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderVCR buttons for any dialog that needs them
New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| CurrentStep | Returns or sets the step |
| PlayModes | Returns or sets the play modes |
| ScaleSpeed | Returns or sets the scale speed |
| ScaleStep | Returns or sets the scale step |
| Speed | Returns or sets the speed |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| ForwardToEnd | TODO: fill in a description for this |
| PlayBackward | TODO: fill in a description for this |
| PlayForward | TODO: fill in a description for this |
| RewindToStart | TODO: fill in a description for this |
| StepBackward | TODO: fill in a description for this |
| StepForward | TODO: fill in a description for this |
| Stop | TODO: fill in a description for this |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| PlayButtonsBuilderPlayModeValues Enumeration | the different play modes available |
Property Detail¶
CurrentStep¶
-
PlayButtonsBuilder.CurrentStep¶ Returns or sets the step
-------------------------------------Getter Method
Signature
CurrentStepReturns: Return type: int New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CurrentStepParameters: currentStep (int) – New in version NX11.0.0.
License requirements: None.
PlayModes¶
-
PlayButtonsBuilder.PlayModes¶ Returns or sets the play modes
-------------------------------------Getter Method
Signature
PlayModesReturns: Return type: NXOpen.GeometricUtilities.PlayButtonsBuilderPlayModeValuesNew in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PlayModesParameters: playModes ( NXOpen.GeometricUtilities.PlayButtonsBuilderPlayModeValues) –New in version NX11.0.0.
License requirements: None.
ScaleSpeed¶
-
PlayButtonsBuilder.ScaleSpeed¶ Returns or sets the scale speed
-------------------------------------Getter Method
Signature
ScaleSpeedReturns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ScaleSpeedParameters: scaleSpeed (float) – New in version NX11.0.0.
License requirements: None.
ScaleStep¶
-
PlayButtonsBuilder.ScaleStep¶ Returns or sets the scale step
-------------------------------------Getter Method
Signature
ScaleStepReturns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ScaleStepParameters: scaleStep (float) – New in version NX11.0.0.
License requirements: None.
Speed¶
-
PlayButtonsBuilder.Speed¶ Returns or sets the speed
-------------------------------------Getter Method
Signature
SpeedReturns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SpeedParameters: speed (float) – New in version NX11.0.0.
License requirements: None.
Method Detail¶
ForwardToEnd¶
-
PlayButtonsBuilder.ForwardToEnd¶ TODO: fill in a description for this
Signature
ForwardToEnd()New in version NX11.0.0.
License requirements: None.
PlayBackward¶
-
PlayButtonsBuilder.PlayBackward¶ TODO: fill in a description for this
Signature
PlayBackward()New in version NX11.0.0.
License requirements: None.
PlayForward¶
-
PlayButtonsBuilder.PlayForward¶ TODO: fill in a description for this
Signature
PlayForward()New in version NX11.0.0.
License requirements: None.
RewindToStart¶
-
PlayButtonsBuilder.RewindToStart¶ TODO: fill in a description for this
Signature
RewindToStart()New in version NX11.0.0.
License requirements: None.
StepBackward¶
-
PlayButtonsBuilder.StepBackward¶ TODO: fill in a description for this
Signature
StepBackward()New in version NX11.0.0.
License requirements: None.
StepForward¶
-
PlayButtonsBuilder.StepForward¶ TODO: fill in a description for this
Signature
StepForward()New in version NX11.0.0.
License requirements: None.
Stop¶
-
PlayButtonsBuilder.Stop¶ TODO: fill in a description for this
Signature
Stop()New in version NX11.0.0.
License requirements: None.
Validate¶
-
PlayButtonsBuilder.Validate¶ 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.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.