WeldJointBuilder Class¶

class NXOpen.Weld.WeldJointBuilder¶

Bases: NXOpen.Weld.StructureWeldBuilder

Used to create or edit a NXOpen.Weld.WeldJoint feature.

To create a new instance of this class, use NXOpen.Weld.WeldManager.CreateJointBuilder()

Default values.

Property	Value
NumberSegments	2
SplitAngle	5.0

New in version NX8.0.0.

Properties¶

Property	Description
AssociativeSplit	Returns or sets whether split joints should be associative
BackingFace	Returns the backing face.
BossColorFontWidth	Returns the color, font, and width of the boss joint curves.
ButtColor	Returns or sets the color for butt weld type joints
ButtColorFontWidth	Returns the color, font, and width of the butt joint curves.
ButtFont	Returns or sets the curve font for butt weld type joints
ButtWidth	Returns or sets the curve with for butt weld type joints
CombineConnectedJoints	Returns or sets the indication to combine connected joints if they belong to the same body
CornerColorFontWidth	Returns the color, font, and width of the corner joint curves.
CreateMethod	Returns or sets the creation method
CreatedApplication	Returns or sets the application where joint is created
Destination	Returns or sets the destination to create new joints
DuplicateCheck	Returns or sets the indication to not allow new joints to be created if they are duplicates of exising joints
FilletColor	Returns or sets the color for T-joint weld type joints
FilletFont	Returns or sets the curve font for T-joint weld type joints
FilletWidth	Returns or sets the curve with for T-joint weld type joints
Joint	Returns the welding joint curves.
JointList	Returns the list of `NXOpen.Weld.JointItemBuilder` objects.
JointPrefix	Returns or sets the prefix for the weld ID attribute, and the prefix for the name of the component if `NXOpen.Weld.WeldJointBuilderDestinationTypes` is :py:class:` NXOpen.Weld.WeldJointBuilderDestinationTypes.NewComponent < NXOpen.Weld.WeldJointBuilderDestinationTypes>`
LapColorFontWidth	Returns the color, font, and width of the lap joint curves.
LimitList	Returns the list of limit builders.
Limits	Returns the limits of the joint curve span.
MasterEdge	Returns the master edge of a fillet weld.
MaximumFaceGap	Returns or sets the maximum face gap used when determining if two bodies intersect.
MechanicalColorFontWidth	Returns the color, font, and width of the mechanical joint curves.
NamePrefix	Returns or sets the prefix used for the welding joint Design Feature name in Collaborative Product Development mode
NumberSegments	Returns or sets the number of segments to divide a joint when using :py:class:` NXOpen.Weld.WeldJointBuilderSplitTypes.EqualSegments < NXOpen.Weld.WeldJointBuilderSplitTypes>`.
PlacementFace	Returns the placement face of a fillet weld.
PrimaryEdge	Returns the primary edge of a butt weld.
PrimaryFace	Returns the primary face of a butt weld.
SecondaryEdge	Returns the secondary edge of a butt weld.
SecondaryFace	Returns the secondary face of a butt weld.
ShipComponent	Returns the components on which the welding joints will be created.
SleeveColorFontWidth	Returns the color, font, and width of the sleeve joint curves.
SocketColorFontWidth	Returns the color, font, and width of the socket joint curves.
SpacingLength	Returns or sets the spacing length when using :py:class:` NXOpen.Weld.WeldJointBuilderSplitTypes.Skip < NXOpen.Weld.WeldJointBuilderSplitTypes>`.
SplitAngle	Returns or sets the split angle to divide a joint when using :py:class:` NXOpen.Weld.WeldJointBuilderSplitTypes.Angle < NXOpen.Weld.WeldJointBuilderSplitTypes>`.
SplitLength	Returns or sets the segment length when using :py:class:` NXOpen.Weld.WeldJointBuilderSplitTypes.Skip < NXOpen.Weld.WeldJointBuilderSplitTypes>`.
SplitOption	Returns or sets the method used to split the joint
SubsetPart	Returns or sets the subset part where Design Control Elements are to be created
TJointColorFontWidth	Returns the color, font, and width of the T-joint curves.
Tag	Returns the Tag for this object.
TargetFace	Returns the target face of a fillet weld.
Type	Returns or sets the creation type
WeldType	Returns or sets the weld type
WeldingCharacteristics	Returns the collection of welding characteristics defined by attributes.
WorkPart	Returns or sets the saved work part

Methods¶

Method	Description
AddCharacteristicsInheritaceInformation	Add welding characteristics inheritance information.
Commit	Commits any edits that have been applied to the builder.
CopyLimits	Copy input limits to builder limits
CreateLimitsPath	Creates the path to be used for the limits.
CreateSingleJointFromFeature	Creates a joint from a feature.
Delete	Deletes all joints set by `NXOpen.Weld.WeldJointBuilder.Joint()`.
DeleteAllUnMarkedJoints	Deletes any joints that were not marked with a call to `NXOpen.Weld.WeldJointBuilder.MarkJointsToKeep()`.
DeleteCharacteristicsInheritaceInformation	Delete welding characteristics inheritance information.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
FindPortsInParts	Gets ports from the parts.
GetAngleBetween	Gets the angle between the fillet weld mold faces, and the target faces, or butt weld primary and secondary faces.
GetCommittedComponents	This method returns the component parts that are created by `Builder.Commit()`.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetConnectedParts	Gets connected parts for joint.
GetIsLongPoint	Gets the long point status.
GetJointChanged	Indicates whether joint was changed.
GetJointLimits	Get the limits of an individual joint.
GetMidPointInformation	Gets the joint curve mid point, tangent, and face normals at the mid point from the primary and secondary bodies.
GetNewlyCreatedJoints	Gets the `NXOpen.Weld.JointItemBuilder` objects and curves which were just created by `NXOpen.Weld.WeldJointBuilder.ShowJoints()`.
GetObject	Returns the object currently being edited by this builder.
GetPrimaryThickness	Gets the primary thickness for a specified joint
GetSecondaryThickness	Gets the primary secondary for a specified joint
GetSingleJoint	Gets the `NXOpen.Weld.JointItemBuilder` object associated to the input curve.
GetVariableBevelAngles	Gets variable bevel angles.
IsCornerOpen	Returns status value of true if corner joint is an open case which means the placement face only touches the target face at the master edge.
IsPipeJoint	Returns status value of true if this is a pipe welding joint.
MarkJointsToKeep	Marks all currently created welding joints so they do not get deleted when `NXOpen.Weld.WeldJointBuilder.DeleteAllUnMarkedJoints()` is called from the dialog.
NewItem	Creates a `NXOpen.Weld.JointItemBuilder` object.
SetCallbackMessage	Sets a message to display after callback processing ends
SetErrorMessage	Sets an error message to display
SetJointChanged	Indicate that joint was changed.
SetVariableBevelAngles	This method is for use with the variable bevel callback.
ShowJoints	Show joints will create joints using the method set by `NXOpen.Weld.WeldJointBuilderTypes`.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Split	Splits all joints set by `NXOpen.Weld.WeldJointBuilder.Joint()` defined by `NXOpen.Weld.WeldJointBuilderSplitTypes`.
UpdateCollectors	Updates the main collectors by copying data from Joint.
UpdateJointAfterLimitsChange	Updates the joint curve after the limits change.
UpdateJointType	Updates all joints set by `NXOpen.Weld.WeldJointBuilder.Joint()` to have the given type.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations¶

WeldJointBuilderApplication Enumeration	Application where joints are created.
WeldJointBuilderCoordinateSystem Enumeration	Coordinate system specification.
WeldJointBuilderDestinationTypes Enumeration	Where to create new joints.
WeldJointBuilderSplitTypes Enumeration	Joint splitting options.
WeldJointBuilderTypes Enumeration	Creation method.
WeldJointBuilderWeldTypes Enumeration	Weld types.

Structs¶

WeldJointBuilderJointMidPointData_Struct Struct

Joint evaluation information at the mid point.

Property Detail¶

AssociativeSplit¶

WeldJointBuilder.AssociativeSplit¶

Returns or sets whether split joints should be associative

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

Getter Method

Signature AssociativeSplit

Returns:
Return type:	bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature AssociativeSplit

Parameters:	status (bool) –

New in version NX11.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

BackingFace¶

WeldJointBuilder.BackingFace¶

Returns the backing face.

This should only be used when creating a NXOpen.Weld.WeldJoint feature. When editing a feature the NXOpen.Weld.JointItemBuilder.BackingFace() of the NXOpen.Weld.JointItemBuilder should be used to access the data.

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

Getter Method

Signature BackingFace

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX9.0.0.

License requirements: None.

BossColorFontWidth¶

WeldJointBuilder.BossColorFontWidth¶

Returns the color, font, and width of the boss joint curves.

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

Getter Method

Signature BossColorFontWidth

Returns:
Return type:	`NXOpen.LineColorFontWidthBuilder`

New in version NX10.0.0.

License requirements: None.

ButtColor¶

WeldJointBuilder.ButtColor¶

Returns or sets the color for butt weld type joints

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

Getter Method

Signature ButtColor

Returns:
Return type:	int

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ButtColor

Parameters:	color (int) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

ButtColorFontWidth¶

WeldJointBuilder.ButtColorFontWidth¶

Returns the color, font, and width of the butt joint curves.

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

Getter Method

Signature ButtColorFontWidth

Returns:
Return type:	`NXOpen.LineColorFontWidthBuilder`

New in version NX9.0.0.

License requirements: None.

ButtFont¶

WeldJointBuilder.ButtFont¶

Returns or sets the curve font for butt weld type joints

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

Getter Method

Signature ButtFont

Returns:
Return type:	`NXOpen.DisplayableObjectObjectFont`

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ButtFont

Parameters:	font (`NXOpen.DisplayableObjectObjectFont`) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

ButtWidth¶

WeldJointBuilder.ButtWidth¶

Returns or sets the curve with for butt weld type joints

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

Getter Method

Signature ButtWidth

Returns:
Return type:	`NXOpen.DisplayableObjectObjectWidth`

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ButtWidth

Parameters:	width (`NXOpen.DisplayableObjectObjectWidth`) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

CombineConnectedJoints¶

WeldJointBuilder.CombineConnectedJoints¶

Returns or sets the indication to combine connected joints if they belong to the same body

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

Getter Method

Signature CombineConnectedJoints

Returns:
Return type:	bool

New in version NX9.0.2.

License requirements: None.

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

Setter Method

Signature CombineConnectedJoints

Parameters:	status (bool) –

New in version NX9.0.2.

License requirements: structure_weld (“STRUCTURE WELD”)

CornerColorFontWidth¶

WeldJointBuilder.CornerColorFontWidth¶

Returns the color, font, and width of the corner joint curves.

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

Getter Method

Signature CornerColorFontWidth

Returns:
Return type:	`NXOpen.LineColorFontWidthBuilder`

New in version NX9.0.0.

License requirements: None.

CreateMethod¶

WeldJointBuilder.CreateMethod¶

Returns or sets the creation method

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

Getter Method

Signature CreateMethod

Returns:
Return type:	`NXOpen.Weld.WeldJointBuilderTypes`

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature CreateMethod

Parameters:	type (`NXOpen.Weld.WeldJointBuilderTypes`) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

CreatedApplication¶

WeldJointBuilder.CreatedApplication¶

Returns or sets the application where joint is created

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

Getter Method

Signature CreatedApplication

Returns:
Return type:	`NXOpen.Weld.WeldJointBuilderApplication`

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature CreatedApplication

Parameters:	application (`NXOpen.Weld.WeldJointBuilderApplication`) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

Destination¶

WeldJointBuilder.Destination¶

Returns or sets the destination to create new joints

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

Getter Method

Signature Destination

Returns:
Return type:	`NXOpen.Weld.WeldJointBuilderDestinationTypes`

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Destination

Parameters:	type (`NXOpen.Weld.WeldJointBuilderDestinationTypes`) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

DuplicateCheck¶

WeldJointBuilder.DuplicateCheck¶

Returns or sets the indication to not allow new joints to be created if they are duplicates of exising joints

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

Getter Method

Signature DuplicateCheck

Returns:
Return type:	bool

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature DuplicateCheck

Parameters:	status (bool) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

FilletColor¶

WeldJointBuilder.FilletColor¶

Returns or sets the color for T-joint weld type joints

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

Getter Method

Signature FilletColor

Returns:
Return type:	int

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature FilletColor

Parameters:	color (int) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

FilletFont¶

WeldJointBuilder.FilletFont¶

Returns or sets the curve font for T-joint weld type joints

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

Getter Method

Signature FilletFont

Returns:
Return type:	`NXOpen.DisplayableObjectObjectFont`

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature FilletFont

Parameters:	font (`NXOpen.DisplayableObjectObjectFont`) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

FilletWidth¶

WeldJointBuilder.FilletWidth¶

Returns or sets the curve with for T-joint weld type joints

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

Getter Method

Signature FilletWidth

Returns:
Return type:	`NXOpen.DisplayableObjectObjectWidth`

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature FilletWidth

Parameters:	width (`NXOpen.DisplayableObjectObjectWidth`) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

Joint¶

WeldJointBuilder.Joint¶

Returns the welding joint curves.

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

Getter Method

Signature Joint

Returns:
Return type:	`NXOpen.SelectCurveList`

New in version NX8.0.0.

License requirements: None.

JointList¶

WeldJointBuilder.JointList¶

Returns the list of NXOpen.Weld.JointItemBuilder objects.

When editing a NXOpen.Weld.WeldJoint the NXOpen.Weld.WeldJointBuilder.Joint() should be used to access the output curves of the feature. NXOpen.Weld.WeldJointBuilder.GetSingleJoint() is then used to access the NXOpen.Weld.JointItemBuilder from the curve.

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

Getter Method

Signature JointList

Returns:
Return type:	`NXOpen.Weld.JointItemBuilderList`

New in version NX8.0.0.

License requirements: None.

JointPrefix¶

WeldJointBuilder.JointPrefix¶

Returns or sets the prefix for the weld ID attribute, and the prefix for the name of the component if NXOpen.Weld.WeldJointBuilderDestinationTypes is :py:class:` NXOpen.Weld.WeldJointBuilderDestinationTypes.NewComponent < NXOpen.Weld.WeldJointBuilderDestinationTypes>`

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

Getter Method

Signature JointPrefix

Returns:
Return type:	str

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature JointPrefix

Parameters:	prefix (str) –

New in version NX8.5.0.

License requirements: structure_weld (“STRUCTURE WELD”)

LapColorFontWidth¶

WeldJointBuilder.LapColorFontWidth¶

Returns the color, font, and width of the lap joint curves.

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

Getter Method

Signature LapColorFontWidth

Returns:
Return type:	`NXOpen.LineColorFontWidthBuilder`

New in version NX9.0.0.

License requirements: None.

LimitList¶

WeldJointBuilder.LimitList¶

Returns the list of limit builders.

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

Getter Method

Signature LimitList

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

New in version NX8.0.0.

License requirements: None.

Limits¶

WeldJointBuilder.Limits¶

Returns the limits of the joint curve span.

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

Getter Method

Signature Limits

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

New in version NX8.0.0.

License requirements: None.

MasterEdge¶

WeldJointBuilder.MasterEdge¶

Returns the master edge of a fillet weld.

This should only be used when creating a NXOpen.Weld.WeldJoint feature. When editing a feature the NXOpen.Weld.JointItemBuilder.MasterEdge() of the NXOpen.Weld.JointItemBuilder should be used to access the data.

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

Getter Method

Signature MasterEdge

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX8.0.0.

License requirements: None.

MaximumFaceGap¶

WeldJointBuilder.MaximumFaceGap¶

Returns or sets the maximum face gap used when determining if two bodies intersect.

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

Getter Method

Signature MaximumFaceGap

Returns:
Return type:	float

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature MaximumFaceGap

Parameters:	gapValue (float) –

New in version NX9.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

MechanicalColorFontWidth¶

WeldJointBuilder.MechanicalColorFontWidth¶

Returns the color, font, and width of the mechanical joint curves.

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

Getter Method

Signature MechanicalColorFontWidth

Returns:
Return type:	`NXOpen.LineColorFontWidthBuilder`

New in version NX9.0.0.

License requirements: None.

NamePrefix¶

WeldJointBuilder.NamePrefix¶

Returns or sets the prefix used for the welding joint Design Feature name in Collaborative Product Development mode

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

Getter Method

Signature NamePrefix

Returns:
Return type:	str

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature NamePrefix

Parameters:	prefix (str) –

New in version NX8.5.0.

License requirements: structure_weld (“STRUCTURE WELD”)

NumberSegments¶

WeldJointBuilder.NumberSegments¶

Returns or sets the number of segments to divide a joint when using :py:class:` NXOpen.Weld.WeldJointBuilderSplitTypes.EqualSegments < NXOpen.Weld.WeldJointBuilderSplitTypes>`.

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

Getter Method

Signature NumberSegments

Returns:
Return type:	int

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature NumberSegments

Parameters:	numberSegments (int) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

PlacementFace¶

WeldJointBuilder.PlacementFace¶

Returns the placement face of a fillet weld.

For example, on a profile it is the face that touches the plate. This should only be used when creating a NXOpen.Weld.WeldJoint feature. When editing a feature the NXOpen.Weld.JointItemBuilder.PlacementFace() of the NXOpen.Weld.JointItemBuilder should be used to access the data.

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

Getter Method

Signature PlacementFace

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX8.0.0.

License requirements: None.

PrimaryEdge¶

WeldJointBuilder.PrimaryEdge¶

Returns the primary edge of a butt weld.

This should only be used when creating a NXOpen.Weld.WeldJoint feature. When editing a feature the NXOpen.Weld.JointItemBuilder.PrimaryEdge() of the NXOpen.Weld.JointItemBuilder should be used to access the data.

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

Getter Method

Signature PrimaryEdge

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX8.0.0.

License requirements: None.

PrimaryFace¶

WeldJointBuilder.PrimaryFace¶

Returns the primary face of a butt weld.

This should only be used when creating a NXOpen.Weld.WeldJoint feature. When editing a feature the NXOpen.Weld.JointItemBuilder.PrimaryFace() of the NXOpen.Weld.JointItemBuilder should be used to access the data.

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

Getter Method

Signature PrimaryFace

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX8.0.0.

License requirements: None.

SecondaryEdge¶

WeldJointBuilder.SecondaryEdge¶

Returns the secondary edge of a butt weld.

This should only be used when creating a NXOpen.Weld.WeldJoint feature. When editing a feature the NXOpen.Weld.JointItemBuilder.SecondaryEdge() of the NXOpen.Weld.JointItemBuilder should be used to access the data.

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

Getter Method

Signature SecondaryEdge

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX8.0.0.

License requirements: None.

SecondaryFace¶

WeldJointBuilder.SecondaryFace¶

Returns the secondary face of a butt weld.

This should only be used when creating a NXOpen.Weld.WeldJoint feature. When editing a feature the NXOpen.Weld.JointItemBuilder.SecondaryFace() of the NXOpen.Weld.JointItemBuilder should be used to access the data.

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

Getter Method

Signature SecondaryFace

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX8.0.0.

License requirements: None.

ShipComponent¶

WeldJointBuilder.ShipComponent¶

Returns the components on which the welding joints will be created.

Used when NXOpen.Weld.WeldJointBuilderTypes. is set to :py:class:` NXOpen.Weld.WeldJointBuilderTypes.CreateAutomatic < NXOpen.Weld.WeldJointBuilderTypes>` or :py:class:` NXOpen.Weld.WeldJointBuilderTypes.CreateAttributes < NXOpen.Weld.WeldJointBuilderTypes>` After setting the components, NXOpen.Weld.WeldJointBuilder.ShowJoints() should be called to create the welding joints.

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

Getter Method

Signature ShipComponent

Returns:
Return type:	`NXOpen.SelectNXObjectList`

New in version NX8.0.0.

License requirements: None.

SleeveColorFontWidth¶

WeldJointBuilder.SleeveColorFontWidth¶

Returns the color, font, and width of the sleeve joint curves.

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

Getter Method

Signature SleeveColorFontWidth

Returns:
Return type:	`NXOpen.LineColorFontWidthBuilder`

New in version NX10.0.0.

License requirements: None.

SocketColorFontWidth¶

WeldJointBuilder.SocketColorFontWidth¶

Returns the color, font, and width of the socket joint curves.

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

Getter Method

Signature SocketColorFontWidth

Returns:
Return type:	`NXOpen.LineColorFontWidthBuilder`

New in version NX9.0.0.

License requirements: None.

SpacingLength¶

WeldJointBuilder.SpacingLength¶

Returns or sets the spacing length when using :py:class:` NXOpen.Weld.WeldJointBuilderSplitTypes.Skip < NXOpen.Weld.WeldJointBuilderSplitTypes>`.

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

Getter Method

Signature SpacingLength

Returns:
Return type:	float

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature SpacingLength

Parameters:	length (float) –

New in version NX9.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

SplitAngle¶

WeldJointBuilder.SplitAngle¶

Returns or sets the split angle to divide a joint when using :py:class:` NXOpen.Weld.WeldJointBuilderSplitTypes.Angle < NXOpen.Weld.WeldJointBuilderSplitTypes>`.

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

Getter Method

Signature SplitAngle

Returns:
Return type:	float

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature SplitAngle

Parameters:	angle (float) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

SplitLength¶

WeldJointBuilder.SplitLength¶

Returns or sets the segment length when using :py:class:` NXOpen.Weld.WeldJointBuilderSplitTypes.Skip < NXOpen.Weld.WeldJointBuilderSplitTypes>`.

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

Getter Method

Signature SplitLength

Returns:
Return type:	float

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature SplitLength

Parameters:	length (float) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

SplitOption¶

WeldJointBuilder.SplitOption¶

Returns or sets the method used to split the joint

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

Getter Method

Signature SplitOption

Returns:
Return type:	`NXOpen.Weld.WeldJointBuilderSplitTypes`

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature SplitOption

Parameters:	option (`NXOpen.Weld.WeldJointBuilderSplitTypes`) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

SubsetPart¶

WeldJointBuilder.SubsetPart¶

Returns or sets the subset part where Design Control Elements are to be created

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

Getter Method

Signature SubsetPart

Returns:
Return type:	`NXOpen.Part`

New in version NX9.0.1.

License requirements: None.

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

Setter Method

Signature SubsetPart

Parameters:	part (`NXOpen.Part`) –

New in version NX9.0.1.

License requirements: structure_weld (“STRUCTURE WELD”)

TJointColorFontWidth¶

WeldJointBuilder.TJointColorFontWidth¶

Returns the color, font, and width of the T-joint curves.

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

Getter Method

Signature TJointColorFontWidth

Returns:
Return type:	`NXOpen.LineColorFontWidthBuilder`

New in version NX9.0.0.

License requirements: None.

TargetFace¶

WeldJointBuilder.TargetFace¶

Returns the target face of a fillet weld.

For example, the plate face that the profile lies on. This should only be used when creating a NXOpen.Weld.WeldJoint feature. When editing a feature the NXOpen.Weld.JointItemBuilder.TargetFace() of the NXOpen.Weld.JointItemBuilder should be used to access the data.

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

Getter Method

Signature TargetFace

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX8.0.0.

License requirements: None.

Type¶

WeldJointBuilder.Type¶

Returns or sets the creation type

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

Getter Method

Signature Type

Returns:
Return type:	`NXOpen.Weld.WeldJointBuilderTypes`

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Type

Parameters:	type (`NXOpen.Weld.WeldJointBuilderTypes`) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

WeldType¶

WeldJointBuilder.WeldType¶

Returns or sets the weld type

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

Getter Method

Signature WeldType

Returns:
Return type:	`NXOpen.Weld.WeldJointBuilderWeldTypes`

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature WeldType

Parameters:	type (`NXOpen.Weld.WeldJointBuilderWeldTypes`) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

WeldingCharacteristics¶

WeldJointBuilder.WeldingCharacteristics¶

Returns the collection of welding characteristics defined by attributes.

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

Getter Method

Signature WeldingCharacteristics

Returns:
Return type:	`NXOpen.Weld.CharacteristicsBuilder`

New in version NX8.0.0.

License requirements: None.

WorkPart¶

WeldJointBuilder.WorkPart¶

Returns or sets the saved work part

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

Getter Method

Signature WorkPart

Returns:
Return type:	`NXOpen.Part`

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature WorkPart

Parameters:	part (`NXOpen.Part`) –

New in version NX8.5.0.

License requirements: structure_weld (“STRUCTURE WELD”)

Method Detail¶

AddCharacteristicsInheritaceInformation¶

WeldJointBuilder.AddCharacteristicsInheritaceInformation¶

Add welding characteristics inheritance information.

Signature AddCharacteristicsInheritaceInformation()

New in version NX10.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

CopyLimits¶

WeldJointBuilder.CopyLimits¶

Copy input limits to builder limits

Signature CopyLimits(limits)

Parameters:	limits (`NXOpen.Die.DieLimitsBuilder`) – limits to copy

New in version NX8.5.0.

License requirements: None.

CreateLimitsPath¶

WeldJointBuilder.CreateLimitsPath¶

Creates the path to be used for the limits.

Signature CreateLimitsPath(jointCurve)

Parameters:	jointCurve (`NXOpen.Curve`) – Joint curve used to create path.
Returns:	Resulting path.
Return type:	`NXOpen.Curve`

New in version NX8.0.0.

License requirements: None.

CreateSingleJointFromFeature¶

WeldJointBuilder.CreateSingleJointFromFeature¶

Creates a joint from a feature.

Signature CreateSingleJointFromFeature(featureCurve, updateBuilder)

Parameters:	featureCurve (`NXOpen.Curve`) – Weld Joint feature curve updateBuilder (bool) – indicates where builder should be updated with information from the feature

New in version NX8.0.0.

License requirements: None.

Delete¶

WeldJointBuilder.Delete¶

Deletes all joints set by NXOpen.Weld.WeldJointBuilder.Joint().

Signature Delete()

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

DeleteAllUnMarkedJoints¶

WeldJointBuilder.DeleteAllUnMarkedJoints¶

Deletes any joints that were not marked with a call to NXOpen.Weld.WeldJointBuilder.MarkJointsToKeep().

Signature DeleteAllUnMarkedJoints()

New in version NX8.5.0.

License requirements: structure_weld (“STRUCTURE WELD”)

DeleteCharacteristicsInheritaceInformation¶

WeldJointBuilder.DeleteCharacteristicsInheritaceInformation¶

Delete welding characteristics inheritance information.

Signature DeleteCharacteristicsInheritaceInformation()

New in version NX10.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

FindPortsInParts¶

WeldJointBuilder.FindPortsInParts¶

Gets ports from the parts.

Signature FindPortsInParts(parts)

Parameters:	parts (list of `NXOpen.Part`) – the parts used to find the ports.
Returns:	the collection of ports in the parts
Return type:	list of `NXOpen.Routing.Port`

New in version NX10.0.0.

License requirements: None.

GetAngleBetween¶

WeldJointBuilder.GetAngleBetween¶

Gets the angle between the fillet weld mold faces, and the target faces, or butt weld primary and secondary faces.

Signature GetAngleBetween()

Returns:
Return type:	float

New in version NX8.0.0.

License requirements: None.

GetConnectedParts¶

WeldJointBuilder.GetConnectedParts¶

Gets connected parts for joint.

Only connected parts that are partially or fully loaded will be returned. Any components that are unloaded will not be returned.

Signature GetConnectedParts()

Returns:
Return type:	list of `NXOpen.Assemblies.Component`

New in version NX9.0.1.

License requirements: None.

GetIsLongPoint¶

WeldJointBuilder.GetIsLongPoint¶

Gets the long point status.

A long point indicates only trimming and no extension is needed to to meeting the body being welded to.

Signature GetIsLongPoint()

Returns:
Return type:	bool

New in version NX8.0.0.

License requirements: None.

GetJointChanged¶

WeldJointBuilder.GetJointChanged¶

Indicates whether joint was changed.

Signature GetJointChanged(curve)

Parameters:	curve (`NXOpen.Curve`) – Joint curve to check
Returns:
Return type:	bool

New in version NX8.0.0.

License requirements: None.

GetJointLimits¶

WeldJointBuilder.GetJointLimits¶

Get the limits of an individual joint.

Signature GetJointLimits(curve)

Parameters:	curve (`NXOpen.Curve`) –
Returns:
Return type:	`NXOpen.Die.DieLimitsBuilder`

New in version NX8.0.0.

License requirements: None.

GetMidPointInformation¶

WeldJointBuilder.GetMidPointInformation¶

Gets the joint curve mid point, tangent, and face normals at the mid point from the primary and secondary bodies.

Signature GetMidPointInformation(desiredCoordinateSystem)

Parameters:	desiredCoordinateSystem (`NXOpen.Weld.WeldJointBuilderCoordinateSystem`) – Coordinate system of data returned in jointMidPointData
Returns:	a tuple
Return type:	A tuple consisting of (success, jointMidPointData). success is a bool. Equals true if data was returned. jointMidPointData is a `NXOpen.Weld.WeldJointBuilderJointMidPointData_Struct`. The joint mid point, tangent and face normals.

New in version NX8.5.0.

License requirements: None.

GetNewlyCreatedJoints¶

WeldJointBuilder.GetNewlyCreatedJoints¶

Gets the NXOpen.Weld.JointItemBuilder objects and curves which were just created by NXOpen.Weld.WeldJointBuilder.ShowJoints().

Signature GetNewlyCreatedJoints()

Returns:	a tuple
Return type:	A tuple consisting of (curves, newItemBuilder). curves is a list of `NXOpen.Curve`. newItemBuilder is a list of `NXOpen.Weld.JointItemBuilder`.

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

GetPrimaryThickness¶

WeldJointBuilder.GetPrimaryThickness¶

Gets the primary thickness for a specified joint

Signature GetPrimaryThickness(curve)

Parameters:	curve (`NXOpen.Curve`) –
Returns:
Return type:	float

New in version NX8.0.0.

License requirements: None.

GetSecondaryThickness¶

WeldJointBuilder.GetSecondaryThickness¶

Gets the primary secondary for a specified joint

Signature GetSecondaryThickness(curve)

Parameters:	curve (`NXOpen.Curve`) –
Returns:
Return type:	float

New in version NX8.0.0.

License requirements: None.

GetSingleJoint¶

WeldJointBuilder.GetSingleJoint¶

Gets the NXOpen.Weld.JointItemBuilder object associated to the input curve.

Signature GetSingleJoint(curve)

Parameters:	curve (`NXOpen.Curve`) – Joint curve
Returns:
Return type:	`NXOpen.Weld.JointItemBuilder`

New in version NX8.0.0.

License requirements: None.

GetVariableBevelAngles¶

WeldJointBuilder.GetVariableBevelAngles¶

Gets variable bevel angles.

This method is for use with the variable bevel callback.

Signature GetVariableBevelAngles()

Returns:
Return type:	list of float

New in version NX8.5.0.

License requirements: None.

IsCornerOpen¶

WeldJointBuilder.IsCornerOpen¶

Returns status value of true if corner joint is an open case which means the placement face only touches the target face at the master edge.

Signature IsCornerOpen()

Returns:
Return type:	bool

New in version NX9.0.1.

License requirements: None.

IsPipeJoint¶

WeldJointBuilder.IsPipeJoint¶

Returns status value of true if this is a pipe welding joint.

Signature IsPipeJoint()

Returns:
Return type:	bool

New in version NX10.0.0.

License requirements: None.

MarkJointsToKeep¶

WeldJointBuilder.MarkJointsToKeep¶

Marks all currently created welding joints so they do not get deleted when NXOpen.Weld.WeldJointBuilder.DeleteAllUnMarkedJoints() is called from the dialog.

Signature MarkJointsToKeep()

New in version NX8.5.0.

License requirements: structure_weld (“STRUCTURE WELD”)

NewItem¶

WeldJointBuilder.NewItem¶

Creates a NXOpen.Weld.JointItemBuilder object.

Signature NewItem()

Returns:
Return type:	`NXOpen.Weld.JointItemBuilder`

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

SetCallbackMessage¶

WeldJointBuilder.SetCallbackMessage¶

Sets a message to display after callback processing ends

Signature SetCallbackMessage(message)

Parameters:	message (str) – Message to display to user

New in version NX8.5.0.

License requirements: structure_weld (“STRUCTURE WELD”)

SetErrorMessage¶

WeldJointBuilder.SetErrorMessage¶

Sets an error message to display

Signature SetErrorMessage(message)

Parameters:	message (str) – Message to display to user

New in version NX8.5.0.

License requirements: structure_weld (“STRUCTURE WELD”)

SetJointChanged¶

WeldJointBuilder.SetJointChanged¶

Indicate that joint was changed.

Signature SetJointChanged(curve, changed)

Parameters:	curve (`NXOpen.Curve`) – Joint curve to check changed (bool) –

New in version NX8.0.0.

License requirements: None.

SetVariableBevelAngles¶

WeldJointBuilder.SetVariableBevelAngles¶

This method is for use with the variable bevel callback.

Signature SetVariableBevelAngles(variableAngles)

Parameters:	variableAngles (list of float) – the variable angles.

New in version NX8.0.0.

License requirements: None.

ShowJoints¶

WeldJointBuilder.ShowJoints¶

Show joints will create joints using the method set by NXOpen.Weld.WeldJointBuilderTypes.

For :py:class:` NXOpen.Weld.WeldJointBuilderTypes.CreateAutomatic < NXOpen.Weld.WeldJointBuilderTypes>` and :py:class:` NXOpen.Weld.WeldJointBuilderTypes.CreateAttributes < NXOpen.Weld.WeldJointBuilderTypes>` components need to be set using NXOpen.Weld.WeldJointBuilder.ShipComponent(). For :py:class:` NXOpen.Weld.WeldJointBuilderTypes.CreateManual < NXOpen.Weld.WeldJointBuilderTypes>`, the following need to be set: When NXOpen.Weld.WeldJointBuilderWeldTypes is :py:class:` NXOpen.Weld.WeldJointBuilderWeldTypes.Fillet < NXOpen.Weld.WeldJointBuilderWeldTypes>`, the following methods need to be called to set the input data: NXOpen.Weld.WeldJointBuilder.MasterEdge(), NXOpen.Weld.WeldJointBuilder.PlacementFace(), NXOpen.Weld.WeldJointBuilder.TargetFace(). When NXOpen.Weld.WeldJointBuilderWeldTypes is :py:class:` NXOpen.Weld.WeldJointBuilderWeldTypes.Groove < NXOpen.Weld.WeldJointBuilderWeldTypes>`, the following methods need to be called to set the input data: NXOpen.Weld.WeldJointBuilder.PrimaryFace(), NXOpen.Weld.WeldJointBuilder.PrimaryEdge(), NXOpen.Weld.WeldJointBuilder.SecondaryFace(), NXOpen.Weld.WeldJointBuilder.SecondaryEdge().

Signature ShowJoints()

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

Split¶

WeldJointBuilder.Split¶

Splits all joints set by NXOpen.Weld.WeldJointBuilder.Joint() defined by NXOpen.Weld.WeldJointBuilderSplitTypes.

Signature Split()

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

UpdateCollectors¶

WeldJointBuilder.UpdateCollectors¶

Updates the main collectors by copying data from Joint.

Signature UpdateCollectors(jointCurve)

Parameters:	jointCurve (`NXOpen.Curve`) – Joint curve to use to update collectors

New in version NX8.0.0.

License requirements: None.

UpdateJointAfterLimitsChange¶

WeldJointBuilder.UpdateJointAfterLimitsChange¶

Overloaded method UpdateJointAfterLimitsChange

UpdateJointAfterLimitsChange()
UpdateJointAfterLimitsChange(limits)

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

Updates the joint curve after the limits change.

Signature UpdateJointAfterLimitsChange()

New in version NX8.0.0.

License requirements: None.

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

Updates the joint curve after the limits change.

Signature UpdateJointAfterLimitsChange(limits)

Parameters:	limits (`NXOpen.Die.DieLimitsBuilder`) – limits that changed

New in version NX8.0.0.

License requirements: None.

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

UpdateJointType¶

WeldJointBuilder.UpdateJointType¶

Updates all joints set by NXOpen.Weld.WeldJointBuilder.Joint() to have the given type.

Signature UpdateJointType(type)

Parameters:	type (`NXOpen.Weld.WeldJointBuilderWeldTypes`) –

New in version NX9.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

Validate¶

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