Create weld labels for multiple welds and BIW locators, this builder's Commit can produce more than one object, the GetCommittedObjects can be used to get the objects and the order of GetCommittedObject's output array is stable. More...
Public Types | |
| enum | OrientationPlaneType { OrientationPlaneTypeXYPlane, OrientationPlaneTypeXZPlane, OrientationPlaneTypeYZPlane, OrientationPlaneTypeModelView, OrientationPlaneTypeLastUserDefined, OrientationPlaneTypeUserDefined } |
| This represents the Orientation Plane Type. More... | |
Public Member Functions | |
| bool | IncludeLeader () |
| Returns the leader option, indicates whether to create a leader Created in NX8.5.0. More... | |
| NXOpen::Annotations::LeaderBuilder * | Leader () |
| Returns the NXOpen::Annotations::LeaderBuilder for the annotation Created in NX8.5.0. More... | |
| NXOpen::SelectNXObjectList * | Objects () |
| Returns the objects that are used to create labels. More... | |
| NXOpen::Annotations::OriginBuilder * | Origin () |
| Returns the NXOpen::Annotations::OriginBuilder for the annotation Created in NX8.5.0. More... | |
| NXOpen::Weld::WeldLabelBuilder::OrientationPlaneType | PlaneType () |
| Returns the plane type. More... | |
| void | SetIncludeLeader (bool leader) |
| Sets the leader option, indicates whether to create a leader Created in NX8.5.0. More... | |
| void | SetPlaneType (NXOpen::Weld::WeldLabelBuilder::OrientationPlaneType planeType) |
| Sets the plane type. More... | |
| void | SetUserCsys (NXOpen::CoordinateSystem *userCsys) |
| Sets the user specified coordinate system. More... | |
| NXOpen::Annotations::StyleBuilder * | Style () |
| Returns the NXOpen::Annotations::StyleBuilder for the annotation Created in NX8.5.0. More... | |
| NXOpen::Annotations::TextWithEditControlsBuilder * | Text () |
| Returns the NXOpen::Annotations::TextWithEditControlsBuilder for the annotation Created in NX8.5.0. More... | |
| NXOpen::CoordinateSystem * | UserCsys () |
| Returns the user specified coordinate system. More... | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| Commits any edits that have been applied to the builder. More... | |
| void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. More... | |
| std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. More... | |
| NXOpen::NXObject * | GetObject () |
| Returns the object currently being edited by this builder. More... | |
| void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
Create weld labels for multiple welds and BIW locators, this builder's Commit can produce more than one object, the GetCommittedObjects can be used to get the objects and the order of GetCommittedObject's output array is stable.
To create a new instance of this class, use NXOpen::Weld::WeldManager::CreateWeldLabelBuilder
Default values.
| Property | Value |
|---|---|
|
IncludeLeader |
1 |
|
Text.TextBlock.CustomSymbolScale |
1.0 |
|
Text.TextBlock.SymbolAspectRatio |
1.0 |
|
Text.TextBlock.SymbolHeight |
25.4 (millimeters part), 1.0 (inches part) |
|
Text.TextBlock.SymbolLength |
25.4 (millimeters part), 1.0 (inches part) |
|
Text.TextBlock.SymbolPreferences |
UseCurrent |
|
Text.TextBlock.SymbolScale |
1.0 |
|
Text.TextBlock.SymbolSizeMethod |
ScaleAndAspectRatio |
Created in NX8.5.0.
Member Enumeration Documentation
This represents the Orientation Plane Type.
Member Function Documentation
| bool NXOpen::Weld::WeldLabelBuilder::IncludeLeader | ( | ) |
Returns the leader option, indicates whether to create a leader
Created in NX8.5.0.
License requirements : None
| NXOpen::Annotations::LeaderBuilder* NXOpen::Weld::WeldLabelBuilder::Leader | ( | ) |
Returns the NXOpen::Annotations::LeaderBuilder for the annotation
Created in NX8.5.0.
License requirements : None
| NXOpen::SelectNXObjectList* NXOpen::Weld::WeldLabelBuilder::Objects | ( | ) |
Returns the objects that are used to create labels.
Created in NX8.5.0.
License requirements : None
| NXOpen::Annotations::OriginBuilder* NXOpen::Weld::WeldLabelBuilder::Origin | ( | ) |
Returns the NXOpen::Annotations::OriginBuilder for the annotation
Created in NX8.5.0.
License requirements : None
| NXOpen::Weld::WeldLabelBuilder::OrientationPlaneType NXOpen::Weld::WeldLabelBuilder::PlaneType | ( | ) |
Returns the plane type.
Created in NX8.5.2.
License requirements : None
| void NXOpen::Weld::WeldLabelBuilder::SetIncludeLeader | ( | bool | leader | ) |
Sets the leader option, indicates whether to create a leader
Created in NX8.5.0.
License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")
- Parameters
-
leader leader
| void NXOpen::Weld::WeldLabelBuilder::SetPlaneType | ( | NXOpen::Weld::WeldLabelBuilder::OrientationPlaneType | planeType | ) |
Sets the plane type.
Created in NX8.5.2.
License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")
- Parameters
-
planeType planetype
| void NXOpen::Weld::WeldLabelBuilder::SetUserCsys | ( | NXOpen::CoordinateSystem * | userCsys | ) |
Sets the user specified coordinate system.
Created in NX8.5.2.
License requirements : ugweld ("UG WELD") OR structure_weld ("STRUCTURE WELD")
- Parameters
-
userCsys usercsys
| NXOpen::Annotations::StyleBuilder* NXOpen::Weld::WeldLabelBuilder::Style | ( | ) |
Returns the NXOpen::Annotations::StyleBuilder for the annotation
Created in NX8.5.0.
License requirements : None
| NXOpen::Annotations::TextWithEditControlsBuilder* NXOpen::Weld::WeldLabelBuilder::Text | ( | ) |
Returns the NXOpen::Annotations::TextWithEditControlsBuilder for the annotation
Created in NX8.5.0.
License requirements : None
| NXOpen::CoordinateSystem* NXOpen::Weld::WeldLabelBuilder::UserCsys | ( | ) |
Returns the user specified coordinate system.
Created in NX8.5.2.
License requirements : None
The documentation for this class was generated from the following file:
- Weld_WeldLabelBuilder.hxx