NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::StyledSweepBuilder Class Reference

Represents a Features::StyledSweep builder
To create a new instance of this class, use Features::FeatureCollection::CreateStyledSweepBuilder
Default values. More...

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

List of all members.

Public Types

enum  FixedStringOptions { FixedStringOptionsGuide, FixedStringOptionsSection, FixedStringOptionsGuideAndSection }
 This enum represents the Fixed String option. More...
enum  ScalingMethodOptions { ScalingMethodOptionsUniform, ScalingMethodOptionsNonuniform, ScalingMethodOptionsScalingCurve }
 This enum represents the Scaling Method option. More...
enum  SectionOrientationOptions {
  SectionOrientationOptionsTranslate, SectionOrientationOptionsKeepAngle, SectionOrientationOptionsMakeNormal, SectionOrientationOptionsUserDefined,
  SectionOrientationOptionsArcLength
}
 This enum represents the Section Orientation option. More...
enum  TransitionOptions { TransitionOptionsLinear, TransitionOptionsCubic, TransitionOptionsBlend }
 This enum represents the Transition option. More...
enum  Types { TypesOneGuide, TypesOneGuideOneTouch, TypesOneGuideOneOrientation, TypesTwoGuides }
 This enum represents the sweep type option (Number of Guides) More...

Public Member Functions

int AlternateSolution ()
 Returns the alternate solution.
NXOpen::GeometricUtilities::StyledSweepDoubleOnPathDimBuilderCreatePivotSet (double value1, double value2, NXOpen::Curve *path1, NXOpen::Curve *path2)
 Creates a new pivot set.
NXOpen::GeometricUtilities::RotationSetBuilderCreateRotationSet (double value, double pathPar, NXOpen::Curve *path)
 Creates a new rotation set.
NXOpen::GeometricUtilities::ScalingSetBuilderCreateScalingSet (double valuePar, double depthPar, double pathPar, NXOpen::Curve *path)
 Creates a new scaling set.
void EndInsertingSection ()
 Ends inserting section.
NXOpen::SectionFirstGuide ()
 Returns the first guide
Created in NX6.0.0.
NXOpen::Features::StyledSweepBuilder::FixedStringOptions FixedStringOption ()
 Returns the fixed string option
Created in NX6.0.0.
double G0Tolerance ()
 Returns the G0 (Position) tolerance.
double G1Tolerance ()
 Returns the G1 (Tangent) tolerance.
NXOpen::GeometricUtilities::RebuildGuideRebuildData ()
 Returns the guide rebuild data
Created in NX6.0.0.
NXOpen::SectionListInsertedSectionList ()
 Returns the list of inserted sections
Created in NX6.0.0.
NXOpen::GeometricUtilities::StyledSweepDoubleOnPathDimBuilderListPivotSetList ()
 Returns the list of pivot sets
Created in NX6.0.0.
NXOpen::GeometricUtilities::StyledSweepReferenceMethodBuilderReferenceMethod ()
 Returns the reference method
Created in NX6.0.0.
NXOpen::GeometricUtilities::RotationSetBuilderListRotationSetList ()
 Returns the list of rotation sets
Created in NX6.0.0.
NXOpen::SectionScalingCurve ()
 Returns the scaling curve
Created in NX6.0.0.
NXOpen::Features::StyledSweepBuilder::ScalingMethodOptions ScalingMethodOption ()
 Returns the scaling method option
Created in NX6.0.0.
NXOpen::GeometricUtilities::ScalingSetBuilderListScalingSetList ()
 Returns the list of scaling sets
Created in NX6.0.0.
NXOpen::SectionSecondGuide ()
 Returns the second guide
Created in NX6.0.0.
NXOpen::SectionListSectionList ()
 Returns the list of sections.
NXOpen::Features::StyledSweepBuilder::SectionOrientationOptions SectionOrientationOption ()
 Returns the section orientation option
Created in NX6.0.0.
NXOpen::GeometricUtilities::RebuildSectionRebuildData ()
 Returns the section rebuild data
Created in NX6.0.0.
void SetAlternateSolution (int alternateSolution)
 Sets the alternate solution.
void SetFixedStringOption (NXOpen::Features::StyledSweepBuilder::FixedStringOptions fixedStringOption)
 Sets the fixed string option
Created in NX6.0.0.
void SetG0Tolerance (double g0Tolerance)
 Sets the G0 (Position) tolerance.
void SetG1Tolerance (double g1Tolerance)
 Sets the G1 (Tangent) tolerance.
void SetScalingMethodOption (NXOpen::Features::StyledSweepBuilder::ScalingMethodOptions scalingMethodOption)
 Sets the scaling method option
Created in NX6.0.0.
void SetSectionOrientationOption (NXOpen::Features::StyledSweepBuilder::SectionOrientationOptions sectionOrientationOption)
 Sets the section orientation option
Created in NX6.0.0.
void SetTransitionOption (NXOpen::Features::StyledSweepBuilder::TransitionOptions transitionOption)
 Sets the transition option
Created in NX6.0.0.
void SetType (NXOpen::Features::StyledSweepBuilder::Types type)
 Sets the sweep type
Created in NX6.0.0.
void StartInsertingSection (const std::vector< double > &insertPnt)
 Starts inserting section.
NXOpen::GeometricUtilities::SurfaceRangeBuilderSurfaceRange ()
 Returns the surface range
Created in NX6.0.0.
NXOpen::Features::StyledSweepBuilder::TransitionOptions TransitionOption ()
 Returns the transition option
Created in NX6.0.0.
NXOpen::Features::StyledSweepBuilder::Types Type ()
 Returns the sweep type
Created in NX6.0.0.

Detailed Description

Represents a Features::StyledSweep builder
To create a new instance of this class, use Features::FeatureCollection::CreateStyledSweepBuilder
Default values.

Property Value

FixedStringOption

Guide

GuideRebuildData.Degree

3

GuideRebuildData.RebuildType

None

ReferenceMethod.ReferenceOption

ToGuide

ScalingMethodOption

Uniform

SectionOrientationOption

KeepAngle

SectionRebuildData.Degree

3

SectionRebuildData.RebuildType

None

SurfaceRange.AnchorPosition

Vertex1

TransitionOption

Blend


Created in NX6.0.0.


Member Enumeration Documentation

This enum represents the Fixed String option.

Enumerator:
FixedStringOptionsGuide 

Guide.

FixedStringOptionsSection 

Section.

FixedStringOptionsGuideAndSection 

Guide and Section.

This enum represents the Scaling Method option.

Enumerator:
ScalingMethodOptionsUniform 

Uniform.

ScalingMethodOptionsNonuniform 

Non-Uniform.

ScalingMethodOptionsScalingCurve 

Scaling Curve.

This enum represents the Section Orientation option.

Enumerator:
SectionOrientationOptionsTranslate 

Translate.

SectionOrientationOptionsKeepAngle 

Keep Angle.

SectionOrientationOptionsMakeNormal 

Make Normal.

SectionOrientationOptionsUserDefined 

User Defined.

SectionOrientationOptionsArcLength 

Arc Length.

This enum represents the Transition option.

Enumerator:
TransitionOptionsLinear 

Linear.

TransitionOptionsCubic 

Cubic.

TransitionOptionsBlend 

Blend.

This enum represents the sweep type option (Number of Guides)

Enumerator:
TypesOneGuide 

1 Guide

TypesOneGuideOneTouch 

1 Guide 1 Touch

TypesOneGuideOneOrientation 

1 Guide 1 Orientation

TypesTwoGuides 

2 Guides


Member Function Documentation

Returns the alternate solution.

This property can be used only when Type is being set to 1 Guide/1 Guide 1 Touch/1 Guide 1 Orientation and orientation method is set to user_defined. For now, alternateSolution = 1, means automatically initial orientation, = 0, means no
Created in NX6.0.0.

License requirements : None

Creates a new pivot set.

Returns:
StyledSweepDoubleOnPathDimBuilder Object
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")
Parameters:
value1Point on section
value2Point on guide
path1The path of point on section
path2The path of point on guide

Creates a new rotation set.

Returns:
RotationSetBuilder Object
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")
Parameters:
valueRotation angle
pathParRotation position
pathThe path of on path dim
NXOpen::GeometricUtilities::ScalingSetBuilder* NXOpen::Features::StyledSweepBuilder::CreateScalingSet ( double  valuePar,
double  depthPar,
double  pathPar,
NXOpen::Curve path 
)

Creates a new scaling set.

Returns:
ScalingSetBuilder Object
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")
Parameters:
valueParScaling value
depthParDepth value
pathParDepth position
pathThe path of on path dim

Ends inserting section.

The client should call this API whenever he finishes inserting a section.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")

Returns the first guide
Created in NX6.0.0.



License requirements : None

Returns the fixed string option
Created in NX6.0.0.



License requirements : None

Returns the G0 (Position) tolerance.


Created in NX6.0.0.

License requirements : None

Returns the G1 (Tangent) tolerance.


Created in NX6.0.0.

License requirements : None

Returns the guide rebuild data
Created in NX6.0.0.



License requirements : None

Returns the list of inserted sections
Created in NX6.0.0.



License requirements : None

Returns the list of pivot sets
Created in NX6.0.0.



License requirements : None

Returns the reference method
Created in NX6.0.0.



License requirements : None

Returns the list of rotation sets
Created in NX6.0.0.



License requirements : None

Returns the scaling curve
Created in NX6.0.0.



License requirements : None

Returns the scaling method option
Created in NX6.0.0.



License requirements : None

Returns the list of scaling sets
Created in NX6.0.0.



License requirements : None

Returns the second guide
Created in NX6.0.0.



License requirements : None

Returns the list of sections.

At least 1 section is required.
Created in NX6.0.0.

License requirements : None

Returns the section orientation option
Created in NX6.0.0.



License requirements : None

Returns the section rebuild data
Created in NX6.0.0.



License requirements : None

Sets the alternate solution.

This property can be used only when Type is being set to 1 Guide/1 Guide 1 Touch/1 Guide 1 Orientation and orientation method is set to user_defined. For now, alternateSolution = 1, means automatically initial orientation, = 0, means no
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")

Parameters:
alternateSolutionalternatesolution

Sets the fixed string option
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")

Parameters:
fixedStringOptionfixedstringoption

Sets the G0 (Position) tolerance.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")

Parameters:
g0Toleranceg0tolerance

Sets the G1 (Tangent) tolerance.


Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")

Parameters:
g1Toleranceg1tolerance

Sets the scaling method option
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")

Parameters:
scalingMethodOptionscalingmethodoption

Sets the section orientation option
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")

Parameters:
sectionOrientationOptionsectionorientationoption

Sets the transition option
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")

Parameters:
transitionOptiontransitionoption

Sets the sweep type
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")

Parameters:
typetype
void NXOpen::Features::StyledSweepBuilder::StartInsertingSection ( const std::vector< double > &  insertPnt)

Starts inserting section.

The client should call this API whenever he starts inserting a section. According to the insert point, the application automatically computes the closed point on the current surface, then extracts an iso curve to create a UG curve and add this curve into the section. Note: After the client calls this API, he needs to create a pivot set, a rotation set, a scaling set and a Section in turn, then he needs to insert them to the corresponding set list separately.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR studio_free_form ("STUDIO FREE FORM")

Parameters:
insertPntInsert point - the point on guide curve is better

Returns the surface range
Created in NX6.0.0.



License requirements : None

Returns the transition option
Created in NX6.0.0.



License requirements : None

Returns the sweep type
Created in NX6.0.0.



License requirements : None


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