UserDefinedMotionBuilder Class¶

class NXOpen.Tooling.UserDefinedMotionBuilder¶

Bases: NXOpen.Builder

Represents a NXOpen.Tooling.UserDefinedMotionBuilder to create user defined motion, which contains linear and rotary motion

To create a new instance of this class, use NXOpen.Tooling.ProgressiveDieManager.CreateUserDefinedMotionBuilder()

Default values.

Property	Value
LinearCurveType	Linear
MotionType	Linear
MoveDistance	0
PressStartAngle	0
PressStopAngle	90
ReturnStartAngle	180
ReturnStopAngle	270
RotaryCurveType	Rotary
RotationAngle	0
UseControlData	0

New in version NX11.0.0.

Properties¶

Property	Description
ExportMotion	Returns or sets the export motion
ImportMotion	Returns or sets the import motion
LinearCurveType	Returns or sets the linear curve type
LinearMotionVector	Returns or sets the linear motion vector
MotionBody	Returns the motion body
MotionName	Returns or sets the motion name
MotionType	Returns or sets the motion type
MoveDistance	Returns or sets the move distance
PressStartAngle	Returns or sets the press start angle
PressStopAngle	Returns or sets the press stop angle
ReturnStartAngle	Returns or sets the return start angle
ReturnStopAngle	Returns or sets the return stop angle
RotaryCurveType	Returns or sets the rotary curve type
RotaryMotionAxis	Returns or sets the rotary motion axis
RotationAngle	Returns or sets the rotation angle
Tag	Returns the Tag for this object.
UseControlData	Returns or sets the use control data

Methods¶

Method	Description
Commit	Commits any edits that have been applied to the builder.
DeleteUserDefinedMotion	Delete a user defined 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.
GetObject	Returns the object currently being edited by this builder.
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¶

UserDefinedMotionBuilderLinearCurveTypes Enumeration	Specifies the motion curve types when motion type is Linear
UserDefinedMotionBuilderMotionTypes Enumeration	Specifies the motion types
UserDefinedMotionBuilderRotaryCurveTypes Enumeration	Specifies the motion curve types when motion type is Rotary

Property Detail¶

ExportMotion¶

UserDefinedMotionBuilder.ExportMotion¶

Returns or sets the export motion

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

Getter Method

Signature ExportMotion()

Returns:
Return type:	str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ExportMotion(filename)

Parameters:	filename (str) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

ImportMotion¶

UserDefinedMotionBuilder.ImportMotion¶

Returns or sets the import motion

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

Getter Method

Signature ImportMotion()

Returns:
Return type:	str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ImportMotion(filename)

Parameters:	filename (str) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

LinearCurveType¶

UserDefinedMotionBuilder.LinearCurveType¶

Returns or sets the linear curve type

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

Getter Method

Signature LinearCurveType()

Returns:
Return type:	`NXOpen.Tooling.UserDefinedMotionBuilderLinearCurveTypes`

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature LinearCurveType(linearCurveType)

Parameters:	linearCurveType (`NXOpen.Tooling.UserDefinedMotionBuilderLinearCurveTypes`) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

LinearMotionVector¶

UserDefinedMotionBuilder.LinearMotionVector¶

Returns or sets the linear motion vector

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

Getter Method

Signature LinearMotionVector()

Returns:
Return type:	`NXOpen.Direction`

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature LinearMotionVector(linearMotionVector)

Parameters:	linearMotionVector (`NXOpen.Direction`) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

MotionBody¶

UserDefinedMotionBuilder.MotionBody¶

Returns the motion body

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

Getter Method

Signature MotionBody()

Returns:
Return type:	`NXOpen.SelectDisplayableObjectList`

New in version NX11.0.0.

License requirements: None.

MotionName¶

UserDefinedMotionBuilder.MotionName¶

Returns or sets the motion name

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

Getter Method

Signature MotionName()

Returns:
Return type:	str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature MotionName(motionName)

Parameters:	motionName (str) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

MotionType¶

UserDefinedMotionBuilder.MotionType¶

Returns or sets the motion type

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

Getter Method

Signature MotionType()

Returns:
Return type:	`NXOpen.Tooling.UserDefinedMotionBuilderMotionTypes`

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature MotionType(motionType)

Parameters:	motionType (`NXOpen.Tooling.UserDefinedMotionBuilderMotionTypes`) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

MoveDistance¶

UserDefinedMotionBuilder.MoveDistance¶

Returns or sets the move distance

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

Getter Method

Signature MoveDistance()

Returns:
Return type:	float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature MoveDistance(moveDistance)

Parameters:	moveDistance (float) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

PressStartAngle¶

UserDefinedMotionBuilder.PressStartAngle¶

Returns or sets the press start angle

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

Getter Method

Signature PressStartAngle()

Returns:
Return type:	float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature PressStartAngle(pressStartAngle)

Parameters:	pressStartAngle (float) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

PressStopAngle¶

UserDefinedMotionBuilder.PressStopAngle¶

Returns or sets the press stop angle

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

Getter Method

Signature PressStopAngle()

Returns:
Return type:	float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature PressStopAngle(pressStopAngle)

Parameters:	pressStopAngle (float) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

ReturnStartAngle¶

UserDefinedMotionBuilder.ReturnStartAngle¶

Returns or sets the return start angle

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

Getter Method

Signature ReturnStartAngle()

Returns:
Return type:	float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ReturnStartAngle(returnStartAngle)

Parameters:	returnStartAngle (float) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

ReturnStopAngle¶

UserDefinedMotionBuilder.ReturnStopAngle¶

Returns or sets the return stop angle

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

Getter Method

Signature ReturnStopAngle()

Returns:
Return type:	float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ReturnStopAngle(returnStopAngle)

Parameters:	returnStopAngle (float) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

RotaryCurveType¶

UserDefinedMotionBuilder.RotaryCurveType¶

Returns or sets the rotary curve type

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

Getter Method

Signature RotaryCurveType()

Returns:
Return type:	`NXOpen.Tooling.UserDefinedMotionBuilderRotaryCurveTypes`

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature RotaryCurveType(rotaryCurveType)

Parameters:	rotaryCurveType (`NXOpen.Tooling.UserDefinedMotionBuilderRotaryCurveTypes`) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

RotaryMotionAxis¶

UserDefinedMotionBuilder.RotaryMotionAxis¶

Returns or sets the rotary motion axis

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

Getter Method

Signature RotaryMotionAxis()

Returns:
Return type:	`NXOpen.Axis`

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature RotaryMotionAxis(rotaryMotionAxis)

Parameters:	rotaryMotionAxis (`NXOpen.Axis`) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

RotationAngle¶

UserDefinedMotionBuilder.RotationAngle¶

Returns or sets the rotation angle

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

Getter Method

Signature RotationAngle()

Returns:
Return type:	float

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature RotationAngle(rotationAngle)

Parameters:	rotationAngle (float) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

UseControlData¶

UserDefinedMotionBuilder.UseControlData¶

Returns or sets the use control data

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

Getter Method

Signature UseControlData()

Returns:
Return type:	bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature UseControlData(useControlData)

Parameters:	useControlData (bool) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

Method Detail¶

DeleteUserDefinedMotion¶

UserDefinedMotionBuilder.DeleteUserDefinedMotion¶

Delete a user defined motion

Signature DeleteUserDefinedMotion(motionName)

Parameters:	motionName (str) –

New in version NX11.0.0.

License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)

Validate¶

UserDefinedMotionBuilder.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.