DatumSurfaceBuilder Class¶
-
class
NXOpen.Weld.
DatumSurfaceBuilder
¶ Bases:
NXOpen.Weld.DatumCommonBuilder
Used to create or edit a
NXOpen.Weld.DatumSurface
feature.To create a new instance of this class, use
NXOpen.Weld.WeldManager.CreateDatumSurfaceBuilder
Default values.
Property Value ControlMethod PrincipalAxis CreateDirectionVector 1 CreatePlane 1 CreatePoint 1 Derived 0 DirectionLength 20 (millimeters part), 1.0 (inches part) GridSnapTolerance 1 (millimeters part), 0.05 (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 ProjectAlongDirection 1 SnapPointToGrid 1 XCoordinate 0.0 YCoordinate 0.0 ZCoordinate 0.0 New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
AdditionalReferences | Returns the additional references. |
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. |
GridSnapTolerance | Returns or sets the grid snap tolerance |
MirrorPlane | Returns or sets the plane used for mirroring a reference surface locator. |
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. |
RestingFace | Returns the resting face |
SectionPlaneNormal | Returns or sets the section plane normal. |
SnapPointToGrid | Returns or sets the snap point to grid option. |
SolidType | Returns or sets the solid body type specified. |
Tag | Returns the Tag for this object. |
Type | Returns or sets the construction type used to create the datum surface. |
XCoordinate | Returns or sets the x coordinate position for the surface datum location. |
YCoordinate | Returns or sets the y coordinate position for the surface datum location |
ZCoordinate | Returns or sets the z coordinate position for the datum surface location |
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 a point specified, and direction to closest principal axis to face normal. |
MoveMinimumDistance | Moves a point to the nearest location on the resting face |
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. |
UpdateWithReferenceDatum | Initialize the builder with the inputs from an existing datum surface locator. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
DatumSurfaceBuilderTypes Enumeration | Settings to indicate the construction type used for the datum surface. |
Property Detail¶
DerivedDatum¶
-
DatumSurfaceBuilder.
DerivedDatum
¶ Returns the derived datum
-------------------------------------
Getter Method
Signature
DerivedDatum()
Returns: Return type: NXOpen.Weld.SelectDatumSurface
New in version NX8.5.0.
License requirements: None.
GridSnapTolerance¶
-
DatumSurfaceBuilder.
GridSnapTolerance
¶ Returns or sets the grid snap tolerance
-------------------------------------
Getter Method
Signature
GridSnapTolerance()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GridSnapTolerance(gridSnapTolerance)
Parameters: gridSnapTolerance (float) – New in version NX8.5.0.
License requirements: ugweld (“UG WELD”)
MirrorPlane¶
-
DatumSurfaceBuilder.
MirrorPlane
¶ Returns or sets the plane used for mirroring a reference surface locator.
-------------------------------------
Getter Method
Signature
MirrorPlane()
Returns: Return type: NXOpen.Plane
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MirrorPlane(mirrorPlane)
Parameters: mirrorPlane ( NXOpen.Plane
) –New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
RestingFace¶
-
DatumSurfaceBuilder.
RestingFace
¶ Returns the resting face
-------------------------------------
Getter Method
Signature
RestingFace()
Returns: Return type: NXOpen.ScCollector
New in version NX8.5.0.
License requirements: None.
SnapPointToGrid¶
-
DatumSurfaceBuilder.
SnapPointToGrid
¶ Returns or sets the snap point to grid option.
Specified locations will be adjusted based on the grid snap tolerance
-------------------------------------
Getter Method
Signature
SnapPointToGrid()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SnapPointToGrid(snapPointToGrid)
Parameters: snapPointToGrid (bool) – New in version NX8.5.0.
License requirements: ugweld (“UG WELD”)
Type¶
-
DatumSurfaceBuilder.
Type
¶ Returns or sets the construction type used to create the datum surface.
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Weld.DatumSurfaceBuilderTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Weld.DatumSurfaceBuilderTypes
) –New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
XCoordinate¶
-
DatumSurfaceBuilder.
XCoordinate
¶ Returns or sets the x coordinate position for the surface datum location.
-------------------------------------
Getter Method
Signature
XCoordinate()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
XCoordinate(xCoordinate)
Parameters: xCoordinate (float) – New in version NX8.5.0.
License requirements: ugweld (“UG WELD”)
YCoordinate¶
-
DatumSurfaceBuilder.
YCoordinate
¶ Returns or sets the y coordinate position for the surface datum location
-------------------------------------
Getter Method
Signature
YCoordinate()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
YCoordinate(yCoordinate)
Parameters: yCoordinate (float) – New in version NX8.5.0.
License requirements: ugweld (“UG WELD”)
ZCoordinate¶
-
DatumSurfaceBuilder.
ZCoordinate
¶ Returns or sets the z coordinate position for the datum surface location
-------------------------------------
Getter Method
Signature
ZCoordinate()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ZCoordinate(zCoordinate)
Parameters: zCoordinate (float) – New in version NX8.5.0.
License requirements: ugweld (“UG WELD”)
Method Detail¶
InitializeAxis¶
-
DatumSurfaceBuilder.
InitializeAxis
¶ Update the axis origin to a point specified, and direction to closest principal axis to face normal.
The point will be adjusted by snapping to a grid.
Signature
InitializeAxis(approximatePoint)
Parameters: approximatePoint ( NXOpen.Point3d
) –New in version NX8.5.0.
License requirements: ugweld (“UG WELD”)
MoveMinimumDistance¶
-
DatumSurfaceBuilder.
MoveMinimumDistance
¶ Moves a point to the nearest location on the resting face
Signature
MoveMinimumDistance()
New in version NX8.5.0.
License requirements: ugweld (“UG WELD”)
UpdateAxisData¶
-
DatumSurfaceBuilder.
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”)
UpdateWithReferenceDatum¶
-
DatumSurfaceBuilder.
UpdateWithReferenceDatum
¶ Initialize the builder with the inputs from an existing datum surface locator.
Signature
UpdateWithReferenceDatum()
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
Validate¶
-
DatumSurfaceBuilder.
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.