TrimTaskBuilder Class¶

class NXOpen.Die.TrimTaskBuilder¶

Bases: NXOpen.Features.FeatureBuilder

Represents a Trim Task feature builder.

To create a new instance of this class, use NXOpen.Die.DieCollection.TrimTask()

New in version NX4.0.0.

Properties¶

Property	Description
AngleTolerance	Returns or sets the angle tolerance of the trim task
CamDirection	Returns or sets the cam direction of the trim task
CamType	Returns or sets the cam type of the trim task
CreateScrap	Returns or sets the create scrap setting of the trim task.
DistanceTolerance	Returns or sets the distance tolerance of the trim task
EndPlane	Returns or sets the end plane of the trim task
FinishOperation	Returns or sets the finish operation of the trim task True indicates the trim is to be a finish trim.
LayoutFlange	Returns or sets the layout flange setting of the trim task.
MatchCutExtensionAngle	Returns or sets the match cut extension angle dimension of the trim task
MatchCutFirstRadius	Returns or sets the match cut first radius dimension of the trim task
MatchCutNotchOffset	Returns or sets the match cut notch offset dimension of the trim task
MatchCutOffsetFromPlane	Returns or sets the match cut offset from plane dimension of the trim task
MatchCutOffsetLength	Returns or sets the match cut offset length dimension of the trim task
MatchCutScrapCutterLength	Returns or sets the match cut scrap cutter length dimension of the trim task
MatchCutSecondRadius	Returns or sets the match cut second radius dimension of the trim task
MatchCutThirdRadius	Returns or sets the match cut third radius dimension of the trim task
MatchCutType	Returns or sets the match cut type of the trim task
ParentFeatureInternal	Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag	Returns or sets the patch solution flag
PatchSurfaceFilename	Returns or sets the patch surface filename
ReverseTrimSide	Returns or sets the reverse trim side setting of the trim task.
StartPlane	Returns or sets the start plane of the trim task
SurroundingPatchSurfaceFilename	Returns or sets the surrounding patch surface filename
Tag	Returns the Tag for this object.
TippedProduct	Returns or sets the tipped product of the trim task
TrimNewDieFace	Returns or sets the trim new die face, from NX10.

Methods¶

Method	Description
CheckAndMovePlanes	Move end planes if the position of Trim Task is changed.
Commit	Commits any edits that have been applied to the builder.
CommitFeature	Commits the feature parameters and creates the feature
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetAssociativeObjects	Gets the associative objects of the trim task
GetCameraLayerAndXmlp	Gets the camera layer settings and xmlp data
GetCameraNames	Gets the names of the camera
GetCameraViews	Gets the camera views of the trim task
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetDetails	Gets the detailed description of the trim task
GetFeature	Returns the feature currently being edited by this builder.
GetObject	Returns the object currently being edited by this builder.
GetScrapCutters	Gets the scrap cutters of the trim task
GetTrimBounds	Gets the trim bounds of the trim task
HideInternalParentFeatureAfterEdit	Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetAssociativeObjects	Sets the associative objects of the trim task
SetCameraLayerAndXmlp	Sets the camera layer settings and xmlp data
SetCameraNames	Sets the names of the camera
SetCameraViews	Sets the camera views of the trim task
SetDetails	Sets the detailed description of the trim task
SetParentFeatureInternal	Set the parent features which would be internal or slaves to the feature being created or commited
SetScrapCutters	Sets the scrap cutters of the trim task
SetTrimBounds	Sets the trim bounds of the trim task.
ShowInternalParentFeatureForEdit	Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal	Set the internal parent feature of the feature being edited to external
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations¶

TrimTaskBuilderCamTypes Enumeration	Settings for the cam type of the trim task.
TrimTaskBuilderMatchCutTypes Enumeration	Settings for the match cut type of the trim task.

Property Detail¶

AngleTolerance¶

TrimTaskBuilder.AngleTolerance¶

Returns or sets the angle tolerance of the trim task

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

Getter Method

Signature AngleTolerance

Returns:
Return type:	float

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature AngleTolerance

Parameters:	angleTolerance (float) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

CamDirection¶

TrimTaskBuilder.CamDirection¶

Returns or sets the cam direction of the trim task

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

Getter Method

Signature CamDirection

Returns:
Return type:	`NXOpen.ILocation`

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature CamDirection

Parameters:	camDirection (`NXOpen.ILocation`) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

CamType¶

TrimTaskBuilder.CamType¶

Returns or sets the cam type of the trim task

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

Getter Method

Signature CamType

Returns:
Return type:	`NXOpen.Die.TrimTaskBuilderCamTypes`

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature CamType

Parameters:	camType (`NXOpen.Die.TrimTaskBuilderCamTypes`) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

CreateScrap¶

TrimTaskBuilder.CreateScrap¶

Returns or sets the create scrap setting of the trim task.

True indicates that the scrap is to be created.

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

Getter Method

Signature CreateScrap

Returns:
Return type:	bool

New in version NX7.5.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature CreateScrap

Parameters:	createScrap (bool) –

New in version NX7.5.0.

License requirements: die_engineering (“DIE ENGINEERING”)

DistanceTolerance¶

TrimTaskBuilder.DistanceTolerance¶

Returns or sets the distance tolerance of the trim task

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

Getter Method

Signature DistanceTolerance

Returns:
Return type:	float

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature DistanceTolerance

Parameters:	distanceTolerance (float) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

EndPlane¶

TrimTaskBuilder.EndPlane¶

Returns or sets the end plane of the trim task

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

Getter Method

Signature EndPlane

Returns:
Return type:	`NXOpen.ISurface`

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature EndPlane

Parameters:	endPlane (`NXOpen.ISurface`) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

FinishOperation¶

TrimTaskBuilder.FinishOperation¶

Returns or sets the finish operation of the trim task True indicates the trim is to be a finish trim.

False indicates rough trim.

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

Getter Method

Signature FinishOperation

Returns:
Return type:	bool

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature FinishOperation

Parameters:	finishOperation (bool) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

LayoutFlange¶

TrimTaskBuilder.LayoutFlange¶

Returns or sets the layout flange setting of the trim task.

True indicates that the trim curve is to be laid out on the flange.

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

Getter Method

Signature LayoutFlange

Returns:
Return type:	bool

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature LayoutFlange

Parameters:	layoutFlange (bool) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

MatchCutExtensionAngle¶

TrimTaskBuilder.MatchCutExtensionAngle¶

Returns or sets the match cut extension angle dimension of the trim task

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

Getter Method

Signature MatchCutExtensionAngle

Returns:	angle of extension line from perpendicular
Return type:	float

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature MatchCutExtensionAngle

Parameters:	extensionAngle (float) – angle of extension line from perpendicular

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

MatchCutFirstRadius¶

TrimTaskBuilder.MatchCutFirstRadius¶

Returns or sets the match cut first radius dimension of the trim task

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

Getter Method

Signature MatchCutFirstRadius

Returns:	first radius after notch
Return type:	float

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature MatchCutFirstRadius

Parameters:	firstRadius (float) – first radius after notch

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

MatchCutNotchOffset¶

TrimTaskBuilder.MatchCutNotchOffset¶

Returns or sets the match cut notch offset dimension of the trim task

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

Getter Method

Signature MatchCutNotchOffset

Returns:	notch offset from trim line
Return type:	float

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature MatchCutNotchOffset

Parameters:	notchOffset (float) – notch offset from trim line

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

MatchCutOffsetFromPlane¶

TrimTaskBuilder.MatchCutOffsetFromPlane¶

Returns or sets the match cut offset from plane dimension of the trim task

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

Getter Method

Signature MatchCutOffsetFromPlane

Returns:	offset from scrap cutter plane
Return type:	float

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature MatchCutOffsetFromPlane

Parameters:	offsetFromPlane (float) – offset from scrap cutter plane

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

MatchCutOffsetLength¶

TrimTaskBuilder.MatchCutOffsetLength¶

Returns or sets the match cut offset length dimension of the trim task

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

Getter Method

Signature MatchCutOffsetLength

Returns:	length of offset piece
Return type:	float

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature MatchCutOffsetLength

Parameters:	offsetLength (float) – length of offset piece

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

MatchCutScrapCutterLength¶

TrimTaskBuilder.MatchCutScrapCutterLength¶

Returns or sets the match cut scrap cutter length dimension of the trim task

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

Getter Method

Signature MatchCutScrapCutterLength

Returns:	entension line length
Return type:	float

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature MatchCutScrapCutterLength

Parameters:	scrapCutterLength (float) – entension line length

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

MatchCutSecondRadius¶

TrimTaskBuilder.MatchCutSecondRadius¶

Returns or sets the match cut second radius dimension of the trim task

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

Getter Method

Signature MatchCutSecondRadius

Returns:	second radius after notch
Return type:	float

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature MatchCutSecondRadius

Parameters:	secondRadius (float) – second radius after notch

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

MatchCutThirdRadius¶

TrimTaskBuilder.MatchCutThirdRadius¶

Returns or sets the match cut third radius dimension of the trim task

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

Getter Method

Signature MatchCutThirdRadius

Returns:	radius between offset piece and entension line
Return type:	float

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature MatchCutThirdRadius

Parameters:	thirdRadius (float) – radius between offset piece and entension line

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

MatchCutType¶

TrimTaskBuilder.MatchCutType¶

Returns or sets the match cut type of the trim task

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

Getter Method

Signature MatchCutType

Returns:
Return type:	`NXOpen.Die.TrimTaskBuilderMatchCutTypes`

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature MatchCutType

Parameters:	matchCutType (`NXOpen.Die.TrimTaskBuilderMatchCutTypes`) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

ReverseTrimSide¶

TrimTaskBuilder.ReverseTrimSide¶

Returns or sets the reverse trim side setting of the trim task.

True indicates that the trim side should be reversed.

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

Getter Method

Signature ReverseTrimSide

Returns:
Return type:	bool

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature ReverseTrimSide

Parameters:	reverse (bool) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

StartPlane¶

TrimTaskBuilder.StartPlane¶

Returns or sets the start plane of the trim task

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

Getter Method

Signature StartPlane

Returns:
Return type:	`NXOpen.ISurface`

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature StartPlane

Parameters:	startPlane (`NXOpen.ISurface`) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

TippedProduct¶

TrimTaskBuilder.TippedProduct¶

Returns or sets the tipped product of the trim task

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

Getter Method

Signature TippedProduct

Returns:	The tip of the operation where the trim

task resides. :rtype: NXOpen.Features.Feature

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature TippedProduct

Parameters:	tippedProduct (`NXOpen.Features.Feature`) – The tip of the operation where the trim task resides.

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

TrimNewDieFace¶

TrimTaskBuilder.TrimNewDieFace¶

Returns or sets the trim new die face, from NX10.

0 new stamping output can import one new die face to die engineer process. If this trim task will trim this new die face, set newDieFace to true, or else set it to false.

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

Getter Method

Signature TrimNewDieFace

Returns:	if trim task performs on new die face, this will be true, or else this will be false.
Return type:	bool

New in version NX10.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

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

Setter Method

Signature TrimNewDieFace

Parameters:	newDieFace (bool) – if set to true, trim task performs on new die face, or else it will perform on original die face.

New in version NX10.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

Method Detail¶

CheckAndMovePlanes¶

TrimTaskBuilder.CheckAndMovePlanes¶

Move end planes if the position of Trim Task is changed.

Signature CheckAndMovePlanes(origTip, targetTip, origStartPlaneTag, origEndPlaneTag)

Parameters:	origTip (`NXOpen.Features.Feature`) – Original Die Tip. targetTip (`NXOpen.Features.Feature`) – Die Tip in the target operation. origStartPlaneTag (`NXOpen.ISurface`) – Original start plane. origEndPlaneTag (`NXOpen.ISurface`) – Original end plane.
Returns:	a tuple
Return type:	A tuple consisting of (targetStartPlaneTag, targetEndPlaneTag). targetStartPlaneTag is a `NXOpen.ISurface`. Start plane in target operation. targetEndPlaneTag is a `NXOpen.ISurface`. End plane in target operation.

New in version NX8.5.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetAssociativeObjects¶

TrimTaskBuilder.GetAssociativeObjects¶

Gets the associative objects of the trim task

Signature GetAssociativeObjects()

Returns:
Return type:	list of `NXOpen.DisplayableObject`

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetCameraLayerAndXmlp¶

TrimTaskBuilder.GetCameraLayerAndXmlp¶

Gets the camera layer settings and xmlp data

Signature GetCameraLayerAndXmlp()

Returns:	a tuple
Return type:	A tuple consisting of (layerSettings, xmlpData) layerSettings is a list of str. 1 layer setting string for each camera object. the string needs to be 256 characters long (one for each user layer) with either 0 for off or 1 for on. xmlpData is a list of str. xmlp data

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetCameraNames¶

TrimTaskBuilder.GetCameraNames¶

Gets the names of the camera

Signature GetCameraNames()

Returns:	each string contains the name of a camera object
Return type:	list of str

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetCameraViews¶

TrimTaskBuilder.GetCameraViews¶

Gets the camera views of the trim task

Signature GetCameraViews()

Returns:
Return type:	list of `NXOpen.View`

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetDetails¶

TrimTaskBuilder.GetDetails¶

Gets the detailed description of the trim task

Signature GetDetails()

Returns:	detail strings
Return type:	list of str

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetScrapCutters¶

TrimTaskBuilder.GetScrapCutters¶

Gets the scrap cutters of the trim task

Signature GetScrapCutters()

Returns:
Return type:	list of `NXOpen.ISurface`

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

GetTrimBounds¶

TrimTaskBuilder.GetTrimBounds¶

Gets the trim bounds of the trim task

Signature GetTrimBounds()

Returns:	a tuple
Return type:	A tuple consisting of (profileEntries, direction). profileEntries is a list of `NXOpen.IProfile`. Profile entries that make up the boundary of the trim task direction is a `NXOpen.Die.DirectionOption`. Profile direction

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetAssociativeObjects¶

TrimTaskBuilder.SetAssociativeObjects¶

Sets the associative objects of the trim task

Signature SetAssociativeObjects(objects)

Parameters:	objects (list of `NXOpen.DisplayableObject`) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetCameraLayerAndXmlp¶

TrimTaskBuilder.SetCameraLayerAndXmlp¶

Sets the camera layer settings and xmlp data

Signature SetCameraLayerAndXmlp(layerSettings, xmlpData)

Parameters:	layerSettings (list of str) – 1 layer setting string for each camera object. the string needs to be 256 characters long (one for each user layer) with either 0 for off or 1 for on. xmlpData (list of str) – xmlp data

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetCameraNames¶

TrimTaskBuilder.SetCameraNames¶

Sets the names of the camera

Signature SetCameraNames(strings)

Parameters:	strings (list of str) – each string contains the name of a camera object

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetCameraViews¶

TrimTaskBuilder.SetCameraViews¶

Sets the camera views of the trim task

Signature SetCameraViews(objects)

Parameters:	objects (list of `NXOpen.View`) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetDetails¶

TrimTaskBuilder.SetDetails¶

Sets the detailed description of the trim task

Signature SetDetails(strings)

Parameters:	strings (list of str) – detail strings

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetScrapCutters¶

TrimTaskBuilder.SetScrapCutters¶

Sets the scrap cutters of the trim task

Signature SetScrapCutters(planes)

Parameters:	planes (list of `NXOpen.ISurface`) –

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

SetTrimBounds¶

TrimTaskBuilder.SetTrimBounds¶

Sets the trim bounds of the trim task.

Note - Die.TrimTaskBuilder.TippedProduct() needs to be called before this function.

Signature SetTrimBounds(direction, profileEntries)

Parameters:	direction (`NXOpen.Die.DirectionOption`) – Profile direction profileEntries (list of `NXOpen.IProfile`) – Profile entries that make up the boundary of the trim task

New in version NX4.0.0.

License requirements: die_engineering (“DIE ENGINEERING”)

Validate¶

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