DatumPinBuilder Class¶
-
class
NXOpen.Weld.DatumPinBuilder¶ Bases:
NXOpen.Weld.DatumCommonBuilderUsed to create or edit a
NXOpen.Weld.DatumPinfeature.To create a new instance of this class, use
NXOpen.Weld.WeldManager.CreateDatumPinBuilder()Default values.
Property Value ControlMethod PrincipalAxis CreateDirectionVector 1 CreatePlane 1 CreatePoint 1 Derived 0 DirectionLength 20 (millimeters part), 1.0 (inches part) ModelingTolerance 0.0254 PlaneHeight 20 (millimeters part), 1.0 (inches part) PlaneWidth 20 (millimeters part), 1.0 (inches part) PrincipalAxisX 0 PrincipalAxisY 0 PrincipalAxisZ 0 New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| AdditionalReferences | Returns the additional references. |
| BoundaryCurve | Returns the resting face |
| Characteristics | Returns the characteristics. |
| ControlMethod | Returns or sets the control method. |
| CreateDirectionVector | Returns or sets the option to control if a reference datum axis should be output with this feature. |
| CreatePlane | Returns or sets the option to control if a reference datum plane should be output with the this feature. |
| CreatePoint | Returns or sets the option to control if a reference point should be output with this feature. |
| CreationDirection | Returns or sets the creation direction. |
| CustomAboveLength | Returns or sets the length above the datum reference point. |
| CustomRadius | Returns or sets the radius of the solid sphere, cylinder or cone created. |
| CustomTotalLength | Returns or sets the total length of the cylinder or cone along the direction axis. |
| CustomType | Returns or sets the custom datum type. |
| CustomTypeName | Returns or sets the custom name used to create the datum. |
| Derived | Returns or sets the indicator if this should be marked as a derived from another datum. |
| DerivedDatum | Returns the derived datum |
| DirectionAxis | Returns or sets the direction axis. |
| DirectionLength | Returns or sets the length of the datum axis vector created. |
| ModelingTolerance | Returns or sets the modeling distance tolerance. |
| PlaneHeight | Returns or sets the plane height along the direction axis. |
| PlaneWidth | Returns or sets the plane width perpendicular to the direction axis. |
| PrincipalAxisX | Returns or sets the principal axis x. |
| PrincipalAxisY | Returns or sets the principal axis y. |
| PrincipalAxisZ | Returns or sets the principal axis z. |
| ProjectAlongDirection | Returns or sets the project along direction. |
| SectionPlaneNormal | Returns or sets the section plane normal. |
| SolidType | Returns or sets the solid body type specified. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| InitializeAxis | Update the axis origin to the center of the slot or circle, and direction to the normal of the boundary. |
| MoveToCenter | Moves a point to the center of a circle or slot boundary |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UpdateAxisData | Updates data related to the axis. |
| UpdateWithDerivedDatum | Initialize the builder with the inputs from an existing datum. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
BoundaryCurve¶
-
DatumPinBuilder.BoundaryCurve¶ Returns the resting face
-------------------------------------Getter Method
Signature
BoundaryCurveReturns: Return type: NXOpen.ScCollectorNew in version NX8.5.0.
License requirements: None.
DerivedDatum¶
-
DatumPinBuilder.DerivedDatum¶ Returns the derived datum
-------------------------------------Getter Method
Signature
DerivedDatumReturns: Return type: NXOpen.Weld.SelectDatumPinNew in version NX8.5.0.
License requirements: None.
Method Detail¶
InitializeAxis¶
-
DatumPinBuilder.InitializeAxis¶ Update the axis origin to the center of the slot or circle, and direction to the normal of the boundary.
If the boundary is not planar an approximate direction will be computed from boundary bounding box.
Signature
InitializeAxis()New in version NX8.5.0.
License requirements: ugweld (“UG WELD”)
MoveToCenter¶
-
DatumPinBuilder.MoveToCenter¶ Moves a point to the center of a circle or slot boundary
Signature
MoveToCenter()New in version NX8.5.0.
License requirements: ugweld (“UG WELD”)
UpdateAxisData¶
-
DatumPinBuilder.UpdateAxisData¶ Updates data related to the axis.
The origin will be adjusted based on grid snapping, and projection direction. In addition the control direction information will be updated.
Signature
UpdateAxisData()New in version NX8.5.0.
License requirements: ugweld (“UG WELD”)
Validate¶
-
DatumPinBuilder.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.