EmbossBodyBuilder Class

class NXOpen.Features.EmbossBodyBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a NXOpen.Features.EmbossBody builder

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

Default values.

Property Value
Clearance.Value 0 (millimeters part), 0 (inches part)
ThickenOption True
Thickness.Value 2 (millimeters part), 0.1 (inches part)

New in version NX8.5.0.

Properties

Property Description
CapFace Returns or sets the cap face used to trim
Clearance Returns the emboss clearance
KeepTargets Returns or sets the copy targets flag
KeepTools Returns or sets the copy tools flag
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
RegionObject Returns the region object
SurroundingPatchSurfaceFilename Returns or sets the surrounding patch surface filename
Tag Returns the Tag for this object.
TargetBody Returns or sets the target body
TargetMaterialSide Returns or sets the target material side direction
ThickenOption Returns or sets the thicken option
Thickness Returns the emboss thickness
ToolBody Returns or sets the tool body
ToolEmbossDirection Returns or sets the tool emboss direction
TrimOption Returns or sets the trim option

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.
HideInternalParentFeatureAfterEdit Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetParentFeatureInternal Set the parent features which would be internal or slaves to the feature being created or commited
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

CapFace

EmbossBodyBuilder.CapFace

Returns or sets the cap face used to trim

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

Getter Method

Signature CapFace

Returns:
Return type:NXOpen.ScCollector

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature CapFace

Parameters:capFace (NXOpen.ScCollector) –

New in version NX8.5.0.

License requirements: None.

Clearance

EmbossBodyBuilder.Clearance

Returns the emboss clearance

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

Getter Method

Signature Clearance

Returns:
Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: None.

KeepTargets

EmbossBodyBuilder.KeepTargets

Returns or sets the copy targets flag

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

Getter Method

Signature KeepTargets

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature KeepTargets

Parameters:keepTargets (bool) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

KeepTools

EmbossBodyBuilder.KeepTools

Returns or sets the copy tools flag

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

Getter Method

Signature KeepTools

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature KeepTools

Parameters:keepTools (bool) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

RegionObject

EmbossBodyBuilder.RegionObject

Returns the region object

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

Getter Method

Signature RegionObject

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX8.5.0.

License requirements: None.

TargetBody

EmbossBodyBuilder.TargetBody

Returns or sets the target body

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

Getter Method

Signature TargetBody

Returns:
Return type:NXOpen.ScCollector

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature TargetBody

Parameters:targetBody (NXOpen.ScCollector) –

New in version NX8.5.0.

License requirements: None.

TargetMaterialSide

EmbossBodyBuilder.TargetMaterialSide

Returns or sets the target material side direction

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

Getter Method

Signature TargetMaterialSide

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature TargetMaterialSide

Parameters:targetMaterialSide (bool) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ThickenOption

EmbossBodyBuilder.ThickenOption

Returns or sets the thicken option

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

Getter Method

Signature ThickenOption

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ThickenOption

Parameters:thickenOption (bool) –

New in version NX8.5.0.

License requirements: None.

Thickness

EmbossBodyBuilder.Thickness

Returns the emboss thickness

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

Getter Method

Signature Thickness

Returns:
Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: None.

ToolBody

EmbossBodyBuilder.ToolBody

Returns or sets the tool body

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

Getter Method

Signature ToolBody

Returns:
Return type:NXOpen.ScCollector

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ToolBody

Parameters:toolBody (NXOpen.ScCollector) –

New in version NX8.5.0.

License requirements: None.

ToolEmbossDirection

EmbossBodyBuilder.ToolEmbossDirection

Returns or sets the tool emboss direction

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

Getter Method

Signature ToolEmbossDirection

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ToolEmbossDirection

Parameters:toolEmbossDirection (bool) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

TrimOption

EmbossBodyBuilder.TrimOption

Returns or sets the trim option

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

Getter Method

Signature TrimOption

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature TrimOption

Parameters:trimOption (bool) –

New in version NX8.5.0.

License requirements: None.

Method Detail

Validate

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