LocatorDesignatorBuilder Class¶
-
class
NXOpen.Annotations.
LocatorDesignatorBuilder
¶ Bases:
NXOpen.Annotations.PmiAttributeBuilder
Represents a
NXOpen.Annotations.LocatorDesignator
builderTo create a new instance of this class, use
NXOpen.Annotations.PmiAttributeCollection.CreateLocatorDesignatorBuilder()
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AssociatedObjects | Returns the NXOpen.Annotations.AssociatedObjectsBuilder for the annotation |
Attribute | Returns or sets the NXOpen.Annotations.Pmi for this annotation |
BusinessModifier | Returns or sets the business modifier |
CoordinatePlane | Returns or sets the coordinateplane |
HotSpot | Returns or sets the hot spot |
HotSpotText | Returns or sets the hot spot text |
KnowledgeFusionClassName | Returns or sets the knowledge fusion class name file, the default class is UG provided pmi KF class |
Leader | Returns the NXOpen.Annotations.LeaderBuilder for the annotation |
LocatorLetter | Returns or sets the locatorletter |
LocatorType | Returns or sets the locatortype |
NormalDirection | Returns or sets the normal direction |
NoteText | Returns or sets the notetext |
Origin | Returns the NXOpen.Annotations.OriginBuilder for the annotation |
PinDirection | Returns or sets the pin direction |
PunchDirection | Returns or sets the punch direction |
Style | Returns the NXOpen.Annotations.StyleBuilder for the annotation |
Subscript | Returns or sets the subscript |
Tag | Returns the Tag for this object. |
Title | Returns or sets the str title |
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. |
GetAttributeValues | Returns the attribute values @return |
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. |
SetAttributeValues | Sets the attribute values |
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. |
Property Detail¶
CoordinatePlane¶
-
LocatorDesignatorBuilder.
CoordinatePlane
¶ Returns or sets the coordinateplane
-------------------------------------
Getter Method
Signature
CoordinatePlane()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CoordinatePlane(coordinatePlane)
Parameters: coordinatePlane (str) – New in version NX6.0.0.
License requirements: None.
HotSpot¶
-
LocatorDesignatorBuilder.
HotSpot
¶ Returns or sets the hot spot
-------------------------------------
Getter Method
Signature
HotSpot()
Returns: Return type: NXOpen.Point
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HotSpot(hotSpot)
Parameters: hotSpot ( NXOpen.Point
) –New in version NX6.0.0.
License requirements: None.
HotSpotText¶
-
LocatorDesignatorBuilder.
HotSpotText
¶ Returns or sets the hot spot text
-------------------------------------
Getter Method
Signature
HotSpotText()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HotSpotText(hotSpotText)
Parameters: hotSpotText (str) – New in version NX6.0.0.
License requirements: None.
LocatorLetter¶
-
LocatorDesignatorBuilder.
LocatorLetter
¶ Returns or sets the locatorletter
-------------------------------------
Getter Method
Signature
LocatorLetter()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LocatorLetter(locatorLetter)
Parameters: locatorLetter (str) – New in version NX6.0.0.
License requirements: None.
LocatorType¶
-
LocatorDesignatorBuilder.
LocatorType
¶ Returns or sets the locatortype
-------------------------------------
Getter Method
Signature
LocatorType()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LocatorType(locatorType)
Parameters: locatorType (str) – New in version NX6.0.0.
License requirements: None.
NormalDirection¶
-
LocatorDesignatorBuilder.
NormalDirection
¶ Returns or sets the normal direction
-------------------------------------
Getter Method
Signature
NormalDirection()
Returns: Return type: NXOpen.Direction
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NormalDirection(normalDirection)
Parameters: normalDirection ( NXOpen.Direction
) –New in version NX6.0.0.
License requirements: None.
NoteText¶
-
LocatorDesignatorBuilder.
NoteText
¶ Returns or sets the notetext
-------------------------------------
Getter Method
Signature
NoteText()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NoteText(noteText)
Parameters: noteText (str) – New in version NX6.0.0.
License requirements: None.
PinDirection¶
-
LocatorDesignatorBuilder.
PinDirection
¶ Returns or sets the pin direction
-------------------------------------
Getter Method
Signature
PinDirection()
Returns: Return type: NXOpen.Direction
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PinDirection(pinDirection)
Parameters: pinDirection ( NXOpen.Direction
) –New in version NX6.0.0.
License requirements: None.
PunchDirection¶
-
LocatorDesignatorBuilder.
PunchDirection
¶ Returns or sets the punch direction
-------------------------------------
Getter Method
Signature
PunchDirection()
Returns: Return type: NXOpen.Direction
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PunchDirection(punchDirection)
Parameters: punchDirection ( NXOpen.Direction
) –New in version NX6.0.0.
License requirements: None.
Subscript¶
-
LocatorDesignatorBuilder.
Subscript
¶ Returns or sets the subscript
-------------------------------------
Getter Method
Signature
Subscript()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Subscript(subscript)
Parameters: subscript (str) – New in version NX6.0.0.
License requirements: None.
Title¶
-
LocatorDesignatorBuilder.
Title
¶ Returns or sets the str title
-------------------------------------
Getter Method
Signature
Title()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Title(title)
Parameters: title (str) – New in version NX6.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
LocatorDesignatorBuilder.
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.