MeasureDistanceBuilder Class¶
-
class
NXOpen.
MeasureDistanceBuilder
¶ Bases:
NXOpen.MeasureBuilder
Represents a
NXOpen.MeasureDistanceBuilder
To create a new instance of this class, use
NXOpen.MeasureManager.CreateMeasureDistanceBuilder()
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
AnnotationMode | Returns or sets the annotation mode |
DiameterObjects | Returns the diameter objects |
DistanceCollector1 | Returns the first collector of objects for distance between two collectors |
DistanceCollector2 | Returns the second collector of objects for distance between two collectors |
InfoWindow | Returns or sets the info window |
IsExact | Returns or sets the exact flag |
LengthCollector | Returns the length collector of objects |
LengthObjects | Returns the length objects |
Mtype | Returns or sets the mtype |
Object1 | Returns the object1 |
Object2 | Returns the object2 |
ProjectionVector | Returns or sets the projection vector |
RadiusObjects | Returns the radius objects |
RequirementMode | Returns or sets the requirement mode |
Set1 | Returns the set1 |
Set2 | Returns the set2 |
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. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
MeasureDistanceBuilderDistanceType Enumeration | the type of distance measurement |
MeasureDistanceBuilderMeasureType Enumeration | the subtype of distance measurement |
Property Detail¶
DiameterObjects¶
-
MeasureDistanceBuilder.
DiameterObjects
¶ Returns the diameter objects
-------------------------------------
Getter Method
Signature
DiameterObjects()
Returns: Return type: NXOpen.SelectDisplayableObject
New in version NX8.5.0.
License requirements: None.
DistanceCollector1¶
-
MeasureDistanceBuilder.
DistanceCollector1
¶ Returns the first collector of objects for distance between two collectors
-------------------------------------
Getter Method
Signature
DistanceCollector1()
Returns: Return type: NXOpen.ScCollector
New in version NX8.5.0.
License requirements: None.
DistanceCollector2¶
-
MeasureDistanceBuilder.
DistanceCollector2
¶ Returns the second collector of objects for distance between two collectors
-------------------------------------
Getter Method
Signature
DistanceCollector2()
Returns: Return type: NXOpen.ScCollector
New in version NX8.5.0.
License requirements: None.
IsExact¶
-
MeasureDistanceBuilder.
IsExact
¶ Returns or sets the exact flag
-------------------------------------
Getter Method
Signature
IsExact()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsExact(isExact)
Parameters: isExact (bool) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
LengthCollector¶
-
MeasureDistanceBuilder.
LengthCollector
¶ Returns the length collector of objects
-------------------------------------
Getter Method
Signature
LengthCollector()
Returns: Return type: NXOpen.ScCollector
New in version NX8.5.0.
License requirements: None.
LengthObjects¶
-
MeasureDistanceBuilder.
LengthObjects
¶ Returns the length objects
-------------------------------------
Getter Method
Signature
LengthObjects()
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX5.0.0.
License requirements: None.
Mtype¶
-
MeasureDistanceBuilder.
Mtype
¶ Returns or sets the mtype
-------------------------------------
Getter Method
Signature
Mtype()
Returns: Return type: NXOpen.MeasureDistanceBuilderMeasureType
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Mtype(mtype)
Parameters: mtype ( NXOpen.MeasureDistanceBuilderMeasureType
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Object1¶
-
MeasureDistanceBuilder.
Object1
¶ Returns the object1
-------------------------------------
Getter Method
Signature
Object1()
Returns: Return type: NXOpen.SelectDisplayableObject
New in version NX5.0.0.
License requirements: None.
Object2¶
-
MeasureDistanceBuilder.
Object2
¶ Returns the object2
-------------------------------------
Getter Method
Signature
Object2()
Returns: Return type: NXOpen.SelectDisplayableObject
New in version NX5.0.0.
License requirements: None.
ProjectionVector¶
-
MeasureDistanceBuilder.
ProjectionVector
¶ Returns or sets the projection vector
-------------------------------------
Getter Method
Signature
ProjectionVector()
Returns: Return type: NXOpen.Direction
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ProjectionVector(projectionVector)
Parameters: projectionVector ( NXOpen.Direction
) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
RadiusObjects¶
-
MeasureDistanceBuilder.
RadiusObjects
¶ Returns the radius objects
-------------------------------------
Getter Method
Signature
RadiusObjects()
Returns: Return type: NXOpen.SelectDisplayableObject
New in version NX5.0.0.
License requirements: None.
Set1¶
-
MeasureDistanceBuilder.
Set1
¶ Returns the set1
-------------------------------------
Getter Method
Signature
Set1()
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX5.0.0.
License requirements: None.
Set2¶
-
MeasureDistanceBuilder.
Set2
¶ Returns the set2
-------------------------------------
Getter Method
Signature
Set2()
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
MeasureDistanceBuilder.
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.