FaceColorManagementBuilder Class¶
-
class
NXOpen.Tooling.FaceColorManagementBuilder¶ Bases:
NXOpen.BuilderTooling builder to assign and edit color of objects
To create a new instance of this class, use
NXOpen.Tooling.FaceColorManagementCollection.CreateFaceColorManagementBuilder()Default values.
Property Value AngleNoseIgnorableSize 0.5 FaceTranslucency 0 HighlightSelectedFace 0 HoleTypeEnum ThroughHoles IsAutoSelectHoleByType 0 IsShowFaceWithSameColorAttributeToggle 0 IsShowFaceWithoutColorAttributeToggle 0 OnlyCheckHoleFace 0 SelectSubHoleFaceAutomatically 0 New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| AngleNoseIgnorableSize | Returns or sets the angle nose ignorable size |
| FaceColor | Returns or sets the face color |
| FaceTranslucency | Returns or sets the face translucency |
| HighlightSelectedFace | Returns or sets the option whether to highlight selected faces |
| HoleTypeEnum | Returns or sets the hole type enumeration |
| IsAutoSelectHoleByType | Returns or sets the option whether to select holes by type automatically |
| IsShowFaceWithSameColorAttributeToggle | Returns or sets the option whether to show face with same color attribute toggle |
| IsShowFaceWithoutColorAttributeToggle | Returns or sets the option whether to show face without color attribute toggle |
| OnlyCheckHoleFace | Returns or sets the only check planar face option |
| SelectColorSpreadsheet | Returns or sets the face color spreadsheet |
| SelectCurve | Returns the select curve |
| SelectFace | Returns the selected faces |
| SelectHoleAxis | Returns or sets the hole axis |
| SelectSubHoleFaceAutomatically | Returns or sets the select sub-hole face automatically option |
| Tag | Returns the Tag for this object. |
| WizardType | Returns or sets the wizard type |
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. |
| EditColorSpreadsheet | The action to edit face color spreadsheet |
| 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. |
| ShowFaceWithSameManufacturingInformationButton | The action to show face with same manufacturing information |
| ShowFaceWithoutAnyManufacturingInformationButton | The action to show face without any manufacturing information |
| ShowFacesWithoutColorAttrirbute | The action to show faces without color attributes |
| 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¶
| FaceColorManagementBuilderHoleTypeEnumValue Enumeration | the hole type enumeration |
Property Detail¶
AngleNoseIgnorableSize¶
-
FaceColorManagementBuilder.AngleNoseIgnorableSize¶ Returns or sets the angle nose ignorable size
-------------------------------------Getter Method
Signature
AngleNoseIgnorableSize()Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AngleNoseIgnorableSize(angleNoseIgnorableSize)Parameters: angleNoseIgnorableSize (float) – New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR nx_electrode_wizard (“NX Electrode Wizard”)
FaceColor¶
-
FaceColorManagementBuilder.FaceColor¶ Returns or sets the face color
-------------------------------------Getter Method
Signature
FaceColor()Returns: Return type: Id New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FaceColor(faceColor)Parameters: faceColor (Id) – New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR nx_electrode_wizard (“NX Electrode Wizard”)
FaceTranslucency¶
-
FaceColorManagementBuilder.FaceTranslucency¶ Returns or sets the face translucency
-------------------------------------Getter Method
Signature
FaceTranslucency()Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FaceTranslucency(faceTranslucency)Parameters: faceTranslucency (int) – New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR nx_electrode_wizard (“NX Electrode Wizard”)
HighlightSelectedFace¶
-
FaceColorManagementBuilder.HighlightSelectedFace¶ Returns or sets the option whether to highlight selected faces
-------------------------------------Getter Method
Signature
HighlightSelectedFace()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
HighlightSelectedFace(highlightSelectedFace)Parameters: highlightSelectedFace (bool) – New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR nx_electrode_wizard (“NX Electrode Wizard”)
HoleTypeEnum¶
-
FaceColorManagementBuilder.HoleTypeEnum¶ Returns or sets the hole type enumeration
-------------------------------------Getter Method
Signature
HoleTypeEnum()Returns: Return type: NXOpen.Tooling.FaceColorManagementBuilderHoleTypeEnumValueNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
HoleTypeEnum(holeTypeEnum)Parameters: holeTypeEnum ( NXOpen.Tooling.FaceColorManagementBuilderHoleTypeEnumValue) –New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR nx_electrode_wizard (“NX Electrode Wizard”)
IsAutoSelectHoleByType¶
-
FaceColorManagementBuilder.IsAutoSelectHoleByType¶ Returns or sets the option whether to select holes by type automatically
-------------------------------------Getter Method
Signature
IsAutoSelectHoleByType()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsAutoSelectHoleByType(isAutoSelectHoleByType)Parameters: isAutoSelectHoleByType (bool) – New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR nx_electrode_wizard (“NX Electrode Wizard”)
IsShowFaceWithSameColorAttributeToggle¶
-
FaceColorManagementBuilder.IsShowFaceWithSameColorAttributeToggle¶ Returns or sets the option whether to show face with same color attribute toggle
-------------------------------------Getter Method
Signature
IsShowFaceWithSameColorAttributeToggle()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsShowFaceWithSameColorAttributeToggle(isShowFaceWithSameColorAttributeToggle)Parameters: isShowFaceWithSameColorAttributeToggle (bool) – New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR nx_electrode_wizard (“NX Electrode Wizard”)
IsShowFaceWithoutColorAttributeToggle¶
-
FaceColorManagementBuilder.IsShowFaceWithoutColorAttributeToggle¶ Returns or sets the option whether to show face without color attribute toggle
-------------------------------------Getter Method
Signature
IsShowFaceWithoutColorAttributeToggle()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsShowFaceWithoutColorAttributeToggle(isShowFaceWithoutColorAttributeToggle)Parameters: isShowFaceWithoutColorAttributeToggle (bool) – New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR nx_electrode_wizard (“NX Electrode Wizard”)
OnlyCheckHoleFace¶
-
FaceColorManagementBuilder.OnlyCheckHoleFace¶ Returns or sets the only check planar face option
-------------------------------------Getter Method
Signature
OnlyCheckHoleFace()Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OnlyCheckHoleFace(onlyCheckHoleFace)Parameters: onlyCheckHoleFace (bool) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
SelectColorSpreadsheet¶
-
FaceColorManagementBuilder.SelectColorSpreadsheet¶ Returns or sets the face color spreadsheet
-------------------------------------Getter Method
Signature
SelectColorSpreadsheet()Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SelectColorSpreadsheet(filename)Parameters: filename (str) – New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR nx_electrode_wizard (“NX Electrode Wizard”)
SelectCurve¶
-
FaceColorManagementBuilder.SelectCurve¶ Returns the select curve
-------------------------------------Getter Method
Signature
SelectCurve()Returns: Return type: NXOpen.ScCollectorNew in version NX9.0.0.
License requirements: None.
SelectFace¶
-
FaceColorManagementBuilder.SelectFace¶ Returns the selected faces
-------------------------------------Getter Method
Signature
SelectFace()Returns: Return type: NXOpen.ScCollectorNew in version NX9.0.0.
License requirements: None.
SelectHoleAxis¶
-
FaceColorManagementBuilder.SelectHoleAxis¶ Returns or sets the hole axis
-------------------------------------Getter Method
Signature
SelectHoleAxis()Returns: Return type: NXOpen.DirectionNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SelectHoleAxis(selectHoleAxis)Parameters: selectHoleAxis ( NXOpen.Direction) –New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR nx_electrode_wizard (“NX Electrode Wizard”)
SelectSubHoleFaceAutomatically¶
-
FaceColorManagementBuilder.SelectSubHoleFaceAutomatically¶ Returns or sets the select sub-hole face automatically option
-------------------------------------Getter Method
Signature
SelectSubHoleFaceAutomatically()Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SelectSubHoleFaceAutomatically(selectSubHoleFaceAutomatically)Parameters: selectSubHoleFaceAutomatically (bool) – New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
WizardType¶
-
FaceColorManagementBuilder.WizardType¶ Returns or sets the wizard type
-------------------------------------Getter Method
Signature
WizardType()Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
WizardType(wizardType)Parameters: wizardType (int) – New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR nx_electrode_wizard (“NX Electrode Wizard”)
Method Detail¶
EditColorSpreadsheet¶
-
FaceColorManagementBuilder.EditColorSpreadsheet¶ The action to edit face color spreadsheet
Signature
EditColorSpreadsheet()New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR nx_electrode_wizard (“NX Electrode Wizard”)
ShowFaceWithSameManufacturingInformationButton¶
-
FaceColorManagementBuilder.ShowFaceWithSameManufacturingInformationButton¶ The action to show face with same manufacturing information
Signature
ShowFaceWithSameManufacturingInformationButton()New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
ShowFaceWithoutAnyManufacturingInformationButton¶
-
FaceColorManagementBuilder.ShowFaceWithoutAnyManufacturingInformationButton¶ The action to show face without any manufacturing information
Signature
ShowFaceWithoutAnyManufacturingInformationButton()New in version NX10.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
ShowFacesWithoutColorAttrirbute¶
-
FaceColorManagementBuilder.ShowFacesWithoutColorAttrirbute¶ The action to show faces without color attributes
Signature
ShowFacesWithoutColorAttrirbute()New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”) OR nx_electrode_wizard (“NX Electrode Wizard”)
Validate¶
-
FaceColorManagementBuilder.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.