EmbossBuilder Class

class NXOpen.Features.EmbossBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents an emboss feature builder that creates or edits an emboss feature.

This class provides methods to set and get the multiple region subobjects and tolerance.

The following is default value:

**Tolerance</b> Distance tolerance 0.001/0.0254[in/mm]

To create a new instance of this class, use NXOpen.Features.FeatureCollection.CreateEmbossBuilder()

New in version NX4.0.0.

Properties

Property Description
ParentFeatureInternal Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag Returns or sets the patch solution flag
PatchSurfaceFilename Returns or sets the patch surface filename
SurroundingPatchSurfaceFilename Returns or sets the surrounding patch surface filename
Tag Returns the Tag for this object.
Tolerance Returns or sets the distance tolerance

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
CommitFeature Commits the feature parameters and creates the feature
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.
GetFeature Returns the feature currently being edited by this builder.
GetObject Returns the object currently being edited by this builder.
GetRegions The emboss regions
HideInternalParentFeatureAfterEdit Re-suppress an internal parent feature (a slave feature) after it has been edited.
MakeParentSketchInternal Set the parent sketch internalization status for use during emboss feature creation
SetParentFeatureInternal Set the parent features which would be internal or slaves to the feature being created or commited
SetRegions  
ShowInternalParentFeatureForEdit Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal Set the internal parent feature of the feature being edited to external
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

Tolerance

EmbossBuilder.Tolerance

Returns or sets the distance tolerance

-------------------------------------

Getter Method

Signature Tolerance

Returns:distance tolerance
Return type:float

New in version NX4.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Tolerance

Parameters:tolerance (float) – distance tolerance

New in version NX4.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Method Detail

GetRegions

EmbossBuilder.GetRegions

The emboss regions

Signature GetRegions()

Returns:Array of emboss region objects. In NX4, only one region is supported.
Return type:list of NXOpen.Features.EmbossRegion

New in version NX4.0.0.

License requirements: None.

MakeParentSketchInternal

EmbossBuilder.MakeParentSketchInternal

Set the parent sketch internalization status for use during emboss feature creation

Signature MakeParentSketchInternal(internalizeParentSketch)

Parameters:internalizeParentSketch (bool) – If true, internalize the parent sketch, else the sketch will remain external.

New in version NX4.0.1.

License requirements: solid_modeling (“SOLIDS MODELING”)

SetRegions

EmbossBuilder.SetRegions

Signature SetRegions(regions)

Parameters:regions (list of NXOpen.Features.EmbossRegion) – Array of emboss region objects. In NX4, only one region is supported.

New in version NX4.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

Validate

EmbossBuilder.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.