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

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

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

List of all members.

Public Types

enum  InterpolationOptions { InterpolationOptionsLinear, InterpolationOptionsCubic, InterpolationOptionsBlend }
 This enum represents the Interpolation option. More...
enum  SectionLocationTypes { SectionLocationTypesAnywhereAlongGuides, SectionLocationTypesEndsOfGuides }
 This enum represents the Section Location option. More...

Public Member Functions

NXOpen::GeometricUtilities::AlignmentMethodBuilderAlignmentMethod ()
 Returns the alignment method.
NXOpen::GeometricUtilities::FeatureOptionsBodyPreference ()
 Returns the body type options
Created in NX7.5.0.
double G0Tolerance ()
 Returns the G0 (Position) tolerance.
double G1Tolerance ()
 Returns the G1 (Tangent) tolerance.
NXOpen::SectionListGuideList ()
 Returns the list of guides.
NXOpen::GeometricUtilities::RebuildGuideRebuildData ()
 Returns the guide rebuild data
Created in NX5.0.0.
NXOpen::Features::SweptBuilder::InterpolationOptions InterpolationOption ()
 Returns the interpolation option.
NXOpen::GeometricUtilities::OrientationMethodBuilderOrientationMethod ()
 Returns the orientation method.
bool PreserveShapeOption ()
 Returns the preserve shape option.
NXOpen::GeometricUtilities::ScalingMethodBuilderScalingMethod ()
 Returns the scaling method.
NXOpen::SectionListSectionList ()
 Returns the list of sections.
NXOpen::Features::SweptBuilder::SectionLocationTypes SectionLocation ()
 Returns the section location option.
NXOpen::GeometricUtilities::RebuildSectionRebuildData ()
 Returns the section rebuild data
Created in NX5.0.0.
void SetG0Tolerance (double g0Tolerance)
 Sets the G0 (Position) tolerance.
void SetG1Tolerance (double g1Tolerance)
 Sets the G1 (Tangent) tolerance.
void SetInterpolationOption (NXOpen::Features::SweptBuilder::InterpolationOptions interpolationOption)
 Sets the interpolation option.
void SetPreserveShapeOption (bool preserveShapeOption)
 Sets the preserve shape option.
void SetSectionLocation (NXOpen::Features::SweptBuilder::SectionLocationTypes sectionLocation)
 Sets the section location option.
NXOpen::SectionSpine ()
 Returns the spine (optional).

Detailed Description

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

Property Value

AlignmentMethod.AlignType

Parameter

GuideRebuildData.Degree

3

GuideRebuildData.RebuildType

None

OrientationMethod.AngularLaw.EndValue.Value

0 (millimeters part), 0 (inches part)

OrientationMethod.AngularLaw.Function

ft

OrientationMethod.AngularLaw.LawType

Constant

OrientationMethod.AngularLaw.Parameter

t

OrientationMethod.AngularLaw.StartValue.Value

0 (millimeters part), 0 (inches part)

OrientationMethod.AngularLaw.Value.Value

0 (millimeters part), 0 (inches part)

OrientationMethod.OrientationOption

Fixed

PreserveShapeOption

True

ScalingMethod.AreaLaw.EndValue.Value

1.0 (millimeters part), 1.0 (inches part)

ScalingMethod.AreaLaw.StartValue.Value

1.0 (millimeters part), 1.0 (inches part)

ScalingMethod.AreaLaw.Value.Value

1.0 (millimeters part), 1.0 (inches part)

ScalingMethod.BlendingFunctionType

Linear

ScalingMethod.EndBlendScaleFactor

1.0

ScalingMethod.PerimeterLaw.EndValue.Value

1.0 (millimeters part), 1.0 (inches part)

ScalingMethod.PerimeterLaw.StartValue.Value

1.0 (millimeters part), 1.0 (inches part)

ScalingMethod.PerimeterLaw.Value.Value

1.0 (millimeters part), 1.0 (inches part)

ScalingMethod.ScaleFactor

1.0

ScalingMethod.ScalingOption

Constant

ScalingMethod.StartBlendScaleFactor

1.0

SectionRebuildData.Degree

3

SectionRebuildData.RebuildType

None


Created in NX5.0.0.


Member Enumeration Documentation

This enum represents the Interpolation option.

For 2 or more sections, this option specifies the method by which to interpolate between them, either Linear or Cubic.

Enumerator:
InterpolationOptionsLinear 

Linear.

InterpolationOptionsCubic 

Cubic.

InterpolationOptionsBlend 

Blend.

This enum represents the Section Location option.

If a single section located at the middle of a guide string is specified, Anywhere Along Guides option sweeps in both directions.

Enumerator:
SectionLocationTypesAnywhereAlongGuides 

Anywhere along Guides.

SectionLocationTypesEndsOfGuides 

Ends of Guides.


Member Function Documentation

Returns the alignment method.

The Alignment Method Builder sub-object, governs the alignment of the input sections along the guides. Alignment by Points is available only if more than 1 input sections are selected. Refer to GeometricUtilities.AlignmentMethodBuilder documentation.
Created in NX5.0.0.

License requirements : None

Returns the body type options
Created in NX7.5.0.



License requirements : None

Returns the G0 (Position) tolerance.


Created in NX5.0.0.

License requirements : None

Returns the G1 (Tangent) tolerance.


Created in NX5.0.0.

License requirements : None

Returns the list of guides.

At least 1 but no more than 3 guides are required.
Created in NX5.0.0.

License requirements : None

Returns the guide rebuild data
Created in NX5.0.0.



License requirements : None

Returns the interpolation option.

This option governs the method by which to interpolate between sections, if the section list contains more than 1 section.
Created in NX5.0.0.

License requirements : None

Returns the orientation method.

The Orientation Method Builder sub-object, governs the orientation of the input sections, if the guide list contains a single guide. Refer to GeometricUtilities.OrientationMethodBuilder documentation.
Created in NX5.0.0.

License requirements : None

Returns the preserve shape option.


Created in NX5.0.0.

License requirements : None

Returns the scaling method.

The Scaling Method Builder sub-object, governs the size / scale of the input sections along a guide, if a single guide is selected. Refer to GeometricUtilities.ScalingMethodBuilder documentation.
Created in NX5.0.0.

License requirements : None

Returns the list of sections.

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

License requirements : None

Returns the section location option.

This option governs the location of the input section with respect to the guides. The section location option is ignored if the section list contains more than 1 section.
Created in NX5.0.0.

License requirements : None

Returns the section rebuild data
Created in NX5.0.0.



License requirements : None

void NXOpen::Features::SweptBuilder::SetG0Tolerance ( double  g0Tolerance)

Sets the G0 (Position) tolerance.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
g0Toleranceg0tolerance
void NXOpen::Features::SweptBuilder::SetG1Tolerance ( double  g1Tolerance)

Sets the G1 (Tangent) tolerance.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
g1Toleranceg1tolerance

Sets the interpolation option.

This option governs the method by which to interpolate between sections, if the section list contains more than 1 section.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
interpolationOptioninterpolationoption
void NXOpen::Features::SweptBuilder::SetPreserveShapeOption ( bool  preserveShapeOption)

Sets the preserve shape option.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
preserveShapeOptionpreserveshapeoption

Sets the section location option.

This option governs the location of the input section with respect to the guides. The section location option is ignored if the section list contains more than 1 section.
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
sectionLocationsectionlocation

Returns the spine (optional).

For more than 1 guide, an optional spine curve can be input to gain further control of the orientation of the section string. The spine curve cannot contain more than 1 loop.
Created in NX5.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.