PaintParametersBuilder Class¶
-
class
NXOpen.Features.
PaintParametersBuilder
¶ Bases:
NXOpen.Builder
Represents a paint feature parameters builder.
The paint parameters does not create a feature, but assists to copy parameters from one feature, called source feature, and apply them to other features, called target features. Features Parameters would be copied from the source feature to the target features. If
PaintParametersBuilder.TargetComponentSelection`
is set to true, all the features in the components,PaintParametersBuilder.TargetComponents`
that are compatible for parameter painting with the source feature,PaintParametersBuilder.SourceFeature`
would also be set as the target features.To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreatePaintParametersBuilder
Default values.
Property Value TargetComponentSelection 0 New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
SourceFeature | Returns the source feature |
SourceObject | Returns the source paintable object |
Tag | Returns the Tag for this object. |
TargetComponentSelection | Returns or sets the target component selection. |
TargetComponents | Returns the target components that contain the target features. |
TargetFeatures | Returns the target features |
TargetObjects | Returns the target paintable objects |
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. |
GetCompatibleTargetObjectContainers | Find paintable object containers from targetObjTag. |
GetObject | Returns the object currently being edited by this builder. |
IsSourcePaintableObjectContainer | Check if this object contains paintable object. |
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¶
SourceFeature¶
-
PaintParametersBuilder.
SourceFeature
¶ Returns the source feature
-------------------------------------
Getter Method
Signature
SourceFeature()
Returns: Return type: NXOpen.Features.SelectFeature
New in version NX9.0.0.
License requirements: None.
SourceObject¶
-
PaintParametersBuilder.
SourceObject
¶ Returns the source paintable object
-------------------------------------
Getter Method
Signature
SourceObject()
Returns: Return type: NXOpen.SelectTaggedObject
New in version NX10.0.0.
License requirements: None.
TargetComponentSelection¶
-
PaintParametersBuilder.
TargetComponentSelection
¶ Returns or sets the target component selection.
When this property is set to true, all the features in the components,
PaintParametersBuilder.TargetComponents`
that are compatible for parameter painting with the source feature,PaintParametersBuilder.SourceFeature`
would also be set as the target features.-------------------------------------
Getter Method
Signature
TargetComponentSelection()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TargetComponentSelection(targetComponentSelection)
Parameters: targetComponentSelection (bool) – New in version NX9.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
TargetComponents¶
-
PaintParametersBuilder.
TargetComponents
¶ Returns the target components that contain the target features.
If
PaintParametersBuilder.TargetComponentSelection`
is set to true, all the features in these components, that are compatible for parameter painting with the source feature,PaintParametersBuilder.SourceFeature`
would also be set as the target features.-------------------------------------
Getter Method
Signature
TargetComponents()
Returns: Return type: NXOpen.Assemblies.SelectComponentList
New in version NX9.0.0.
License requirements: None.
TargetFeatures¶
-
PaintParametersBuilder.
TargetFeatures
¶ Returns the target features
-------------------------------------
Getter Method
Signature
TargetFeatures()
Returns: Return type: NXOpen.Features.SelectFeatureList
New in version NX9.0.0.
License requirements: None.
TargetObjects¶
-
PaintParametersBuilder.
TargetObjects
¶ Returns the target paintable objects
-------------------------------------
Getter Method
Signature
TargetObjects()
Returns: Return type: NXOpen.SelectTaggedObjectList
New in version NX10.0.0.
License requirements: None.
Method Detail¶
GetCompatibleTargetObjectContainers¶
-
PaintParametersBuilder.
GetCompatibleTargetObjectContainers
¶ Find paintable object containers from targetObjTag.
Signature
GetCompatibleTargetObjectContainers(sourceContainer, targetObjTag)
Parameters: - sourceContainer (
NXOpen.NXObject
) – - targetObjTag (
NXOpen.NXObject
) –
Returns: Return type: list of
NXOpen.NXObject
New in version NX10.0.0.
License requirements: None.
- sourceContainer (
IsSourcePaintableObjectContainer¶
-
PaintParametersBuilder.
IsSourcePaintableObjectContainer
¶ Check if this object contains paintable object.
Signature
IsSourcePaintableObjectContainer(containerObj)
Parameters: containerObj ( NXOpen.NXObject
) –Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
Validate¶
-
PaintParametersBuilder.
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.