JointmarkBuilder Class¶
-
class
NXOpen.Weld.
JointmarkBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Weld.Jointmark
builderTo create a new instance of this class, use
NXOpen.Weld.WeldManager.CreateJointmarkBuilder
Default values.
Property Value Associativity 1 ConnectPart 0 ConstructionMethod GuideCurve CreateSingleFeatures 0 DistanceTolerance 0.0254 OrientationMethod SurfaceNormal ReferenceSheetType Overlap ShowWorkCsys 1 New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
Associativity | Returns or sets the automatic update option also known as associativity. |
Characteristics | Returns the characteristics |
ConnectPart | Returns or sets the option of connecting only one part. |
ConnectedPanelType | Returns or sets the number of connected panels at a point. |
ConstructionMethod | Returns or sets the construction method for creating Jointmark |
CreateSingleFeatures | Returns or sets the control option to determine if individual features should be created. |
DistanceTolerance | Returns or sets the distance tolerance |
FaceSetsList | Returns the list of face sets |
FixedCsys | Returns or sets the fixed csys that overrides the default Csys orientation. |
GuideCurvesList | Returns the list of guide curves |
OrientationMethod | Returns or sets the orientation method for defining a csys |
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 |
Plane | Returns or sets the plane used for mirror |
PointList | Returns the list of points |
ReferenceSheetType | Returns or sets the type of reference sheet |
ReuseFeatures | Returns the selected reuse features |
SelectMirrorObject | Returns the selected objects for mirror. |
SelectPointsObject | Returns the selected objects for Points |
SelectTranslateObject | Returns the selected objects to translate. |
ShowWorkCsys | Returns or sets the option to control if the work coordinate system should be showing. |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
TranslateCsys | Returns or sets the coordinate system that defines the translate offset directions. |
TranslateX | Returns the expression containing the value of the x translation distance. |
TranslateY | Returns the expression containing the value of the y translation distance. |
TranslateZ | Returns the expression containing the value of the z translation distance. |
Vector | Returns or sets the vector which points to Y axis |
Methods¶
Method | Description |
---|---|
AppendPoints | Creates a list of points on the overlap sheet. |
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
CreateReferenceData | Create a temporary overlap or top sheet and guide curve. |
CreateSymbolCurve | Create curve From PMI symbol @return Curve from symbol |
DeleteReferenceData | Delete temporary overlap or top sheet feature. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetFeature | Returns the feature currently being edited by this builder. |
GetObject | Returns the object currently being edited by this builder. |
GetReferenceSheet | Returns the Reference Sheet feature @return |
GetSelectedReferences | Gets the selected points, or point features, references. |
GetSheetEdges | Edges of created sheet |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
MapFeaturesToPoints | Maps the selected reuse features to the new preview point locations. |
NewFaceSets | Creates a NXOpen.Weld.JointmarkFaceSetsBuilder object. |
NewGuide | Creates a NXOpen.Weld.JointmarkGuideBuilder object. |
NewPoints | Creates a NXOpen.Weld.JointmarkPointsBuilder object. |
RediscoverFaces | Use the Weld Assistant Connected Face Finder command to rediscover faces based on the current feature point positions. |
SetDisplayCsys | Indicates whether the csys should be displayed on creation |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
SetShowThruState | Indicates whether the output objects should show thru on creation |
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 |
UpdateFeatures | Updates all the items on the points list based on the construction method and related inputs. |
UpdateReferenceSheet | Prepares a Reference Sheet for placing Jointmark features. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
JointmarkBuilderConnectedPanelTypes Enumeration | The type of sheets to create |
JointmarkBuilderMethod Enumeration | The type of construction method for creating Jointmark |
JointmarkBuilderOrientationMethodTypes Enumeration | The type of orientation method for defining the default coordinate system. |
JointmarkBuilderReferenceSheetTypes Enumeration | The type of sheets to create |
Property Detail¶
Associativity¶
-
JointmarkBuilder.
Associativity
¶ Returns or sets the automatic update option also known as associativity.
If true, the curve representing the Jointmark feature will change its location if the guide curve is updated
-------------------------------------
Getter Method
Signature
Associativity()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
Associativity(associativity)
Parameters: associativity (bool) – New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
Characteristics¶
-
JointmarkBuilder.
Characteristics
¶ Returns the characteristics
-------------------------------------
Getter Method
Signature
Characteristics()
Returns: Return type: NXOpen.Weld.CharacteristicsBuilder
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
ConnectPart¶
-
JointmarkBuilder.
ConnectPart
¶ Returns or sets the option of connecting only one part.
If true, Jointmark feature is created on a single component.
-------------------------------------
Getter Method
Signature
ConnectPart()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ConnectPart(connectPart)
Parameters: connectPart (bool) – New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
ConnectedPanelType¶
-
JointmarkBuilder.
ConnectedPanelType
¶ Returns or sets the number of connected panels at a point.
This is used when the construction method is Existing Points
-------------------------------------
Getter Method
Signature
ConnectedPanelType()
Returns: Return type: NXOpen.Weld.JointmarkBuilderConnectedPanelTypes
New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ConnectedPanelType(method)
Parameters: method ( NXOpen.Weld.JointmarkBuilderConnectedPanelTypes
) –New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
ConstructionMethod¶
-
JointmarkBuilder.
ConstructionMethod
¶ Returns or sets the construction method for creating Jointmark
-------------------------------------
Getter Method
Signature
ConstructionMethod()
Returns: Return type: NXOpen.Weld.JointmarkBuilderMethod
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ConstructionMethod(method)
Parameters: method ( NXOpen.Weld.JointmarkBuilderMethod
) –New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
CreateSingleFeatures¶
-
JointmarkBuilder.
CreateSingleFeatures
¶ Returns or sets the control option to determine if individual features should be created.
Only allowed for
NXOpen.Weld.PointMark
class.-------------------------------------
Getter Method
Signature
CreateSingleFeatures()
Returns: true- single features. false - fully associative features are created. Return type: bool New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
CreateSingleFeatures(createSingleFeatures)
Parameters: createSingleFeatures (bool) – true- Full associative features are created. fale- single non associative features. New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
DistanceTolerance¶
-
JointmarkBuilder.
DistanceTolerance
¶ Returns or sets the distance tolerance
-------------------------------------
Getter Method
Signature
DistanceTolerance()
Returns: Return type: float New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
DistanceTolerance(distanceTolerance)
Parameters: distanceTolerance (float) – New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
FaceSetsList¶
-
JointmarkBuilder.
FaceSetsList
¶ Returns the list of face sets
-------------------------------------
Getter Method
Signature
FaceSetsList()
Returns: Return type: NXOpen.Weld.JointmarkFaceSetsBuilderList
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
FixedCsys¶
-
JointmarkBuilder.
FixedCsys
¶ Returns or sets the fixed csys that overrides the default Csys orientation.
-------------------------------------
Getter Method
Signature
FixedCsys()
Returns: Return type: NXOpen.CoordinateSystem
New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
FixedCsys(fixedCsys)
Parameters: fixedCsys ( NXOpen.CoordinateSystem
) –New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
GuideCurvesList¶
-
JointmarkBuilder.
GuideCurvesList
¶ Returns the list of guide curves
-------------------------------------
Getter Method
Signature
GuideCurvesList()
Returns: Return type: NXOpen.Weld.JointmarkGuideBuilderList
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
OrientationMethod¶
-
JointmarkBuilder.
OrientationMethod
¶ Returns or sets the orientation method for defining a csys
-------------------------------------
Getter Method
Signature
OrientationMethod()
Returns: Return type: NXOpen.Weld.JointmarkBuilderOrientationMethodTypes
New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
OrientationMethod(orientationMethod)
Parameters: orientationMethod ( NXOpen.Weld.JointmarkBuilderOrientationMethodTypes
) –New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
Plane¶
-
JointmarkBuilder.
Plane
¶ Returns or sets the plane used for mirror
-------------------------------------
Getter Method
Signature
Plane()
Returns: Return type: NXOpen.Plane
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
Plane(plane)
Parameters: plane ( NXOpen.Plane
) –New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
PointList¶
-
JointmarkBuilder.
PointList
¶ Returns the list of points
-------------------------------------
Getter Method
Signature
PointList()
Returns: Return type: NXOpen.Weld.JointmarkPointsBuilderList
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
ReferenceSheetType¶
-
JointmarkBuilder.
ReferenceSheetType
¶ Returns or sets the type of reference sheet
-------------------------------------
Getter Method
Signature
ReferenceSheetType()
Returns: Return type: NXOpen.Weld.JointmarkBuilderReferenceSheetTypes
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ReferenceSheetType(refSheet)
Parameters: refSheet ( NXOpen.Weld.JointmarkBuilderReferenceSheetTypes
) –New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
ReuseFeatures¶
-
JointmarkBuilder.
ReuseFeatures
¶ Returns the selected reuse features
-------------------------------------
Getter Method
Signature
ReuseFeatures()
Returns: Return type: NXOpen.Features.SelectFeatureList
New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
SelectMirrorObject¶
-
JointmarkBuilder.
SelectMirrorObject
¶ Returns the selected objects for mirror.
These objects can be features or curves representing Jointmark
-------------------------------------
Getter Method
Signature
SelectMirrorObject()
Returns: Return type: NXOpen.SelectTaggedObjectList
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
SelectPointsObject¶
-
JointmarkBuilder.
SelectPointsObject
¶ Returns the selected objects for Points
-------------------------------------
Getter Method
Signature
SelectPointsObject()
Returns: Return type: NXOpen.SelectPointList
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
SelectTranslateObject¶
-
JointmarkBuilder.
SelectTranslateObject
¶ Returns the selected objects to translate.
These objects can be features or curves representing Jointmark
-------------------------------------
Getter Method
Signature
SelectTranslateObject()
Returns: Return type: NXOpen.SelectTaggedObjectList
New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
ShowWorkCsys¶
-
JointmarkBuilder.
ShowWorkCsys
¶ Returns or sets the option to control if the work coordinate system should be showing.
-------------------------------------
Getter Method
Signature
ShowWorkCsys()
Returns: Return type: bool New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ShowWorkCsys(showWorkCsys)
Parameters: showWorkCsys (bool) – New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
TranslateCsys¶
-
JointmarkBuilder.
TranslateCsys
¶ Returns or sets the coordinate system that defines the translate offset directions.
If not specified the absolute csys will be used.
-------------------------------------
Getter Method
Signature
TranslateCsys()
Returns: Return type: NXOpen.CoordinateSystem
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TranslateCsys(csys)
Parameters: csys ( NXOpen.CoordinateSystem
) –New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
TranslateX¶
-
JointmarkBuilder.
TranslateX
¶ Returns the expression containing the value of the x translation distance.
-------------------------------------
Getter Method
Signature
TranslateX()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: None.
TranslateY¶
-
JointmarkBuilder.
TranslateY
¶ Returns the expression containing the value of the y translation distance.
-------------------------------------
Getter Method
Signature
TranslateY()
Returns: Return type: NXOpen.Expression
New in version NX10.0.0.
License requirements: None.
TranslateZ¶
-
JointmarkBuilder.
TranslateZ
¶ Returns the expression containing the value of the z translation distance.
-------------------------------------
Getter Method
Signature
TranslateZ()
Returns: Return type: NXOpen.Expression
New in version NX10.0.0.
License requirements: None.
Vector¶
-
JointmarkBuilder.
Vector
¶ Returns or sets the vector which points to Y axis
-------------------------------------
Getter Method
Signature
Vector()
Returns: Return type: NXOpen.Direction
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
Vector(vector)
Parameters: vector ( NXOpen.Direction
) –New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
Method Detail¶
AppendPoints¶
-
JointmarkBuilder.
AppendPoints
¶ Creates a list of points on the overlap sheet.
In addition, a curve selected by the user will be placed at these points.
Signature
AppendPoints(mode, curve)
Parameters: - mode (bool) – Create or Edit
- curve (
NXOpen.Curve
) – Curve to place at these points
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
CreateReferenceData¶
-
JointmarkBuilder.
CreateReferenceData
¶ Create a temporary overlap or top sheet and guide curve.
Use with independent
NXOpen.Weld.PointMarkPoint
features.Signature
CreateReferenceData()
New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
CreateSymbolCurve¶
-
JointmarkBuilder.
CreateSymbolCurve
¶ Create curve From PMI symbol
Signature
CreateSymbolCurve(path, name)
Parameters: - path (str) – Symbol path NOTE: The full Unicode character set is not supported for this parameter.
- name (str) – Symbol id NOTE: The full Unicode character set is not supported for this parameter.
Returns: Curve from symbol
Return type: New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
DeleteReferenceData¶
-
JointmarkBuilder.
DeleteReferenceData
¶ Delete temporary overlap or top sheet feature.
Use with independent
NXOpen.Weld.PointMarkPoint
features.Signature
DeleteReferenceData()
New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
GetReferenceSheet¶
-
JointmarkBuilder.
GetReferenceSheet
¶ Returns the Reference Sheet feature
Signature
GetReferenceSheet()
Returns: Return type: NXOpen.Features.Feature
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
GetSelectedReferences¶
-
JointmarkBuilder.
GetSelectedReferences
¶ Gets the selected points, or point features, references.
Does not apply to the guide curves method.
Signature
GetSelectedReferences()
Returns: The array of references. These may be points or point features. Return type: list of NXOpen.NXObject
New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
GetSheetEdges¶
-
JointmarkBuilder.
GetSheetEdges
¶ Edges of created sheet
Signature
GetSheetEdges()
Returns: Return type: list of NXOpen.Edge
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
MapFeaturesToPoints¶
-
JointmarkBuilder.
MapFeaturesToPoints
¶ Maps the selected reuse features to the new preview point locations.
Signature
MapFeaturesToPoints()
New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
NewFaceSets¶
-
JointmarkBuilder.
NewFaceSets
¶ Creates a
NXOpen.Weld.JointmarkFaceSetsBuilder
object.Signature
NewFaceSets()
Returns: Return type: NXOpen.Weld.JointmarkFaceSetsBuilder
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
NewGuide¶
-
JointmarkBuilder.
NewGuide
¶ Creates a
NXOpen.Weld.JointmarkGuideBuilder
object.Signature
NewGuide()
Returns: Return type: NXOpen.Weld.JointmarkGuideBuilder
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
NewPoints¶
-
JointmarkBuilder.
NewPoints
¶ Creates a
NXOpen.Weld.JointmarkPointsBuilder
object.Signature
NewPoints()
Returns: Return type: NXOpen.Weld.JointmarkPointsBuilder
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
RediscoverFaces¶
-
JointmarkBuilder.
RediscoverFaces
¶ Use the Weld Assistant Connected Face Finder command to rediscover faces based on the current feature point positions.
Signature
RediscoverFaces()
New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
SetDisplayCsys¶
-
JointmarkBuilder.
SetDisplayCsys
¶ Indicates whether the csys should be displayed on creation
Signature
SetDisplayCsys(status)
Parameters: status (bool) – New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
SetShowThruState¶
-
JointmarkBuilder.
SetShowThruState
¶ Indicates whether the output objects should show thru on creation
Signature
SetShowThruState(status)
Parameters: status (bool) – New in version NX10.0.0.
License requirements: ugweld (“UG WELD”)
UpdateFeatures¶
-
JointmarkBuilder.
UpdateFeatures
¶ Updates all the items on the points list based on the construction method and related inputs.
Signature
UpdateFeatures()
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
UpdateReferenceSheet¶
-
JointmarkBuilder.
UpdateReferenceSheet
¶ Prepares a Reference Sheet for placing Jointmark features.
If the sheet is suppressed, it will be unsuppressed.
Signature
UpdateReferenceSheet(facesModified)
Parameters: facesModified (bool) – Indicates if Reference Sheet needs to be updated. Returns: Return type: NXOpen.Features.Feature
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
Validate¶
-
JointmarkBuilder.
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.