UserMotionBuilder Class¶
Properties¶
| Property | Description |
|---|---|
| ComponentName | Returns or sets the simulation component name. |
| Description | Returns or sets the description of the motion. |
| Disable | Returns or sets the disabled status of the motion. |
| MotionBodies | Returns the motion bodies. |
| MotionOrigin | Returns or sets the motion vector origin |
| MotionVector | Returns or sets the motion vector. |
| PressStart | Returns or sets the press start angle. |
| PressStop | Returns or sets the press stop angle. |
| ReturnStart | Returns or sets the return start angle. |
| ReturnStop | Returns or sets the return stop angle. |
| Tag | Returns the Tag for this object. |
| TypeOfCurve | Returns or sets the method used to define the motion curve. |
| TypeOfMotion | Returns or sets the type of motion. |
| ValuesInitial | Returns or sets the initial value. |
| ValuesPeak | Returns or sets the peak value. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| DeleteCam | To delete the motion. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetMotionCurve | Get the motion curve values if type is set to from file. |
| GetObject | Returns the object currently being edited by this builder. |
| SetMotionCurve | Set the motion curve values if type is set to from file. |
| SetOutOfDate | To set the out of date status of the motion. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| UserMotionBuilderCurveType Enumeration | The method used to define the motion curve. |
| UserMotionBuilderMotionType Enumeration | The type of motion to create. |