IFormBuilder Class

class NXOpen.Features.IFormBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a NXOpen.Features.IForm builder.

This class allows definition of iso-parameter curves on a face. These curves then can be shaped using NXOpen.GeometricUtilities.CurveShapingBuilder to finally shape the face.

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

Default values.

Property	Value
BSurfaceExtractionOption	Original
CanApplyToAll	0
CanKeepParameterization	0
CurveShaper.HasLinearTransition	false
CurveShaper.InsertionMethod	Uniform
CurveShaper.MovementMethod	Normal
CurveShaper.Number	1
CurveShaper.WCSOption	XY
FaceToDeform.CoaxialEnabled	0
FaceToDeform.CoplanarAxesEnabled	0
FaceToDeform.CoplanarEnabled	0
FaceToDeform.EqualDiameterEnabled	0
FaceToDeform.OffsetEnabled	0
FaceToDeform.ParallelEnabled	0
FaceToDeform.PerpendicularEnabled	0
FaceToDeform.SymmetricEnabled	0
FaceToDeform.TangentEnabled	0
FaceToDeform.ThicknessChainEnabled	0
FaceToDeform.UseFaceBrowse	1
InsertionMethod	Uniform
Number	3
ParameterDirection	IsoU
TransitionType	Global
UMaxContinuity.ContinuityType	G0
UMinContinuity.ContinuityType	G0
VMaxContinuity.ContinuityType	G0
VMinContinuity.ContinuityType	G0

New in version NX7.5.0.

Properties

Property	Description
BSurfaceExtractionOption	Returns or sets the b-surface extraction option
CanApplyToAll	Returns or sets the value indicating if continuity is to be applied to all sides of the surface
CanCreateNewBody	Returns or sets whether the operation is applied to a copy of the face there by creating new body
CanKeepParameterization	Returns or sets the value indicating if input surface parameterization should be preserved during deformation
CurveShaper	Returns the iso-parameter curve shaper
ExtractTolerance	Returns or sets the tolerance used for b-surface extraction from a face
FaceToDeform	Returns the face to deform.
InsertionMethod	Returns or sets the iso-parameter curve insertion method
Number	Returns or sets the number of iso-parameter curves to be inserted
ParameterDirection	Returns or sets the iso-parameter direction
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
SpecifyPoints	Returns the specified points to define iso-parameter curve
SurroundingPatchSurfaceFilename	Returns or sets the surrounding patch surface filename
Tag	Returns the Tag for this object.
TransitionType	Returns or sets the transition options for local surface deformation
UMaxContinuity	Returns the continuity at maximum U direction
UMinContinuity	Returns the continuity at minimum U direction
VMaxContinuity	Returns the continuity at maximum U direction
VMinContinuity	Returns the continuity at minimum V direction

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
CommitFeature	Commits the feature parameters and creates the feature
DeleteCurve	Deletes a iso-parameter curve
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.
RemoveFeatureParameters	Removes parameters of a owning feature of a face to be deformed
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.

Enumerations

IFormBuilderBSurfaceExtractionOptions Enumeration	B-surface extraction options
IFormBuilderGlobalTransitionTypes Enumeration	Global transition options of the surface
IFormBuilderInsertionMethodOptions Enumeration	Iso-parameter curve insertion option
IFormBuilderParameterDirectionOptions Enumeration	Iso-parameter direction options
IFormBuilderTransitionTypes Enumeration	Transition options of the surface

Property Detail

BSurfaceExtractionOption

IFormBuilder.BSurfaceExtractionOption

Returns or sets the b-surface extraction option

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

Getter Method

Signature BSurfaceExtractionOption

Returns: Return type:NXOpen.Features.IFormBuilderBSurfaceExtractionOptions

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature BSurfaceExtractionOption

Parameters:option (NXOpen.Features.IFormBuilderBSurfaceExtractionOptions) –

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

CanApplyToAll

IFormBuilder.CanApplyToAll

Returns or sets the value indicating if continuity is to be applied to all sides of the surface

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

Getter Method

Signature CanApplyToAll

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature CanApplyToAll

Parameters:applyToAll (bool) –

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

CanCreateNewBody

IFormBuilder.CanCreateNewBody

Returns or sets whether the operation is applied to a copy of the face there by creating new body

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

Getter Method

Signature CanCreateNewBody

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature CanCreateNewBody

Parameters:newBody (bool) –

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

CanKeepParameterization

IFormBuilder.CanKeepParameterization

Returns or sets the value indicating if input surface parameterization should be preserved during deformation

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

Getter Method

Signature CanKeepParameterization

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature CanKeepParameterization

Parameters:canKeepParameterization (bool) –

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

CurveShaper

IFormBuilder.CurveShaper

Returns the iso-parameter curve shaper

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

Getter Method

Signature CurveShaper

Returns: Return type:NXOpen.GeometricUtilities.CurveShapingBuilder

New in version NX7.5.0.

License requirements: None.

ExtractTolerance

IFormBuilder.ExtractTolerance

Returns or sets the tolerance used for b-surface extraction from a face

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

Getter Method

Signature ExtractTolerance

Returns: Return type:float

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature ExtractTolerance

Parameters:extractTolerance (float) –

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

FaceToDeform

IFormBuilder.FaceToDeform

Returns the face to deform.

Please refer NXOpen.Features.FaceRecognitionBuilder for details.

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

Getter Method

Signature FaceToDeform

Returns: Return type:NXOpen.Features.FaceRecognitionBuilder

New in version NX7.5.0.

License requirements: None.

InsertionMethod

IFormBuilder.InsertionMethod

Returns or sets the iso-parameter curve insertion method

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

Getter Method

Signature InsertionMethod

Returns: Return type:NXOpen.Features.IFormBuilderInsertionMethodOptions

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature InsertionMethod

Parameters:insertionMethod (NXOpen.Features.IFormBuilderInsertionMethodOptions) –

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

Number

IFormBuilder.Number

Returns or sets the number of iso-parameter curves to be inserted

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

Getter Method

Signature Number

Returns: Return type:int

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature Number

Parameters:number (int) –

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

ParameterDirection

IFormBuilder.ParameterDirection

Returns or sets the iso-parameter direction

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

Getter Method

Signature ParameterDirection

Returns: Return type:NXOpen.Features.IFormBuilderParameterDirectionOptions

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature ParameterDirection

Parameters:parameterDirection (NXOpen.Features.IFormBuilderParameterDirectionOptions) –

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

SpecifyPoints

IFormBuilder.SpecifyPoints

Returns the specified points to define iso-parameter curve

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

Getter Method

Signature SpecifyPoints

Returns: Return type:NXOpen.SelectPointList

New in version NX7.5.0.

License requirements: None.

TransitionType

IFormBuilder.TransitionType

Returns or sets the transition options for local surface deformation

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

Getter Method

Signature TransitionType

Returns: Return type:NXOpen.Features.IFormBuilderTransitionTypes

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature TransitionType

Parameters:transitionType (NXOpen.Features.IFormBuilderTransitionTypes) –

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

UMaxContinuity

IFormBuilder.UMaxContinuity

Returns the continuity at maximum U direction

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

Getter Method

Signature UMaxContinuity

Returns: Return type:NXOpen.GeometricUtilities.Continuity

New in version NX7.5.0.

License requirements: None.

UMinContinuity

IFormBuilder.UMinContinuity

Returns the continuity at minimum U direction

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

Getter Method

Signature UMinContinuity

Returns: Return type:NXOpen.GeometricUtilities.Continuity

New in version NX7.5.0.

License requirements: None.

VMaxContinuity

IFormBuilder.VMaxContinuity

Returns the continuity at maximum U direction

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

Getter Method

Signature VMaxContinuity

Returns: Return type:NXOpen.GeometricUtilities.Continuity

New in version NX7.5.0.

License requirements: None.

VMinContinuity

IFormBuilder.VMinContinuity

Returns the continuity at minimum V direction

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

Getter Method

Signature VMinContinuity

Returns: Return type:NXOpen.GeometricUtilities.Continuity

New in version NX7.5.0.

License requirements: None.

Method Detail

DeleteCurve

IFormBuilder.DeleteCurve

Deletes a iso-parameter curve

Signature DeleteCurve(curve)

Parameters:curve (NXOpen.Curve) – Curve to be deleted

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

RemoveFeatureParameters

IFormBuilder.RemoveFeatureParameters

Removes parameters of a owning feature of a face to be deformed

Signature RemoveFeatureParameters(face)

Parameters:face (NXOpen.Face) – Face to be used for feature parameter removal

New in version NX7.5.0.

License requirements: studio_free_form (“STUDIO FREE FORM”)

Validate

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