EnlargeSurfaceBuilder Class¶

class NXOpen.Tooling.EnlargeSurfaceBuilder¶

Bases: NXOpen.Builder

Mold Wizard enlarge surface management builder, trims a enlarged surface to a boundary of edges, curves, datum planes or faces.

Optionally creates output trimmed sheet body as a patch surface. To create a new instance of this class, use NXOpen.Tooling.EnlargeSurfaceCollection.CreateEnlargeSurfaceBuilder()

Default values.

Property	Value
AsPatchSurface	1
ChangeAllSizes	1
CutToBoundary	1
RegionOption	Keep
SurfaceRange.AnchorPosition	Vertex1

New in version NX7.5.0.

Properties¶

Property	Description
AsPatchSurface	Returns or sets the value of option, which specifies whether to set the result region as patch surface or not.
BodyColor	Returns or sets the color value of patch surface body.
BoundarySelection	Returns the selection of boundary to trim the target surface, it could be face, datum plane, edge and curve.
ChangeAllSizes	Returns or sets the value of option, which specifies when enlarging surface, whether to change all the sizes at the same time or not.
CutToBoundary	Returns or sets the value of option, which specifies whether to cut the target to boundary objects or not.
DragData	Returns or sets the drag preview body data from builder according to face.
RegionOption	Returns or sets the value of the option, which specifies to keep or discard the selected region.
RegionSelection	Returns the selection of region, which will be kept or discarded as the result of enlarged surface.
ReselTargetData	Returns or sets the reselect target face data from builder.
SurfaceRange	Returns the surface range data, which controls the enlarged parameters of surface.
Tag	Returns the Tag for this object.
TargetSelection	Returns the selection of target to create enlarge surface, body face only.

Methods¶

Method	Description
AddPlanarFaceData	Initializes the planar face data with face, and adds the data to builder.
AddSurfaceData	Initializes the surface data with face, and adds the data to builder.
Commit	Commits any edits that have been applied to the builder.
CreatePreviewSurface	Create preview surface data from builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
ErasePlanarFaceData	Erases the planar face data from builder according to face.
EraseSurfaceData	Erases the surface data from builder according to face.
GetColorValue	Returns the value of patch surface color.
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.
SetColorValue	Sets the value of patch surface color.
SetRangeValue	Sets the value of surface range to buider data according to range face.
SetTargetFace	Sets the target face to target surface data.
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¶

EnlargeSurfaceBuilderKeepDiscardOption Enumeration

represents the keep discard options for selected region.

Property Detail¶

AsPatchSurface¶

EnlargeSurfaceBuilder.AsPatchSurface¶

Returns or sets the value of option, which specifies whether to set the result region as patch surface or not.

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

Getter Method

Signature AsPatchSurface

Returns:
Return type:	bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature AsPatchSurface

Parameters:	asPatchSurface (bool) –

New in version NX7.5.0.

License requirements: None.

BodyColor¶

EnlargeSurfaceBuilder.BodyColor¶

Returns or sets the color value of patch surface body.

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

Getter Method

Signature BodyColor

Returns:	the color index
Return type:	Id

New in version NX8.0.1.

License requirements: None.

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

Setter Method

Signature BodyColor

Parameters:	patchColor (Id) – the color index

New in version NX8.0.1.

License requirements: None.

BoundarySelection¶

EnlargeSurfaceBuilder.BoundarySelection¶

Returns the selection of boundary to trim the target surface, it could be face, datum plane, edge and curve.

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

Getter Method

Signature BoundarySelection

Returns:
Return type:	`NXOpen.SelectNXObjectList`

New in version NX7.5.0.

License requirements: None.

ChangeAllSizes¶

EnlargeSurfaceBuilder.ChangeAllSizes¶

Returns or sets the value of option, which specifies when enlarging surface, whether to change all the sizes at the same time or not.

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

Getter Method

Signature ChangeAllSizes

Returns:
Return type:	bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature ChangeAllSizes

Parameters:	changeAllSizes (bool) –

New in version NX7.5.0.

License requirements: None.

CutToBoundary¶

EnlargeSurfaceBuilder.CutToBoundary¶

Returns or sets the value of option, which specifies whether to cut the target to boundary objects or not.

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

Getter Method

Signature CutToBoundary

Returns:
Return type:	bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature CutToBoundary

Parameters:	cutToBoundary (bool) –

New in version NX7.5.0.

License requirements: None.

DragData¶

EnlargeSurfaceBuilder.DragData¶

Returns or sets the drag preview body data from builder according to face.

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

Getter Method

Signature DragData

Returns:
Return type:	bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature DragData

Parameters:	setDragData (bool) –

New in version NX8.5.0.

License requirements: None.

RegionOption¶

EnlargeSurfaceBuilder.RegionOption¶

Returns or sets the value of the option, which specifies to keep or discard the selected region.

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

Getter Method

Signature RegionOption

Returns:
Return type:	`NXOpen.Tooling.EnlargeSurfaceBuilderKeepDiscardOption`

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature RegionOption

Parameters:	regionOption (`NXOpen.Tooling.EnlargeSurfaceBuilderKeepDiscardOption`) –

New in version NX7.5.0.

License requirements: None.

RegionSelection¶

EnlargeSurfaceBuilder.RegionSelection¶

Returns the selection of region, which will be kept or discarded as the result of enlarged surface.

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

Getter Method

Signature RegionSelection

Returns:
Return type:	`NXOpen.RegionPointList`

New in version NX7.5.0.

License requirements: None.

ReselTargetData¶

EnlargeSurfaceBuilder.ReselTargetData¶

Returns or sets the reselect target face data from builder.

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

Getter Method

Signature ReselTargetData

Returns:
Return type:	bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ReselTargetData

Parameters:	setReselTargetData (bool) –

New in version NX8.5.0.

License requirements: None.

SurfaceRange¶

EnlargeSurfaceBuilder.SurfaceRange¶

Returns the surface range data, which controls the enlarged parameters of surface.

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

Getter Method

Signature SurfaceRange

Returns:
Return type:	`NXOpen.GeometricUtilities.SurfaceRangeBuilder`

New in version NX7.5.0.

License requirements: None.

TargetSelection¶

EnlargeSurfaceBuilder.TargetSelection¶

Returns the selection of target to create enlarge surface, body face only.

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

Getter Method

Signature TargetSelection

Returns:
Return type:	`NXOpen.ScCollector`

New in version NX7.5.0.

License requirements: None.

Method Detail¶

AddPlanarFaceData¶

EnlargeSurfaceBuilder.AddPlanarFaceData¶

Initializes the planar face data with face, and adds the data to builder.

Signature AddPlanarFaceData(planarFace)

Parameters:	planarFace (`NXOpen.Face`) – face to add to planar face data

New in version NX7.5.0.

License requirements: None.

AddSurfaceData¶

EnlargeSurfaceBuilder.AddSurfaceData¶

Initializes the surface data with face, and adds the data to builder.

Signature AddSurfaceData(addFace)

Parameters:	addFace (`NXOpen.Face`) – face to add to surface data

New in version NX7.5.0.

License requirements: None.

CreatePreviewSurface¶

EnlargeSurfaceBuilder.CreatePreviewSurface¶

Create preview surface data from builder.

Signature CreatePreviewSurface()

New in version NX8.5.0.

License requirements: None.

ErasePlanarFaceData¶

EnlargeSurfaceBuilder.ErasePlanarFaceData¶

Erases the planar face data from builder according to face.

Signature ErasePlanarFaceData(planarFace)

Parameters:	planarFace (`NXOpen.Face`) – face to get planar face data

New in version NX7.5.0.

License requirements: None.

EraseSurfaceData¶

EnlargeSurfaceBuilder.EraseSurfaceData¶

Erases the surface data from builder according to face.

Signature EraseSurfaceData(eraseFace)

Parameters:	eraseFace (`NXOpen.Face`) – face to get surface data

New in version NX7.5.0.

License requirements: None.

GetColorValue¶

EnlargeSurfaceBuilder.GetColorValue¶

Returns the value of patch surface color.

Signature GetColorValue()

Returns:	a tuple
Return type:	A tuple consisting of (redValue, greenValue, blueValue) redValue is a float. red value between 0 and 1 greenValue is a float. green value between 0 and 1 blueValue is a float. blue value between 0 and 1

New in version NX7.5.0.

License requirements: None.

SetColorValue¶

EnlargeSurfaceBuilder.SetColorValue¶

Sets the value of patch surface color.

Signature SetColorValue(redValue, greenValue, blueValue)

Parameters:	redValue (float) – red value between 0 and 1 greenValue (float) – green value between 0 and 1 blueValue (float) – blue value between 0 and 1

New in version NX7.5.0.

License requirements: None.

SetRangeValue¶

EnlargeSurfaceBuilder.SetRangeValue¶

Sets the value of surface range to buider data according to range face.

Signature SetRangeValue(rangeFace, rangeValue)

Parameters:	rangeFace (`NXOpen.Face`) – range face rangeValue (list of float) – array of u and v range value

New in version NX7.5.0.

License requirements: None.

SetTargetFace¶

EnlargeSurfaceBuilder.SetTargetFace¶

Sets the target face to target surface data.

Signature SetTargetFace(targetFace)

Parameters:	targetFace (`NXOpen.Face`) – target face

New in version NX7.5.0.

License requirements: None.

Validate¶

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

EnlargeSurfaceBuilder Class¶

Properties¶

Methods¶

Enumerations¶

Property Detail¶

AsPatchSurface¶

BodyColor¶

BoundarySelection¶

ChangeAllSizes¶

CutToBoundary¶

DragData¶

RegionOption¶

RegionSelection¶

ReselTargetData¶

SurfaceRange¶

TargetSelection¶

Method Detail¶

AddPlanarFaceData¶

AddSurfaceData¶

CreatePreviewSurface¶

ErasePlanarFaceData¶

EraseSurfaceData¶

GetColorValue¶

SetColorValue¶

SetRangeValue¶

SetTargetFace¶

Validate¶

NXOpen Python API Reference

Navigation

Related Topics