WeldPointBuilder Class¶
-
class
NXOpen.Weld.
WeldPointBuilder
¶ Bases:
NXOpen.Builder
Represents a Spot Weld feature
To create a new instance of this class, use
NXOpen.Weld.WeldManager.CreateWeldPointBuilder
Default values.
Property Value ConnectingOnlyOnePart false CreationDirection Default CsysAssemblyState false CsysWorkPartState false CustomCylinderAbove 0.5 (millimeters part), 0.02 (inches part) CustomRadius 0.5 (millimeters part), 0.02 (inches part) CustomTotalCylinderLength 1 (millimeters part), 0.04 (inches part) DatumFirstReferenceDirection X DatumMajorDirection X DatumSecondReferenceDirection X DistanceTolerance 0.025 (millimeters part), 0.001 (inches part) EndDistance 6.25 (millimeters part), 0.25 (inches part) EndDistanceLocation Length ExtendMethod Boundary Location AlongGuideEdge MeasurementDefaultHeight 10 (millimeters part), 0.4 (inches part) MeasurementDefaultWidth 3 (millimeters part), 0.12 (inches part) MeasurementHoleSize 0.0 (millimeters part), 0.0 (inches part) MeasurementSlotLength 0.0 (millimeters part), 0.0 (inches part) MeasurementSlotWidth 0.0 (millimeters part), 0.0 (inches part) MeasurementStudSize 0.0 (millimeters part), 0 (inches part) MirrorByType false NumberConnectedPanels 2 OffsetDistance 6.25 (millimeters part), 0.25 (inches part) OutputType Fixed PointMethod Multiple PointsGuideDistance 0.0 (millimeters part), 0.0 (inches part) ProjectionMethod None ReferenceSheetSpacingMethod Distance ReferenceSheetType Overlap ShowThroughAssemblyState false ShowThroughWorkPartState false SizeMethod Auto SolidType SolidNone SpacingCalculateMethod Arclength SpacingNumber 12.5 (millimeters part), 0.5 (inches part) StartDistance 6.25 (millimeters part), 0.25 (inches part) StartDistanceLocation Length TranslateXDistance 0 (millimeters part), 0 (inches part) TranslateYDistance 0 (millimeters part), 0 (inches part) TranslateZDistance 0 (millimeters part), 0 (inches part) WeldType ResistanceSpot New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
ConnectingOnlyOnePart | Returns or sets |
CreationDirection | Returns or sets the creation direction type. |
CsysAssemblyState | Returns or sets the assy coordinate system state |
CsysWorkPartState | Returns or sets the work coordinate systemstate |
CustomCylinderAbove | Returns or sets the distance the custom cylinder should be created above the weld point |
CustomRadius | Returns or sets the radius to create the sphere, cylinder, or cone with |
CustomTotalCylinderLength | Returns or sets the total length of the cylinder to be created. |
DatumFirstReferenceDirection | Returns or sets the datum reference direction type. |
DatumMajorDirection | Returns or sets the datum major direction type. |
DatumSecondReferenceDirection | Returns or sets the datum reference direction type. |
DistanceTolerance | Returns or sets the distance tolerance for the weld point |
EndDistance | Returns or sets the end dist |
EndDistanceLocation | Returns or sets the end dist location |
ExtendMethod | Returns or sets the offset curve extend method. |
Location | Returns or sets the processing method to use for generating weld points along reference section(s) |
MeasurementDefaultHeight | Returns or sets the default height of the object for measurement to be created. |
MeasurementDefaultWidth | Returns or sets the default width of the object for measurement to be created. |
MeasurementHoleSize | Returns or sets the hole_size of the object for measurement to be created. |
MeasurementSlotLength | Returns or sets the slot height of the object for measurement to be created. |
MeasurementSlotWidth | Returns or sets the slot width of the object for measurement to be created. |
MeasurementStudSize | Returns or sets the stud size of the object for measurement to be created. |
MirrorByType | Returns or sets the mirror by type |
MirrorPlane | Returns or sets the plane that a point is to be mirrored about. |
NumberConnectedPanels | Returns or sets the num connected panels. |
OffsetDistance | Returns or sets the offset distance from edges in guide_collector1 to place weld points |
OutputType | Returns or sets the output type. |
PointMethod | Returns or sets the method for creating weld points. |
PointsGuideDistance | Returns or sets the distance percentage from the start of the curve where the weld point should be. |
ProjectDirection | Returns or sets the project direction |
ProjectDirectionObject | Returns or sets the project direction NXOpen object |
ProjectionMethod | Returns or sets the project method type. |
ReferenceSheetSpacingMethod | Returns or sets the refsheet spacing method |
ReferenceSheetType | Returns or sets the type of sheet to create to place weld points on. |
SectionPlaneEntity | Returns or sets |
SequenceNumber | Returns or sets the sequence number for the weld point feature. |
ShowThroughAssemblyState | Returns or sets the through assy coordinate system state |
ShowThroughWorkPartState | Returns or sets the through work coordinate system state |
SizeMethod | Returns or sets the measurement size method. |
SolidType | Returns or sets the output solid type. |
SpacingCalculateMethod | Returns or sets the project method type. |
SpacingNumber | Returns or sets the spacing number |
StartDistance | Returns or sets the start dist |
StartDistanceLocation | Returns or sets the start dist location |
Tag | Returns the Tag for this object. |
TranslateCsys | Returns or sets the coordinate system that a point is to be translated about. |
TranslateXDistance | Returns or sets the tran x dist |
TranslateYDistance | Returns or sets the trans y dist |
TranslateZDistance | Returns or sets the translate distance for weld points in z axis direction. |
WeldType | Returns or sets the weld type. |
Methods¶
Method | Description |
---|---|
CalculateDatumMeasurementDefaultDirection | Calculate location and default direction of datum and measurement, need to set the current point prior to calling this method |
CalculateWeldPoints | To calculate all weld points |
ClearFaceSets | The clear for all existed facesets |
Commit | Commits any edits that have been applied to the builder. |
CommitFaceSets | |
CommitReferenceSheets | The commit for reference sheets |
CommitSection | Commit created section |
CreateCenterLine | To create center line @return |
CreateOffsetCurve | Create offset curve @return |
CreateSectionPlaneCurves | Create section curve @return section curve |
CreateSingleWeldPoint | The creation for single weld point |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
FlipZAxis | Flip the z axis |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetCsys | Get coordinate system for point |
GetCurrentReferenceSheet | The current refsheet @return |
GetFaceSet | Gets the user selected faces for the indicated face set |
GetFirstSection | Get the first section. |
GetMirrorTranslateReferenceObjects | Get mirror translate reference objects |
GetNumFaceSets | Get the amount of face sets @return total amount of face sets |
GetObject | Returns the object currently being edited by this builder. |
GetReferenceSheets | The refernence sheet feature @return the reference sheet |
GetSecondSection | Get the second section. |
GetSectionCurves | Gets the curves contained in the input section |
MovePoint | Move selected points |
ProjectPoints | Project selected points along the specified vector to reference sheets |
RemoveCharacteristics | Remove characteristics for selected points, need to set the current point prior to calling this method |
RemoveWeldPoint | Remove the current selected point, need to set the current point prior to calling this method |
SetCharacteristics | Set or edit characteristics for selected points |
SetCurrentReferenceSheet | Set current refsheet |
SetFaceSet | Sets the user selected faces for the indicated face set |
SetFirstSection | The commit for first section |
SetMirrorTranslateReferenceObjects | Add or remove mirror translate reference objects |
SetPoint | Set the selected point |
SetSecondSection | Create second section |
SetSelectionType | Set the selection type |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UpdateCsys | Update coordinate system for selected points |
UpdateFirstSection | Update first section |
UpdateSecondSection | Update second section |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
ConnectingOnlyOnePart¶
-
WeldPointBuilder.
ConnectingOnlyOnePart
¶ Returns or sets
-------------------------------------
Getter Method
Signature
ConnectingOnlyOnePart()
Returns: Return type: bool New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ConnectingOnlyOnePart(connectingOnlyOnePart)
Parameters: connectingOnlyOnePart (bool) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
CreationDirection¶
-
WeldPointBuilder.
CreationDirection
¶ Returns or sets the creation direction type.
-------------------------------------
Getter Method
Signature
CreationDirection()
Returns: creation direction type Return type: NXOpen.Weld.WeldCreationDirection
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
CreationDirection(creationDirection)
Parameters: creationDirection ( NXOpen.Weld.WeldCreationDirection
) – creation direction typeNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
CsysAssemblyState¶
-
WeldPointBuilder.
CsysAssemblyState
¶ Returns or sets the assy coordinate system state
-------------------------------------
Getter Method
Signature
CsysAssemblyState()
Returns: Return type: bool New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
CsysAssemblyState(assyCsysState)
Parameters: assyCsysState (bool) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
CsysWorkPartState¶
-
WeldPointBuilder.
CsysWorkPartState
¶ Returns or sets the work coordinate systemstate
-------------------------------------
Getter Method
Signature
CsysWorkPartState()
Returns: Return type: bool New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
CsysWorkPartState(workCsysState)
Parameters: workCsysState (bool) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
CustomCylinderAbove¶
-
WeldPointBuilder.
CustomCylinderAbove
¶ Returns or sets the distance the custom cylinder should be created above the weld point
-------------------------------------
Getter Method
Signature
CustomCylinderAbove()
Returns: Return type: float New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
CustomCylinderAbove(customCylinderAbove)
Parameters: customCylinderAbove (float) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
CustomRadius¶
-
WeldPointBuilder.
CustomRadius
¶ Returns or sets the radius to create the sphere, cylinder, or cone with
-------------------------------------
Getter Method
Signature
CustomRadius()
Returns: Return type: float New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
CustomRadius(customRadius)
Parameters: customRadius (float) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
CustomTotalCylinderLength¶
-
WeldPointBuilder.
CustomTotalCylinderLength
¶ Returns or sets the total length of the cylinder to be created.
-------------------------------------
Getter Method
Signature
CustomTotalCylinderLength()
Returns: Return type: float New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
CustomTotalCylinderLength(totalCylinderLength)
Parameters: totalCylinderLength (float) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
DatumFirstReferenceDirection¶
-
WeldPointBuilder.
DatumFirstReferenceDirection
¶ Returns or sets the datum reference direction type.
-------------------------------------
Getter Method
Signature
DatumFirstReferenceDirection()
Returns: Return type: NXOpen.Weld.WeldDatumControlDirection
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
DatumFirstReferenceDirection(datumRefDir)
Parameters: datumRefDir ( NXOpen.Weld.WeldDatumControlDirection
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
DatumMajorDirection¶
-
WeldPointBuilder.
DatumMajorDirection
¶ Returns or sets the datum major direction type.
-------------------------------------
Getter Method
Signature
DatumMajorDirection()
Returns: Return type: NXOpen.Weld.WeldDatumControlDirection
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
DatumMajorDirection(datumMajorDir)
Parameters: datumMajorDir ( NXOpen.Weld.WeldDatumControlDirection
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
DatumSecondReferenceDirection¶
-
WeldPointBuilder.
DatumSecondReferenceDirection
¶ Returns or sets the datum reference direction type.
-------------------------------------
Getter Method
Signature
DatumSecondReferenceDirection()
Returns: Return type: NXOpen.Weld.WeldDatumControlDirection
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
DatumSecondReferenceDirection(datumRefDir)
Parameters: datumRefDir ( NXOpen.Weld.WeldDatumControlDirection
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
DistanceTolerance¶
-
WeldPointBuilder.
DistanceTolerance
¶ Returns or sets the distance tolerance for the weld point
-------------------------------------
Getter Method
Signature
DistanceTolerance()
Returns: Return type: float New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
DistanceTolerance(distanceTolerance)
Parameters: distanceTolerance (float) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
EndDistance¶
-
WeldPointBuilder.
EndDistance
¶ Returns or sets the end dist
-------------------------------------
Getter Method
Signature
EndDistance()
Returns: Return type: str New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
EndDistance(endDistStr)
Parameters: endDistStr (str) – expression string New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
EndDistanceLocation¶
-
WeldPointBuilder.
EndDistanceLocation
¶ Returns or sets the end dist location
-------------------------------------
Getter Method
Signature
EndDistanceLocation()
Returns: Return type: NXOpen.Weld.WeldParasetLocation
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
EndDistanceLocation(endDistLocation)
Parameters: endDistLocation ( NXOpen.Weld.WeldParasetLocation
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
ExtendMethod¶
-
WeldPointBuilder.
ExtendMethod
¶ Returns or sets the offset curve extend method.
-------------------------------------
Getter Method
Signature
ExtendMethod()
Returns: Return type: NXOpen.Weld.WeldPointExtendMethod
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ExtendMethod(extendMethod)
Parameters: extendMethod ( NXOpen.Weld.WeldPointExtendMethod
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
Location¶
-
WeldPointBuilder.
Location
¶ Returns or sets the processing method to use for generating weld points along reference section(s)
-------------------------------------
Getter Method
Signature
Location()
Returns: Return type: NXOpen.Weld.WeldPointLocation
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
Location(location)
Parameters: location ( NXOpen.Weld.WeldPointLocation
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
MeasurementDefaultHeight¶
-
WeldPointBuilder.
MeasurementDefaultHeight
¶ Returns or sets the default height of the object for measurement to be created.
-------------------------------------
Getter Method
Signature
MeasurementDefaultHeight()
Returns: Return type: float New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
MeasurementDefaultHeight(measurementDefaultHeight)
Parameters: measurementDefaultHeight (float) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
MeasurementDefaultWidth¶
-
WeldPointBuilder.
MeasurementDefaultWidth
¶ Returns or sets the default width of the object for measurement to be created.
-------------------------------------
Getter Method
Signature
MeasurementDefaultWidth()
Returns: Return type: float New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
MeasurementDefaultWidth(measurementDefaultWidth)
Parameters: measurementDefaultWidth (float) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
MeasurementHoleSize¶
-
WeldPointBuilder.
MeasurementHoleSize
¶ Returns or sets the hole_size of the object for measurement to be created.
-------------------------------------
Getter Method
Signature
MeasurementHoleSize()
Returns: Return type: float New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
MeasurementHoleSize(holeSize)
Parameters: holeSize (float) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
MeasurementSlotLength¶
-
WeldPointBuilder.
MeasurementSlotLength
¶ Returns or sets the slot height of the object for measurement to be created.
-------------------------------------
Getter Method
Signature
MeasurementSlotLength()
Returns: Return type: float New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
MeasurementSlotLength(slotLength)
Parameters: slotLength (float) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
MeasurementSlotWidth¶
-
WeldPointBuilder.
MeasurementSlotWidth
¶ Returns or sets the slot width of the object for measurement to be created.
-------------------------------------
Getter Method
Signature
MeasurementSlotWidth()
Returns: Return type: float New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
MeasurementSlotWidth(slotWidth)
Parameters: slotWidth (float) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
MeasurementStudSize¶
-
WeldPointBuilder.
MeasurementStudSize
¶ Returns or sets the stud size of the object for measurement to be created.
-------------------------------------
Getter Method
Signature
MeasurementStudSize()
Returns: Return type: float New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
MeasurementStudSize(studSize)
Parameters: studSize (float) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
MirrorByType¶
-
WeldPointBuilder.
MirrorByType
¶ Returns or sets the mirror by type
-------------------------------------
Getter Method
Signature
MirrorByType()
Returns: Return type: bool New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
MirrorByType(mirrorByType)
Parameters: mirrorByType (bool) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
MirrorPlane¶
-
WeldPointBuilder.
MirrorPlane
¶ Returns or sets the plane that a point is to be mirrored about.
-------------------------------------
Getter Method
Signature
MirrorPlane()
Returns: Return type: NXOpen.Plane
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
MirrorPlane(mirrorPlane)
Parameters: mirrorPlane ( NXOpen.Plane
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
NumberConnectedPanels¶
-
WeldPointBuilder.
NumberConnectedPanels
¶ Returns or sets the num connected panels.
-------------------------------------
Getter Method
Signature
NumberConnectedPanels()
Returns: Return type: int New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
NumberConnectedPanels(numConnectedPanels)
Parameters: numConnectedPanels (int) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
OffsetDistance¶
-
WeldPointBuilder.
OffsetDistance
¶ Returns or sets the offset distance from edges in guide_collector1 to place weld points
-------------------------------------
Getter Method
Signature
OffsetDistance()
Returns: Return type: str New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
OffsetDistance(offsetDistance)
Parameters: offsetDistance (str) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
OutputType¶
-
WeldPointBuilder.
OutputType
¶ Returns or sets the output type.
-------------------------------------
Getter Method
Signature
OutputType()
Returns: output type Return type: NXOpen.Weld.OutputType
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
OutputType(outputType)
Parameters: outputType ( NXOpen.Weld.OutputType
) – output typeNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
PointMethod¶
-
WeldPointBuilder.
PointMethod
¶ Returns or sets the method for creating weld points.
Weld points can be created using guide entities or
Point
objects.-------------------------------------
Getter Method
Signature
PointMethod()
Returns: Return type: NXOpen.Weld.WeldPointMethod
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
PointMethod(ptMethod)
Parameters: ptMethod ( NXOpen.Weld.WeldPointMethod
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
PointsGuideDistance¶
-
WeldPointBuilder.
PointsGuideDistance
¶ Returns or sets the distance percentage from the start of the curve where the weld point should be.
0.0 is the start of the curve 100.0 is the end of the curve.
-------------------------------------
Getter Method
Signature
PointsGuideDistance()
Returns: Return type: float New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
PointsGuideDistance(pointsGuideDist)
Parameters: pointsGuideDist (float) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
ProjectDirection¶
-
WeldPointBuilder.
ProjectDirection
¶ Returns or sets the project direction
-------------------------------------
Getter Method
Signature
ProjectDirection()
Returns: Project direction Return type: NXOpen.Vector3d
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ProjectDirection(direction)
Parameters: direction ( NXOpen.Vector3d
) – Project directionNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
ProjectDirectionObject¶
-
WeldPointBuilder.
ProjectDirectionObject
¶ Returns or sets the project direction NXOpen object
-------------------------------------
Getter Method
Signature
ProjectDirectionObject()
Returns: Project direction Return type: NXOpen.Direction
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ProjectDirectionObject(direction)
Parameters: direction ( NXOpen.Direction
) – Project directionNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
ProjectionMethod¶
-
WeldPointBuilder.
ProjectionMethod
¶ Returns or sets the project method type.
-------------------------------------
Getter Method
Signature
ProjectionMethod()
Returns: Return type: NXOpen.Weld.WeldProjectionMethod
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ProjectionMethod(projMethod)
Parameters: projMethod ( NXOpen.Weld.WeldProjectionMethod
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
ReferenceSheetSpacingMethod¶
-
WeldPointBuilder.
ReferenceSheetSpacingMethod
¶ Returns or sets the refsheet spacing method
-------------------------------------
Getter Method
Signature
ReferenceSheetSpacingMethod()
Returns: Return type: NXOpen.Weld.WeldPointSpacingMethod
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ReferenceSheetSpacingMethod(spacingMethod)
Parameters: spacingMethod ( NXOpen.Weld.WeldPointSpacingMethod
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
ReferenceSheetType¶
-
WeldPointBuilder.
ReferenceSheetType
¶ Returns or sets the type of sheet to create to place weld points on.
-------------------------------------
Getter Method
Signature
ReferenceSheetType()
Returns: Return type: NXOpen.Weld.WeldPointReferenceSheetType
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ReferenceSheetType(refSheetType)
Parameters: refSheetType ( NXOpen.Weld.WeldPointReferenceSheetType
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SectionPlaneEntity¶
-
WeldPointBuilder.
SectionPlaneEntity
¶ Returns or sets
-------------------------------------
Getter Method
Signature
SectionPlaneEntity()
Returns: Return type: NXOpen.Plane
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
SectionPlaneEntity(plane)
Parameters: plane ( NXOpen.Plane
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SequenceNumber¶
-
WeldPointBuilder.
SequenceNumber
¶ Returns or sets the sequence number for the weld point feature.
Each Weld point feature contains a single point. If multiple Weld points are to be created, you must specify the sequence of the point you want. For example if you are expecting 3 points to be created. You must create 3 weld point features. The features will have sequence numbers 0,1 and 2.
-------------------------------------
Getter Method
Signature
SequenceNumber()
Returns: Return type: int New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
SequenceNumber(sequenceNumber)
Parameters: sequenceNumber (int) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
ShowThroughAssemblyState¶
-
WeldPointBuilder.
ShowThroughAssemblyState
¶ Returns or sets the through assy coordinate system state
-------------------------------------
Getter Method
Signature
ShowThroughAssemblyState()
Returns: Return type: bool New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ShowThroughAssemblyState(thruAssyState)
Parameters: thruAssyState (bool) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
ShowThroughWorkPartState¶
-
WeldPointBuilder.
ShowThroughWorkPartState
¶ Returns or sets the through work coordinate system state
-------------------------------------
Getter Method
Signature
ShowThroughWorkPartState()
Returns: Return type: bool New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ShowThroughWorkPartState(thruWorkState)
Parameters: thruWorkState (bool) – New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SizeMethod¶
-
WeldPointBuilder.
SizeMethod
¶ Returns or sets the measurement size method.
-------------------------------------
Getter Method
Signature
SizeMethod()
Returns: Return type: NXOpen.Weld.WeldMeasurementSizeMethod
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
SizeMethod(sizeMethod)
Parameters: sizeMethod ( NXOpen.Weld.WeldMeasurementSizeMethod
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SolidType¶
-
WeldPointBuilder.
SolidType
¶ Returns or sets the output solid type.
-------------------------------------
Getter Method
Signature
SolidType()
Returns: Return type: NXOpen.Weld.WeldCustom
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
SolidType(solidType)
Parameters: solidType ( NXOpen.Weld.WeldCustom
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SpacingCalculateMethod¶
-
WeldPointBuilder.
SpacingCalculateMethod
¶ Returns or sets the project method type.
-------------------------------------
Getter Method
Signature
SpacingCalculateMethod()
Returns: Return type: NXOpen.Weld.WeldSpacingCalcMethod
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
SpacingCalculateMethod(spacingCalcMethod)
Parameters: spacingCalcMethod ( NXOpen.Weld.WeldSpacingCalcMethod
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SpacingNumber¶
-
WeldPointBuilder.
SpacingNumber
¶ Returns or sets the spacing number
-------------------------------------
Getter Method
Signature
SpacingNumber()
Returns: Return type: str New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
SpacingNumber(spacingOrNumberStr)
Parameters: spacingOrNumberStr (str) – expression string New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
StartDistance¶
-
WeldPointBuilder.
StartDistance
¶ Returns or sets the start dist
-------------------------------------
Getter Method
Signature
StartDistance()
Returns: Return type: str New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
StartDistance(startDistStr)
Parameters: startDistStr (str) – expression string New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
StartDistanceLocation¶
-
WeldPointBuilder.
StartDistanceLocation
¶ Returns or sets the start dist location
-------------------------------------
Getter Method
Signature
StartDistanceLocation()
Returns: Return type: NXOpen.Weld.WeldParasetLocation
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
StartDistanceLocation(startDistLocation)
Parameters: startDistLocation ( NXOpen.Weld.WeldParasetLocation
) – start distance locationNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
TranslateCsys¶
-
WeldPointBuilder.
TranslateCsys
¶ Returns or sets the coordinate system that a point is to be translated about.
-------------------------------------
Getter Method
Signature
TranslateCsys()
Returns: Return type: NXOpen.CoordinateSystem
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
TranslateCsys(translateCsys)
Parameters: translateCsys ( NXOpen.CoordinateSystem
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
TranslateXDistance¶
-
WeldPointBuilder.
TranslateXDistance
¶ Returns or sets the tran x dist
-------------------------------------
Getter Method
Signature
TranslateXDistance()
Returns: Return type: str New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
TranslateXDistance(transXDistStr)
Parameters: transXDistStr (str) – expression string New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
TranslateYDistance¶
-
WeldPointBuilder.
TranslateYDistance
¶ Returns or sets the trans y dist
-------------------------------------
Getter Method
Signature
TranslateYDistance()
Returns: Return type: str New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
TranslateYDistance(transYDistStr)
Parameters: transYDistStr (str) – expression string New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
TranslateZDistance¶
-
WeldPointBuilder.
TranslateZDistance
¶ Returns or sets the translate distance for weld points in z axis direction.
-------------------------------------
Getter Method
Signature
TranslateZDistance()
Returns: Return type: str New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
TranslateZDistance(transZDistStr)
Parameters: transZDistStr (str) – expression string New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
WeldType¶
-
WeldPointBuilder.
WeldType
¶ Returns or sets the weld type.
-------------------------------------
Getter Method
Signature
WeldType()
Returns: Return type: NXOpen.Weld.WeldFeatureSetType
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
WeldType(curWeldType)
Parameters: curWeldType ( NXOpen.Weld.WeldFeatureSetType
) –New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
Method Detail¶
CalculateDatumMeasurementDefaultDirection¶
-
WeldPointBuilder.
CalculateDatumMeasurementDefaultDirection
¶ Calculate location and default direction of datum and measurement, need to set the current point prior to calling this method
Signature
CalculateDatumMeasurementDefaultDirection()
New in version NX7.5.5.
License requirements: ugweld (“UG WELD”)
CalculateWeldPoints¶
-
WeldPointBuilder.
CalculateWeldPoints
¶ To calculate all weld points
Signature
CalculateWeldPoints()
Returns: weld points Return type: list of NXOpen.Point3d
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
ClearFaceSets¶
-
WeldPointBuilder.
ClearFaceSets
¶ The clear for all existed facesets
Signature
ClearFaceSets()
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
CommitFaceSets¶
-
WeldPointBuilder.
CommitFaceSets
¶ Signature
CommitFaceSets()
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
CommitReferenceSheets¶
-
WeldPointBuilder.
CommitReferenceSheets
¶ The commit for reference sheets
Signature
CommitReferenceSheets(createStatus)
Parameters: createStatus ( NXOpen.Weld.WeldOverlapStatus
) – create statusNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
CommitSection¶
-
WeldPointBuilder.
CommitSection
¶ Commit created section
Signature
CommitSection(path)
Parameters: path ( NXOpen.Section
) – the created pathNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
CreateCenterLine¶
-
WeldPointBuilder.
CreateCenterLine
¶ To create center line
Signature
CreateCenterLine()
Returns: Return type: NXOpen.Section
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
CreateOffsetCurve¶
-
WeldPointBuilder.
CreateOffsetCurve
¶ Create offset curve
Signature
CreateOffsetCurve()
Returns: Return type: NXOpen.Section
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
CreateSectionPlaneCurves¶
-
WeldPointBuilder.
CreateSectionPlaneCurves
¶ Create section curve
Signature
CreateSectionPlaneCurves()
Returns: section curve Return type: NXOpen.Section
New in version NX7.0.0.
License requirements: ugweld (“UG WELD”)
CreateSingleWeldPoint¶
-
WeldPointBuilder.
CreateSingleWeldPoint
¶ The creation for single weld point
Signature
CreateSingleWeldPoint(pointCoord)
Parameters: pointCoord ( NXOpen.Point3d
) – point coordinateNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
FlipZAxis¶
-
WeldPointBuilder.
FlipZAxis
¶ Flip the z axis
Signature
FlipZAxis()
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
GetCsys¶
-
WeldPointBuilder.
GetCsys
¶ Get coordinate system for point
Signature
GetCsys()
Returns: a tuple Return type: A tuple consisting of (origin, matrix). origin is a NXOpen.Point3d
. origin point matrix is aNXOpen.Matrix3x3
. rotate matrixNew in version NX8.0.0.
License requirements: ugweld (“UG WELD”)
GetCurrentReferenceSheet¶
-
WeldPointBuilder.
GetCurrentReferenceSheet
¶ The current refsheet
Signature
GetCurrentReferenceSheet()
Returns: Return type: int New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
GetFaceSet¶
-
WeldPointBuilder.
GetFaceSet
¶ Gets the user selected faces for the indicated face set
Signature
GetFaceSet(facesetIndex)
Parameters: facesetIndex (int) – Which faceset to get the faces for. 0 is the first Returns: a tuple Return type: A tuple consisting of (objects, frecs). objects is a list of NXOpen.DisplayableObject
. the face set reference objects frecs is a list ofNXOpen.Features.Feature
. the face set wave linked frecsNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
GetFirstSection¶
-
WeldPointBuilder.
GetFirstSection
¶ Get the first section.
For guide curves method, this section contains curves that used to create weld path, For centerline method, this section contians the first group of curves used to create centerline
Signature
GetFirstSection()
Returns: the section Return type: NXOpen.Section
New in version NX8.0.0.
License requirements: ugweld (“UG WELD”)
GetMirrorTranslateReferenceObjects¶
-
WeldPointBuilder.
GetMirrorTranslateReferenceObjects
¶ Get mirror translate reference objects
Signature
GetMirrorTranslateReferenceObjects()
Returns: the mirror translate reference objects Return type: list of NXOpen.DisplayableObject
New in version NX8.0.0.
License requirements: ugweld (“UG WELD”)
GetNumFaceSets¶
-
WeldPointBuilder.
GetNumFaceSets
¶ Get the amount of face sets
Signature
GetNumFaceSets()
Returns: total amount of face sets Return type: int New in version NX8.0.0.
License requirements: ugweld (“UG WELD”)
GetReferenceSheets¶
-
WeldPointBuilder.
GetReferenceSheets
¶ The refernence sheet feature
Signature
GetReferenceSheets()
Returns: the reference sheet Return type: NXOpen.Features.Feature
New in version NX8.0.0.
License requirements: ugweld (“UG WELD”)
GetSecondSection¶
-
WeldPointBuilder.
GetSecondSection
¶ Get the second section.
this method for centerline method weld only, this section contains the second group of curves used to create centerline
Signature
GetSecondSection()
Returns: the section Return type: NXOpen.Section
New in version NX8.0.0.
License requirements: ugweld (“UG WELD”)
GetSectionCurves¶
-
WeldPointBuilder.
GetSectionCurves
¶ Gets the curves contained in the input section
Signature
GetSectionCurves(section)
Parameters: section ( NXOpen.Section
) – the section container for the curvesReturns: the curves of the section Return type: list of NXOpen.Curve
New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
MovePoint¶
-
WeldPointBuilder.
MovePoint
¶ Move selected points
Signature
MovePoint(origin)
Parameters: origin ( NXOpen.Point3d
) – the new position to be locatedNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
ProjectPoints¶
-
WeldPointBuilder.
ProjectPoints
¶ Project selected points along the specified vector to reference sheets
Signature
ProjectPoints()
New in version NX8.0.0.
License requirements: ugweld (“UG WELD”)
RemoveCharacteristics¶
-
WeldPointBuilder.
RemoveCharacteristics
¶ Remove characteristics for selected points, need to set the current point prior to calling this method
Signature
RemoveCharacteristics(attrTitle, attrType, attrValue)
Parameters: - attrTitle (str) – attribute title NOTE: The full Unicode character set is not supported for this parameter.
- attrType (
NXOpen.Weld.WeldAttribType
) – attribute type - attrValue (str) – attribute value NOTE: The full Unicode character set is not supported for this parameter.
New in version NX7.5.5.
License requirements: ugweld (“UG WELD”)
RemoveWeldPoint¶
-
WeldPointBuilder.
RemoveWeldPoint
¶ Remove the current selected point, need to set the current point prior to calling this method
Signature
RemoveWeldPoint()
New in version NX7.5.5.
License requirements: ugweld (“UG WELD”)
SetCharacteristics¶
-
WeldPointBuilder.
SetCharacteristics
¶ Set or edit characteristics for selected points
Signature
SetCharacteristics(attrTitle, attrType, attrValue)
Parameters: - attrTitle (str) – attribute title NOTE: The full Unicode character set is not supported for this parameter.
- attrType (
NXOpen.Weld.WeldAttribType
) – attribute type - attrValue (str) – attribute value NOTE: The full Unicode character set is not supported for this parameter.
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SetCurrentReferenceSheet¶
-
WeldPointBuilder.
SetCurrentReferenceSheet
¶ Set current refsheet
Signature
SetCurrentReferenceSheet(currentRefSheet)
Parameters: currentRefSheet (int) – current refsheet New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SetFaceSet¶
-
WeldPointBuilder.
SetFaceSet
¶ Sets the user selected faces for the indicated face set
Signature
SetFaceSet(facesetIndex, objects)
Parameters: - facesetIndex (
NXOpen.Weld.WeldFacesetIndex
) – Which faceset to get the faces for. 0 is the first - objects (list of
NXOpen.DisplayableObject
) – the face set reference objects
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
- facesetIndex (
SetFirstSection¶
-
WeldPointBuilder.
SetFirstSection
¶ The commit for first section
Signature
SetFirstSection(section)
Parameters: section ( NXOpen.Section
) – the section from uicompNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SetMirrorTranslateReferenceObjects¶
-
WeldPointBuilder.
SetMirrorTranslateReferenceObjects
¶ Add or remove mirror translate reference objects
Signature
SetMirrorTranslateReferenceObjects(refs)
Parameters: refs (list of NXOpen.TaggedObject
) – the mirror translate reference objects to be addedNew in version NX7.5.5.
License requirements: ugweld (“UG WELD”)
SetPoint¶
-
WeldPointBuilder.
SetPoint
¶ Set the selected point
Signature
SetPoint(index)
Parameters: index (int) – point index New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SetSecondSection¶
-
WeldPointBuilder.
SetSecondSection
¶ Create second section
Signature
SetSecondSection(section)
Parameters: section ( NXOpen.Section
) – the section from uicompNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
SetSelectionType¶
-
WeldPointBuilder.
SetSelectionType
¶ Set the selection type
Signature
SetSelectionType(selectionType)
Parameters: selectionType ( NXOpen.Weld.WeldSelectionType
) – selection typeNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
UpdateCsys¶
-
WeldPointBuilder.
UpdateCsys
¶ Update coordinate system for selected points
Signature
UpdateCsys(origin, matrix)
Parameters: - origin (
NXOpen.Point3d
) – origin point - matrix (
NXOpen.Matrix3x3
) – rotate matrix
New in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
- origin (
UpdateFirstSection¶
-
WeldPointBuilder.
UpdateFirstSection
¶ Update first section
Signature
UpdateFirstSection(totalSection)
Parameters: totalSection ( NXOpen.Section
) – the total sectionNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
UpdateSecondSection¶
-
WeldPointBuilder.
UpdateSecondSection
¶ Update second section
Signature
UpdateSecondSection(totalSection)
Parameters: totalSection ( NXOpen.Section
) – the total sectionNew in version NX6.0.0.
License requirements: ugweld (“UG WELD”)
Validate¶
-
WeldPointBuilder.
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.