NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Features::IFormBuilder Class Reference

Represents a NXOpen::Features::IForm builder. More...

Inheritance diagram for NXOpen::Features::IFormBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  BSurfaceExtractionOptions { BSurfaceExtractionOptionsOriginal, BSurfaceExtractionOptionsMinimumBounded, BSurfaceExtractionOptionsFittedToBoundary }
 B-surface extraction options. More...
 
enum  GlobalTransitionTypes { GlobalTransitionTypesBlend, GlobalTransitionTypesBell }
 Global transition options of the surface. More...
 
enum  InsertionMethodOptions { InsertionMethodOptionsUniform, InsertionMethodOptionsThroughPoints, InsertionMethodOptionsBetweenPoints }
 Iso-parameter curve insertion option. More...
 
enum  ParameterDirectionOptions { ParameterDirectionOptionsIsoU, ParameterDirectionOptionsIsoV }
 Iso-parameter direction options. More...
 
enum  TransitionTypes { TransitionTypesLocal, TransitionTypesGlobal }
 Transition options of the surface. More...
 

Public Member Functions

NXOpen::Features::IFormBuilder::BSurfaceExtractionOptions BSurfaceExtractionOption ()
 Returns the b-surface extraction option
Created in NX7.5.0. More...
 
bool CanApplyToAll ()
 Returns the value indicating if continuity is to be applied to all sides of the surface
Created in NX7.5.0. More...
 
bool CanCreateNewBody ()
 Returns whether the operation is applied to a copy of the face there by creating new body
Created in NX7.5.0. More...
 
bool CanKeepParameterization ()
 Returns the value indicating if input surface parameterization should be preserved during deformation
Created in NX7.5.0. More...
 
NXOpen::GeometricUtilities::CurveShapingBuilderCurveShaper ()
 Returns the iso-parameter curve shaper
Created in NX7.5.0. More...
 
void DeleteCurve (NXOpen::Curve *curve)
 Deletes a iso-parameter curve
Created in NX7.5.0. More...
 
double ExtractTolerance ()
 Returns the tolerance used for b-surface extraction from a face
Created in NX7.5.0. More...
 
NXOpen::Features::FaceRecognitionBuilderFaceToDeform ()
 Returns the face to deform. More...
 
NXOpen::Features::IFormBuilder::InsertionMethodOptions InsertionMethod ()
 Returns the iso-parameter curve insertion method
Created in NX7.5.0. More...
 
int Number ()
 Returns the number of iso-parameter curves to be inserted
Created in NX7.5.0. More...
 
NXOpen::Features::IFormBuilder::ParameterDirectionOptions ParameterDirection ()
 Returns the iso-parameter direction
Created in NX7.5.0. More...
 
void RemoveFeatureParameters (NXOpen::Face *face)
 Removes parameters of a owning feature of a face to be deformed
Created in NX7.5.0. More...
 
void SetBSurfaceExtractionOption (NXOpen::Features::IFormBuilder::BSurfaceExtractionOptions option)
 Sets the b-surface extraction option
Created in NX7.5.0. More...
 
void SetCanApplyToAll (bool applyToAll)
 Sets the value indicating if continuity is to be applied to all sides of the surface
Created in NX7.5.0. More...
 
void SetCanCreateNewBody (bool newBody)
 Sets whether the operation is applied to a copy of the face there by creating new body
Created in NX7.5.0. More...
 
void SetCanKeepParameterization (bool canKeepParameterization)
 Sets the value indicating if input surface parameterization should be preserved during deformation
Created in NX7.5.0. More...
 
void SetExtractTolerance (double extractTolerance)
 Sets the tolerance used for b-surface extraction from a face
Created in NX7.5.0. More...
 
void SetInsertionMethod (NXOpen::Features::IFormBuilder::InsertionMethodOptions insertionMethod)
 Sets the iso-parameter curve insertion method
Created in NX7.5.0. More...
 
void SetNumber (int number)
 Sets the number of iso-parameter curves to be inserted
Created in NX7.5.0. More...
 
void SetParameterDirection (NXOpen::Features::IFormBuilder::ParameterDirectionOptions parameterDirection)
 Sets the iso-parameter direction
Created in NX7.5.0. More...
 
void SetTransitionType (NXOpen::Features::IFormBuilder::TransitionTypes transitionType)
 Sets the transition options for local surface deformation
Created in NX7.5.0. More...
 
NXOpen::SelectPointListSpecifyPoints ()
 Returns the specified points to define iso-parameter curve
Created in NX7.5.0. More...
 
NXOpen::Features::IFormBuilder::TransitionTypes TransitionType ()
 Returns the transition options for local surface deformation
Created in NX7.5.0. More...
 
NXOpen::GeometricUtilities::ContinuityUMaxContinuity ()
 Returns the continuity at maximum U direction
Created in NX7.5.0. More...
 
NXOpen::GeometricUtilities::ContinuityUMinContinuity ()
 Returns the continuity at minimum U direction
Created in NX7.5.0. More...
 
NXOpen::GeometricUtilities::ContinuityVMaxContinuity ()
 Returns the continuity at maximum U direction
Created in NX7.5.0. More...
 
NXOpen::GeometricUtilities::ContinuityVMinContinuity ()
 Returns the continuity at minimum V direction
Created in NX7.5.0. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

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


Created in NX7.5.0.

Member Enumeration Documentation

B-surface extraction options.

Enumerator
BSurfaceExtractionOptionsOriginal 

Extract original surface.

BSurfaceExtractionOptionsMinimumBounded 

Extract minimum bounded surface.

BSurfaceExtractionOptionsFittedToBoundary 

Extract surface fitted to boundary of face.

Global transition options of the surface.

Enumerator
GlobalTransitionTypesBlend 

Blend type global transition.

GlobalTransitionTypesBell 

Bell type global transition.

Iso-parameter curve insertion option.

Enumerator
InsertionMethodOptionsUniform 

Insert curves uniformly.

InsertionMethodOptionsThroughPoints 

Insert curves through points.

InsertionMethodOptionsBetweenPoints 

Insert curves between points.

Iso-parameter direction options.

Enumerator
ParameterDirectionOptionsIsoU 

Iso-U direction.

ParameterDirectionOptionsIsoV 

Iso-V direction.

Transition options of the surface.

Enumerator
TransitionTypesLocal 

Local transition.

TransitionTypesGlobal 

Global transition.

Member Function Documentation

NXOpen::Features::IFormBuilder::BSurfaceExtractionOptions NXOpen::Features::IFormBuilder::BSurfaceExtractionOption ( )

Returns the b-surface extraction option
Created in NX7.5.0.



License requirements : None

bool NXOpen::Features::IFormBuilder::CanApplyToAll ( )

Returns the value indicating if continuity is to be applied to all sides of the surface
Created in NX7.5.0.



License requirements : None

bool NXOpen::Features::IFormBuilder::CanCreateNewBody ( )

Returns whether the operation is applied to a copy of the face there by creating new body
Created in NX7.5.0.



License requirements : None

bool NXOpen::Features::IFormBuilder::CanKeepParameterization ( )

Returns the value indicating if input surface parameterization should be preserved during deformation
Created in NX7.5.0.



License requirements : None

NXOpen::GeometricUtilities::CurveShapingBuilder* NXOpen::Features::IFormBuilder::CurveShaper ( )

Returns the iso-parameter curve shaper
Created in NX7.5.0.



License requirements : None

void NXOpen::Features::IFormBuilder::DeleteCurve ( NXOpen::Curve curve)

Deletes a iso-parameter curve
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
curveCurve to be deleted
double NXOpen::Features::IFormBuilder::ExtractTolerance ( )

Returns the tolerance used for b-surface extraction from a face
Created in NX7.5.0.



License requirements : None

NXOpen::Features::FaceRecognitionBuilder* NXOpen::Features::IFormBuilder::FaceToDeform ( )

Returns the face to deform.

Please refer NXOpen::Features::FaceRecognitionBuilder for details.
Created in NX7.5.0.

License requirements : None

NXOpen::Features::IFormBuilder::InsertionMethodOptions NXOpen::Features::IFormBuilder::InsertionMethod ( )

Returns the iso-parameter curve insertion method
Created in NX7.5.0.



License requirements : None

int NXOpen::Features::IFormBuilder::Number ( )

Returns the number of iso-parameter curves to be inserted
Created in NX7.5.0.



License requirements : None

NXOpen::Features::IFormBuilder::ParameterDirectionOptions NXOpen::Features::IFormBuilder::ParameterDirection ( )

Returns the iso-parameter direction
Created in NX7.5.0.



License requirements : None

void NXOpen::Features::IFormBuilder::RemoveFeatureParameters ( NXOpen::Face face)

Removes parameters of a owning feature of a face to be deformed
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
faceFace to be used for feature parameter removal
void NXOpen::Features::IFormBuilder::SetBSurfaceExtractionOption ( NXOpen::Features::IFormBuilder::BSurfaceExtractionOptions  option)

Sets the b-surface extraction option
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
optionoption
void NXOpen::Features::IFormBuilder::SetCanApplyToAll ( bool  applyToAll)

Sets the value indicating if continuity is to be applied to all sides of the surface
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
applyToAllapplytoall
void NXOpen::Features::IFormBuilder::SetCanCreateNewBody ( bool  newBody)

Sets whether the operation is applied to a copy of the face there by creating new body
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
newBodynewbody
void NXOpen::Features::IFormBuilder::SetCanKeepParameterization ( bool  canKeepParameterization)

Sets the value indicating if input surface parameterization should be preserved during deformation
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
canKeepParameterizationcankeepparameterization
void NXOpen::Features::IFormBuilder::SetExtractTolerance ( double  extractTolerance)

Sets the tolerance used for b-surface extraction from a face
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
extractToleranceextracttolerance
void NXOpen::Features::IFormBuilder::SetInsertionMethod ( NXOpen::Features::IFormBuilder::InsertionMethodOptions  insertionMethod)

Sets the iso-parameter curve insertion method
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
insertionMethodinsertionmethod
void NXOpen::Features::IFormBuilder::SetNumber ( int  number)

Sets the number of iso-parameter curves to be inserted
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
numbernumber
void NXOpen::Features::IFormBuilder::SetParameterDirection ( NXOpen::Features::IFormBuilder::ParameterDirectionOptions  parameterDirection)

Sets the iso-parameter direction
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
parameterDirectionparameterdirection
void NXOpen::Features::IFormBuilder::SetTransitionType ( NXOpen::Features::IFormBuilder::TransitionTypes  transitionType)

Sets the transition options for local surface deformation
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
transitionTypetransitiontype
NXOpen::SelectPointList* NXOpen::Features::IFormBuilder::SpecifyPoints ( )

Returns the specified points to define iso-parameter curve
Created in NX7.5.0.



License requirements : None

NXOpen::Features::IFormBuilder::TransitionTypes NXOpen::Features::IFormBuilder::TransitionType ( )

Returns the transition options for local surface deformation
Created in NX7.5.0.



License requirements : None

NXOpen::GeometricUtilities::Continuity* NXOpen::Features::IFormBuilder::UMaxContinuity ( )

Returns the continuity at maximum U direction
Created in NX7.5.0.



License requirements : None

NXOpen::GeometricUtilities::Continuity* NXOpen::Features::IFormBuilder::UMinContinuity ( )

Returns the continuity at minimum U direction
Created in NX7.5.0.



License requirements : None

NXOpen::GeometricUtilities::Continuity* NXOpen::Features::IFormBuilder::VMaxContinuity ( )

Returns the continuity at maximum U direction
Created in NX7.5.0.



License requirements : None

NXOpen::GeometricUtilities::Continuity* NXOpen::Features::IFormBuilder::VMinContinuity ( )

Returns the continuity at minimum V direction
Created in NX7.5.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.