DatumAxisBuilder Class¶
-
class
NXOpen.Features.
DatumAxisBuilder
¶ Bases:
NXOpen.Features.DatumBuilder
Represents a datum axis feature builder.
Provides methods to create datum axis thru two points, point and direction and point on curve. Also provides generic method for creation of datum axis feature
To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateDatumAxisBuilder()
New in version NX3.0.0.
Properties¶
Property | Description |
---|---|
AlternateSolutionType | Returns or sets the alternate solution type. |
ArcLength | Returns the arc length. |
Curve | Returns the curve or edge. |
CurveOrFace | Returns the curve or face . |
CurveOrientation | Returns or sets the orientation of vector on a curve. |
DirectionOrientation | Returns or sets the direction orientation. |
IsAssociative | Returns or sets the associativity. |
IsAxisReversed | Returns or sets the datum axis direction. |
Object1 | Returns the first object (i. |
Object2 | Returns the second object (i. |
Objects | Returns the objects to define Datum Axis. |
OrientationObject | Returns the orientation object. |
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 |
Point | Returns or sets the point. |
Point1 | Returns or sets the first point. |
Point2 | Returns or sets the second point. |
ResizedEndDistance | Returns or sets the resized distance for the end point. |
ReverseDirection | Returns or sets |
Section | Returns the section. |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
Type | Returns or sets the Datum Axis type |
Vector | Returns or sets the vector. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
CreateConstraint | Creates a new empty constraint object. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
EvaluatePath | Evaluate the path. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetConstraints | Gets the contraint objects that define the positioning of this datum. |
GetFeature | Returns the feature currently being edited by this builder. |
GetObject | Returns the object currently being edited by this builder. |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
SetConstraints | Sets the contraint objects that define the positioning of this datum. |
SetFixedDatumAxis | Sets type of fixed datum axis |
SetGeometryAndConstraints | Sets two different geometric objects. |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
SetPointAndDirection | |
SetPointOnCurve | Sets curve or edge and arc length |
SetTwoPoints | Sets two points |
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 |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
DatumAxisBuilderAlternateSolution Enumeration | Specifies the alternate solution for datum axis using point on curve method only |
DatumAxisBuilderConstraintType Enumeration | Specifies different constraint types for selected geometries |
DatumAxisBuilderCurveOption Enumeration | Specifies the distance on the curve as absolute distance or relative distance as percentage |
DatumAxisBuilderCurveOrientations Enumeration | Available orientations that the user can choose when the Datum Axis type is On Curve Vector |
DatumAxisBuilderDirectionOrientations Enumeration | Two available direction orientations that the user can choose when the Datum Axis type is Point and Direction |
DatumAxisBuilderFixedType Enumeration | Specifies the fixed type datum axis going thru only one specific axis or thru all axes. |
DatumAxisBuilderTypes Enumeration | New Datum Axis types in NX5 |
DatumAxisBuilderUseArcLength Enumeration | Specifies points for which arclength is to be used. |
Property Detail¶
AlternateSolutionType¶
-
DatumAxisBuilder.
AlternateSolutionType
¶ Returns or sets the alternate solution type.
This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.OnCurveVector
-------------------------------------
Getter Method
Signature
AlternateSolutionType()
Returns: Return type: NXOpen.Features.DatumAxisBuilderAlternateSolution
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AlternateSolutionType(alternateSolutionType)
Parameters: alternateSolutionType ( NXOpen.Features.DatumAxisBuilderAlternateSolution
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
ArcLength¶
-
DatumAxisBuilder.
ArcLength
¶ Returns the arc length.
This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.OnCurveVector
-------------------------------------
Getter Method
Signature
ArcLength()
Returns: Return type: NXOpen.GeometricUtilities.OnPathDimensionBuilder
New in version NX5.0.0.
License requirements: None.
Curve¶
-
DatumAxisBuilder.
Curve
¶ Returns the curve or edge.
This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.OnCurveVector
-------------------------------------
Getter Method
Signature
Curve()
Returns: Return type: NXOpen.SelectICurve
New in version NX5.0.0.
License requirements: None.
CurveOrFace¶
-
DatumAxisBuilder.
CurveOrFace
¶ Returns the curve or face .
This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.CurveOrFaceAxis
-------------------------------------
Getter Method
Signature
CurveOrFace()
Returns: Return type: NXOpen.SelectNXObject
New in version NX5.0.0.
License requirements: None.
CurveOrientation¶
-
DatumAxisBuilder.
CurveOrientation
¶ Returns or sets the orientation of vector on a curve.
This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.OnCurveVector
-------------------------------------
Getter Method
Signature
CurveOrientation()
Returns: Return type: NXOpen.Features.DatumAxisBuilderCurveOrientations
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CurveOrientation(curveOrientation)
Parameters: curveOrientation ( NXOpen.Features.DatumAxisBuilderCurveOrientations
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
DirectionOrientation¶
-
DatumAxisBuilder.
DirectionOrientation
¶ Returns or sets the direction orientation.
This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.PointAndDir
-------------------------------------
Getter Method
Signature
DirectionOrientation()
Returns: Return type: NXOpen.Features.DatumAxisBuilderDirectionOrientations
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DirectionOrientation(directionOrientation)
Parameters: directionOrientation ( NXOpen.Features.DatumAxisBuilderDirectionOrientations
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
IsAssociative¶
-
DatumAxisBuilder.
IsAssociative
¶ Returns or sets the associativity.
If true, the Datum Axis is associative
-------------------------------------
Getter Method
Signature
IsAssociative()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsAssociative(isAssociative)
Parameters: isAssociative (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
IsAxisReversed¶
-
DatumAxisBuilder.
IsAxisReversed
¶ Returns or sets the datum axis direction.
If true, the Datum Axis direction is reversed
-------------------------------------
Getter Method
Signature
IsAxisReversed()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsAxisReversed(isAxisReversed)
Parameters: isAxisReversed (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
Object1¶
-
DatumAxisBuilder.
Object1
¶ Returns the first object (i.
e. a planar face or datum plane). This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.Intersection
-------------------------------------
Getter Method
Signature
Object1()
Returns: Return type: NXOpen.SelectNXObject
New in version NX5.0.0.
License requirements: None.
Object2¶
-
DatumAxisBuilder.
Object2
¶ Returns the second object (i.
e. a planar face or datum plane). This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.Intersection
-------------------------------------
Getter Method
Signature
Object2()
Returns: Return type: NXOpen.SelectNXObject
New in version NX5.0.0.
License requirements: None.
Objects¶
-
DatumAxisBuilder.
Objects
¶ Returns the objects to define Datum Axis.
This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.Inferred
-------------------------------------
Getter Method
Signature
Objects()
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX5.0.0.
License requirements: None.
OrientationObject¶
-
DatumAxisBuilder.
OrientationObject
¶ Returns the orientation object.
This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.OnCurveVector
-------------------------------------
Getter Method
Signature
OrientationObject()
Returns: Return type: NXOpen.SelectNXObject
New in version NX5.0.0.
License requirements: None.
Point¶
-
DatumAxisBuilder.
Point
¶ Returns or sets the point.
This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.PointAndDir
-------------------------------------
Getter Method
Signature
Point()
Returns: Return type: NXOpen.Point
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Point(point)
Parameters: point ( NXOpen.Point
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
Point1¶
-
DatumAxisBuilder.
Point1
¶ Returns or sets the first point.
This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.TwoPoints
-------------------------------------
Getter Method
Signature
Point1()
Returns: Return type: NXOpen.Point
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Point1(point1)
Parameters: point1 ( NXOpen.Point
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
Point2¶
-
DatumAxisBuilder.
Point2
¶ Returns or sets the second point.
This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.TwoPoints
-------------------------------------
Getter Method
Signature
Point2()
Returns: Return type: NXOpen.Point
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Point2(point2)
Parameters: point2 ( NXOpen.Point
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
ResizedEndDistance¶
-
DatumAxisBuilder.
ResizedEndDistance
¶ Returns or sets the resized distance for the end point.
If the value is 0.0, then this datum axis is not resized at end point
-------------------------------------
Getter Method
Signature
ResizedEndDistance()
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ResizedEndDistance(resizedEndDistance)
Parameters: resizedEndDistance (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
ReverseDirection¶
-
DatumAxisBuilder.
ReverseDirection
¶ Returns or sets
-------------------------------------
Getter Method
Signature
ReverseDirection()
Returns: Return type: bool New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
-------------------------------------
Setter Method
Signature
ReverseDirection(reverseDirection)
Parameters: reverseDirection (bool) – New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
Section¶
-
DatumAxisBuilder.
Section
¶ Returns the section.
This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.OnCurveVector
-------------------------------------
Getter Method
Signature
Section()
Returns: Return type: NXOpen.Section
New in version NX8.0.0.
License requirements: None.
Type¶
-
DatumAxisBuilder.
Type
¶ Returns or sets the Datum Axis type
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Features.DatumAxisBuilderTypes
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Features.DatumAxisBuilderTypes
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
Vector¶
-
DatumAxisBuilder.
Vector
¶ Returns or sets the vector.
This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.PointAndDir
-------------------------------------
Getter Method
Signature
Vector()
Returns: Return type: NXOpen.Direction
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Vector(vector)
Parameters: vector ( NXOpen.Direction
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
Method Detail¶
EvaluatePath¶
-
DatumAxisBuilder.
EvaluatePath
¶ Evaluate the path.
If there is no path, create it, otherwise evaluate it. This is used only if the Datum Axis type is
Features.DatumAxisBuilderTypes.OnCurveVector
Signature
EvaluatePath(section)
Parameters: section ( NXOpen.Section
) –New in version NX8.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
SetFixedDatumAxis¶
-
DatumAxisBuilder.
SetFixedDatumAxis
¶ Sets type of fixed datum axis
Signature
SetFixedDatumAxis(type)
Parameters: type ( NXOpen.Features.DatumAxisBuilderFixedType
) – Indicates fixed datum axis typeNew in version NX3.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
SetGeometryAndConstraints¶
-
DatumAxisBuilder.
SetGeometryAndConstraints
¶ Sets two different geometric objects.
Possible combinations are:
- If first constrain is Through Point, then the second contraint can be:
- Solid Body Vertex (endpoint)
- Edge Midpoint
- If first constrain is Intersection of Plane, then the second contraint can be:
- Through the straight edge formed by the intersection of two planes
- If first constrain is Through Curve, then the second contraint can be:
- Used with Through Point constraint and along a curve
- If first constrain is Perpendicular to object, then the second contraint can be:
- Through Curve and Through Point perpendicular to lines, linear edge,
datum planes, datum axis, or planar faces
Signature
SetGeometryAndConstraints(geometry1, geometryConstraintType1, constraintAttribute1, constraintValue1, constraint1, geometry2, geometryConstraintType2, constraintAttribute2, constraintValue2, constraint2, direction)
Parameters: - geometry1 (
NXOpen.DisplayableObject
) – First geometric object - geometryConstraintType1 (
NXOpen.Features.DatumAxisBuilderConstraintType
) – Constraint type of first geometry - constraintAttribute1 (int) – Constraint attribute value of first geometry VRH alternate_solution_only - only for point on curve
- constraintValue1 (float) – Constraint value parameter of first geometry
- constraint1 (str) – Constraint attached with first geometric object. Set to “0.0” in case value is not specified
- geometry2 (
NXOpen.DisplayableObject
) – Second geometric object - geometryConstraintType2 (
NXOpen.Features.DatumAxisBuilderConstraintType
) – Constraint type of second geometry - constraintAttribute2 (int) – Constraint attribute value of second geometry
- constraintValue2 (float) – Constraint value parameter of second geometry
- constraint2 (str) – Constraint attached with second geometric object. Set to “0.0” in case value is not specified
- direction (
NXOpen.Sense
) – Flag to specify datum axis direction
New in version NX3.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
SetPointAndDirection¶
-
DatumAxisBuilder.
SetPointAndDirection
¶ Signature
SetPointAndDirection(point, direction)
Parameters: - point (
NXOpen.Point
) – - direction (
NXOpen.Direction
) –
New in version NX3.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
- point (
SetPointOnCurve¶
-
DatumAxisBuilder.
SetPointOnCurve
¶ Overloaded method SetPointOnCurve
SetPointOnCurve(arcLength, constraint, alternateSolution, option, curve)
SetPointOnCurve(arcLength, constraint, option, curve, secondGeometry)
SetPointOnCurve(arcLength, constraint, option, secondGeometry, curve)
-------------------------------------
Sets curve or edge and arc length
Signature
SetPointOnCurve(arcLength, constraint, alternateSolution, option, curve)
Parameters: - arcLength (float) – Arc length
- constraint (str) – Constraint expression. Usually same as arc_length
- alternateSolution (
NXOpen.Features.DatumAxisBuilderAlternateSolution
) – Alternate solution - option (
NXOpen.Features.DatumAxisBuilderCurveOption
) – Absolute distance or relative distance - curve (
NXOpen.ICurve
) – Curve or Edge object
New in version NX3.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
-------------------------------------
Sets Curve or Edge object and arc length with an extra geometry in picture
Signature
SetPointOnCurve(arcLength, constraint, option, curve, secondGeometry)
Parameters: - arcLength (float) – Arc length
- constraint (str) – Constraint expression. Usually same as arc_length
- option (
NXOpen.Features.DatumAxisBuilderCurveOption
) – Absolute distance or relative distance - curve (
NXOpen.ICurve
) – Curve or Edge object - secondGeometry (
NXOpen.DisplayableObject
) – Second geometric object
New in version NX3.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
-------------------------------------
Sets Curve or Edge object and arc length with an extra geometry in picture
Signature
SetPointOnCurve(arcLength, constraint, option, secondGeometry, curve)
Parameters: - arcLength (float) – Arc length
- constraint (str) – Constraint expression. Usually same as arc_length
- option (
NXOpen.Features.DatumAxisBuilderCurveOption
) – Absolute distance or relative distance - secondGeometry (
NXOpen.DisplayableObject
) – Second Geometric object - curve (
NXOpen.ICurve
) – Curve or Edge object
New in version NX3.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
-------------------------------------
SetTwoPoints¶
-
DatumAxisBuilder.
SetTwoPoints
¶ Sets two points
Signature
SetTwoPoints(point1, point2, useArcLength)
Parameters: - point1 (
NXOpen.Point
) – - point2 (
NXOpen.Point
) – - useArcLength (
NXOpen.Features.DatumAxisBuilderUseArcLength
) – Specify points which use arclength instead of percentage of arclength
New in version NX3.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR geometric_tol (“GDT”)
- point1 (
Validate¶
-
DatumAxisBuilder.
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.