VarOffsetFaceBuilder Class

class NXOpen.Features.VarOffsetFaceBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a Features.VarOffsetFace builder

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

Default values.

Property Value
BodyOutput OffsetasNewBody
BridgeContinuity Connected

New in version NX11.0.0.

Properties

Property Description
BodyOutput Returns or sets the body output
BoundaryObject Returns the boundary object
BridgeContinuity Returns or sets the bridge continuity
OffsetDirection Returns or sets the offset direction
OffsetSolid Returns or sets the offset solid
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
ProjectionDirection Returns the projection direction
RegionList Returns the region list
SurroundingPatchSurfaceFilename Returns or sets the surrounding patch surface filename
Tag Returns the Tag for this object.
TargetFace Returns the target face
Type Returns or sets the type

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
CommitFeature Commits the feature parameters and creates the feature
CreateRegionListItem The region selection type dim object’s create function
Destroy Deletes the builder, and cleans up any objects created by the builder.
ErasePointBoundaryMap Erase the key value from region point - boundary map
ErasePointLaminarMap Erase the key value from region point - laminar edges map
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.
InsertPointBoundaryMap Insert to region point - boundary map
InsertPointLaminarMap Insert to region point - laminar edges map
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

BodyOutput

VarOffsetFaceBuilder.BodyOutput

Returns or sets the body output

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

Getter Method

Signature BodyOutput

Returns:
Return type:NXOpen.Features.VarOffsetFaceBuilderOutput

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature BodyOutput

Parameters:bodyOutput (NXOpen.Features.VarOffsetFaceBuilderOutput) –

New in version NX11.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

BoundaryObject

VarOffsetFaceBuilder.BoundaryObject

Returns the boundary object

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

Getter Method

Signature BoundaryObject

Returns:
Return type:NXOpen.SelectTaggedObjectList

New in version NX11.0.0.

License requirements: None.

BridgeContinuity

VarOffsetFaceBuilder.BridgeContinuity

Returns or sets the bridge continuity

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

Getter Method

Signature BridgeContinuity

Returns:
Return type:NXOpen.Features.VarOffsetFaceBuilderContinuity

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature BridgeContinuity

Parameters:bridgeContinuity (NXOpen.Features.VarOffsetFaceBuilderContinuity) –

New in version NX11.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

OffsetDirection

VarOffsetFaceBuilder.OffsetDirection

Returns or sets the offset direction

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

Getter Method

Signature OffsetDirection

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature OffsetDirection

Parameters:offsetDirection (bool) –

New in version NX11.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

OffsetSolid

VarOffsetFaceBuilder.OffsetSolid

Returns or sets the offset solid

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

Getter Method

Signature OffsetSolid

Returns:
Return type:bool

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature OffsetSolid

Parameters:offsetSolid (bool) –

New in version NX12.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

ProjectionDirection

VarOffsetFaceBuilder.ProjectionDirection

Returns the projection direction

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

Getter Method

Signature ProjectionDirection

Returns:Projection Options data
Return type:NXOpen.GeometricUtilities.ProjectionOptions

New in version NX11.0.0.

License requirements: None.

RegionList

VarOffsetFaceBuilder.RegionList

Returns the region list

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

Getter Method

Signature RegionList

Returns:
Return type:NXOpen.Features.RegionListItemBuilderList

New in version NX11.0.0.

License requirements: None.

TargetFace

VarOffsetFaceBuilder.TargetFace

Returns the target face

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

Getter Method

Signature TargetFace

Returns:
Return type:NXOpen.ScCollector

New in version NX11.0.0.

License requirements: None.

Type

VarOffsetFaceBuilder.Type

Returns or sets the type

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

Getter Method

Signature Type

Returns:
Return type:NXOpen.Features.VarOffsetFaceBuilderTypes

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature Type

Parameters:type (NXOpen.Features.VarOffsetFaceBuilderTypes) –

New in version NX11.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

Method Detail

CreateRegionListItem

VarOffsetFaceBuilder.CreateRegionListItem

The region selection type dim object’s create function

Signature CreateRegionListItem()

Returns:
Return type:NXOpen.Features.RegionListItemBuilder

New in version NX11.0.0.

License requirements: None.

ErasePointBoundaryMap

VarOffsetFaceBuilder.ErasePointBoundaryMap

Erase the key value from region point - boundary map

Signature ErasePointBoundaryMap(regionPoint)

Parameters:regionPoint (NXOpen.NXObject) –

New in version NX11.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

ErasePointLaminarMap

VarOffsetFaceBuilder.ErasePointLaminarMap

Erase the key value from region point - laminar edges map

Signature ErasePointLaminarMap(regionPoint)

Parameters:regionPoint (NXOpen.NXObject) –

New in version NX11.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

InsertPointBoundaryMap

VarOffsetFaceBuilder.InsertPointBoundaryMap

Insert to region point - boundary map

Signature InsertPointBoundaryMap(regionPoint, regionBoundaries)

Parameters:

New in version NX11.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

InsertPointLaminarMap

VarOffsetFaceBuilder.InsertPointLaminarMap

Insert to region point - laminar edges map

Signature InsertPointLaminarMap(regionPoint, regionLaminarEdges)

Parameters:

New in version NX11.0.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

Validate

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