ProductOutlineBuilder Class¶
-
class
NXOpen.Assemblies.
ProductOutlineBuilder
¶ Bases:
NXOpen.Builder
Represents a builder
NXOpen.Assemblies.ProductOutlineBuilder
.Input to this class can be PSM facet objects.
To create a new instance of this class, use
NXOpen.Assemblies.ProductOutlineManager.CreateProductOutlineBuilder()
Default values.
Property Value LineFontType Solid OverrideColor false Translucency 50 New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
LineFontType | Returns or sets the line font type for the objects defined in Product Outline. |
OutlineColor | Returns or sets the color for all the objects defined in Product Outline. |
OverrideColor | Returns or sets the flag to override-color switch. |
SelectObject | Returns the objects defined in Product Outline. |
Tag | Returns the Tag for this object. |
Translucency | Returns or sets the translucency of faceted bodies/objects defined in Product Outline. |
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¶
ProductOutlineBuilderLineFont Enumeration | Represents the line font types |
Property Detail¶
LineFontType¶
-
ProductOutlineBuilder.
LineFontType
¶ Returns or sets the line font type for the objects defined in Product Outline.
The font types are mentioned in
NXOpen.Assemblies.ProductOutlineBuilderLineFont
.-------------------------------------
Getter Method
Signature
LineFontType
Returns: Return type: NXOpen.Assemblies.ProductOutlineBuilderLineFont
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LineFontType
Parameters: lineFontType ( NXOpen.Assemblies.ProductOutlineBuilderLineFont
) –New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
OutlineColor¶
-
ProductOutlineBuilder.
OutlineColor
¶ Returns or sets the color for all the objects defined in Product Outline.
The range is 1-216
-------------------------------------
Getter Method
Signature
OutlineColor
Returns: Return type: Id New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OutlineColor
Parameters: outlineColor (Id) – New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
OverrideColor¶
-
ProductOutlineBuilder.
OverrideColor
¶ Returns or sets the flag to override-color switch.
If “true” the facet representation is in original color of selected object, else representation is in the color defined by
NXOpen.Assemblies.ProductOutlineBuilder.OutlineColor()
.-------------------------------------
Getter Method
Signature
OverrideColor
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OverrideColor
Parameters: overrideColor (bool) – New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
SelectObject¶
-
ProductOutlineBuilder.
SelectObject
¶ Returns the objects defined in Product Outline.
-------------------------------------
Getter Method
Signature
SelectObject
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX6.0.0.
License requirements: None.
Translucency¶
-
ProductOutlineBuilder.
Translucency
¶ Returns or sets the translucency of faceted bodies/objects defined in Product Outline.
The range is 0-100.
-------------------------------------
Getter Method
Signature
Translucency
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Translucency
Parameters: translucency (int) – New in version NX6.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
Method Detail¶
Validate¶
-
ProductOutlineBuilder.
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.