NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Die::SpringbackCompensationBuilder Class Reference

Used to create or edit a Die::SpringbackCompensation feature. More...

Inheritance diagram for NXOpen::Die::SpringbackCompensationBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  DefinedByType { DefinedByTypeOneStepFeature, DefinedByTypeFacetedBodies, DefinedByTypePoints }
 The type of input data that defines the compensation. More...
enum  DegreeType { DegreeTypeTwo, DegreeTypeThree, DegreeTypeFive, DegreeTypeSeven }
 The polynomial degree type. More...
enum  ResultSheetType { ResultSheetTypeCompensated, ResultSheetTypeSprung }
 The type of sheet body you would like created as output. More...

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance.
bool CalculateMaxDeviation ()
 Returns the indication if the feature should calculate the maximum deviation of the result.
NXOpen::DirectionConvexityDirection ()
 Returns the convexity direction.
bool ConvexityEnabled ()
 Returns the toggle that determines whether to constrain convexity
Created in NX7.5.0.
bool CreateFacets ()
 Returns the value determines if a faceted output body is also created.
NXOpen::Die::SpringbackCompensationBuilder::DefinedByType DefinedBy ()
 Returns the type of data that will be used to define the feature.
double DeformationFactor ()
 Returns the deformation factor determines how much of the calculated deformation is applied to the result body.
NXOpen::Die::SpringbackCompensationBuilder::DegreeType Degree ()
 Returns the polynomial degree (one unit less than the order).
double DistanceTolerance ()
 Returns the distance tolerance.
int Divisions ()
 Returns the number of equi-distant points to divide the cube of the sheet body (N x N x N).
NXOpen::DirectionDrawVector ()
 Returns the vector indicating the draw direction.
void GetProductPoints (std::vector< NXOpen::Point3d > &productPoints)
 Get the sample points on the product surface.
void GetSprungPoints (std::vector< NXOpen::Point3d > &sprungPoints)
 Get the sample points on the sprung surface.
NXOpen::SectionInnerCurve ()
 Returns the inner boundary curve of the transition area.
bool IsGlobalDeformation ()
 Returns the indication if the feature is a generic Global Deformation.
NXOpen::Features::SelectFeatureOneStep ()
 Returns the one-step feature.
NXOpen::SectionOuterCurve ()
 Returns the outer boundary curve of transition area.
NXOpen::Facet::SelectFacetedBodyProductFacets ()
 Returns the product facets.
NXString ProductPointsFile ()
 Returns the product points file name.
NXOpen::SelectBodyProductSheet ()
 Returns the sheet body representing the product shape.
NXOpen::Die::SpringbackCompensationBuilder::ResultSheetType ResultType ()
 Returns the type of output to generate.
void SetAngleTolerance (double angleTolerance)
 Sets the angle tolerance.
void SetCalculateMaxDeviation (bool calculateMaxDeviation)
 Sets the indication if the feature should calculate the maximum deviation of the result.
void SetConvexityDirection (NXOpen::Direction *convexityDirection)
 Sets the convexity direction.
void SetConvexityEnabled (bool isConvexityEnabled)
 Sets the toggle that determines whether to constrain convexity
Created in NX7.5.0.
void SetCreateFacets (bool createFacets)
 Sets the value determines if a faceted output body is also created.
void SetDefinedBy (NXOpen::Die::SpringbackCompensationBuilder::DefinedByType definedBy)
 Sets the type of data that will be used to define the feature.
void SetDeformationFactor (double deformationFactor)
 Sets the deformation factor determines how much of the calculated deformation is applied to the result body.
void SetDegree (NXOpen::Die::SpringbackCompensationBuilder::DegreeType degree)
 Sets the polynomial degree (one unit less than the order).
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance.
void SetDivisions (int divisions)
 Sets the number of equi-distant points to divide the cube of the sheet body (N x N x N).
void SetDrawVector (NXOpen::Direction *drawVector)
 Sets the vector indicating the draw direction.
void SetGlobalDeformation (bool isGlobalDeformation)
 Sets the indication if the feature is a generic Global Deformation.
void SetProductPoints (const std::vector< NXOpen::Point3d > &productPoints)
 Set the sample points on the product surface.
void SetProductPointsFile (const NXString &filename)
 Sets the product points file name.
void SetResultType (NXOpen::Die::SpringbackCompensationBuilder::ResultSheetType resultType)
 Sets the type of output to generate.
void SetShapeValue (double shapeValue)
 Sets the parameter that determines the shape of the transition area.
void SetSmoothingFactor (double smoothingFactor)
 Sets the smoothing factor regulates a trade-off between interpolation error and smoothing when creating the result body.
void SetSprungPoints (const std::vector< NXOpen::Point3d > &sprungPoints)
 Set the sample points on the sprung surface.
void SetSprungPointsFile (const NXString &filename)
 Sets the sprung points file name.
void SetStepSize (double stepSize)
 Sets the step size.
double ShapeValue ()
 Returns the parameter that determines the shape of the transition area.
double SmoothingFactor ()
 Returns the smoothing factor regulates a trade-off between interpolation error and smoothing when creating the result body.
NXOpen::Facet::SelectFacetedBodySprungFacets ()
 Returns the sprung facets.
NXString SprungPointsFile ()
 Returns the sprung points file name.
double StepSize ()
 Returns the step size.

Detailed Description

Used to create or edit a Die::SpringbackCompensation feature.


To create a new instance of this class, use Die::DieCollection::CreateSpringbackCompensationBuilder
Default values.

Property Value

ConvexityEnabled

false

CreateFacets

false

DefinedBy

OneStepFeature

DeformationFactor

1

Degree

Two

Divisions

3

ResultType

Compensated

ShapeValue

0.5

SmoothingFactor

1e-009

StepSize

1.0


Created in NX7.5.0.


Member Enumeration Documentation

The type of input data that defines the compensation.

Enumerator:
DefinedByTypeOneStepFeature 

A One-Step feature.

DefinedByTypeFacetedBodies 

Facted bodies.

DefinedByTypePoints 

Points .

The polynomial degree type.

Acceptable degrees are 2, 3, 5, and 7.

Enumerator:
DegreeTypeTwo 

Degree is 2.

DegreeTypeThree 

Degree is 3.

DegreeTypeFive 

Degree is 5.

DegreeTypeSeven 

Degree is 7.

The type of sheet body you would like created as output.

Enumerator:
ResultSheetTypeCompensated 

Compensated sheet body.

ResultSheetTypeSprung 

Sprung sheet body.


Member Function Documentation

Returns the angle tolerance.


Created in NX7.5.0.

License requirements : None

Returns the indication if the feature should calculate the maximum deviation of the result.

True indicates the deviation should be calculated, false indicates the deviation will not be calculated.
Created in NX7.5.0.

License requirements : None

Returns the convexity direction.


Created in NX7.5.0.

License requirements : None

Returns the toggle that determines whether to constrain convexity
Created in NX7.5.0.



License requirements : None

Returns the value determines if a faceted output body is also created.

True indicates to output a faceted body, false indicates that a faceted body is not output. Only when type is Die::SpringbackCompensationBuilder::DefinedByTypeFacetedBodies


Created in NX7.5.0.

License requirements : None

Returns the deformation factor determines how much of the calculated deformation is applied to the result body.


Created in NX7.5.0.

License requirements : None

Returns the polynomial degree (one unit less than the order).


Created in NX7.5.0.

License requirements : None

Returns the distance tolerance.


Created in NX7.5.0.

License requirements : None

Returns the number of equi-distant points to divide the cube of the sheet body (N x N x N).


Created in NX7.5.0.

License requirements : None

Returns the vector indicating the draw direction.


Created in NX7.5.0.

License requirements : None

Get the sample points on the product surface.

Only when type is Die::SpringbackCompensationBuilder::DefinedByTypePoints . Optional.
Created in NX7.5.0.

License requirements : None

Parameters:
productPointsPoints representing the shape of the product.

Get the sample points on the sprung surface.

Only when type is Die::SpringbackCompensationBuilder::DefinedByTypePoints .
Created in NX7.5.0.

License requirements : None

Parameters:
sprungPointsPoints representing the shape of the sprung sheet.

Returns the inner boundary curve of the transition area.


Created in NX7.5.0.

License requirements : None

Returns the indication if the feature is a generic Global Deformation.

True indicates the feature is a Global Deformation, false indicates the feature is not a Global Deformation.
Created in NX7.5.0.

License requirements : None

Returns the one-step feature.

Only when type is Die::SpringbackCompensationBuilder::DefinedByTypeOneStepFeature .
Created in NX7.5.0.

License requirements : None

Returns the outer boundary curve of transition area.


Created in NX7.5.0.

License requirements : None

Returns the product facets.

Only when type is Die::SpringbackCompensationBuilder::DefinedByTypeFacetedBodies . Optional.
Created in NX7.5.0.

License requirements : None

Returns the product points file name.

This is saved for reference only. The product points are actually defined by calling Die::SpringbackCompensationBuilder::SetProductPoints . Only when type is Die::SpringbackCompensationBuilder::DefinedByTypePoints . Optional.


Created in NX7.5.0.

License requirements : None

Returns the sheet body representing the product shape.

Only when type is Die::SpringbackCompensationBuilder::DefinedByTypeFacetedBodies or Die::SpringbackCompensationBuilder::DefinedByTypePoints .
Created in NX7.5.0.

License requirements : None

Returns the type of output to generate.


Created in NX7.5.0.

License requirements : None

Sets the angle tolerance.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
angleToleranceangletolerance

Sets the indication if the feature should calculate the maximum deviation of the result.

True indicates the deviation should be calculated, false indicates the deviation will not be calculated.
Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
calculateMaxDeviationcalculatemaxdeviation

Sets the convexity direction.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
convexityDirectionconvexitydirection

Sets the toggle that determines whether to constrain convexity
Created in NX7.5.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
isConvexityEnabledisconvexityenabled

Sets the value determines if a faceted output body is also created.

True indicates to output a faceted body, false indicates that a faceted body is not output. Only when type is Die::SpringbackCompensationBuilder::DefinedByTypeFacetedBodies


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
createFacetscreatefacets

Sets the deformation factor determines how much of the calculated deformation is applied to the result body.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
deformationFactordeformationfactor

Sets the polynomial degree (one unit less than the order).


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
degreedegree

Sets the distance tolerance.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
distanceTolerancedistancetolerance

Sets the number of equi-distant points to divide the cube of the sheet body (N x N x N).


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
divisionsdivisions

Sets the vector indicating the draw direction.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
drawVectordrawvector

Sets the indication if the feature is a generic Global Deformation.

True indicates the feature is a Global Deformation, false indicates the feature is not a Global Deformation.
Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
isGlobalDeformationisglobaldeformation
void NXOpen::Die::SpringbackCompensationBuilder::SetProductPoints ( const std::vector< NXOpen::Point3d > &  productPoints)

Set the sample points on the product surface.

Must have the same number as sprung points. Only when type is Die::SpringbackCompensationBuilder::DefinedByTypePoints . Optional.
Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
productPointsPoints representing the shape of the product.

Sets the product points file name.

This is saved for reference only. The product points are actually defined by calling Die::SpringbackCompensationBuilder::SetProductPoints . Only when type is Die::SpringbackCompensationBuilder::DefinedByTypePoints . Optional.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
filenamefilename

Sets the type of output to generate.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
resultTyperesulttype

Sets the parameter that determines the shape of the transition area.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
shapeValueshapevalue

Sets the smoothing factor regulates a trade-off between interpolation error and smoothing when creating the result body.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
smoothingFactorsmoothingfactor

Set the sample points on the sprung surface.

Must have the same number as product points. Only when type is Die::SpringbackCompensationBuilder::DefinedByTypePoints .
Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
sprungPointsPoints representing the shape of the sprung sheet.

Sets the sprung points file name.

This is saved for reference only. The product points are actually defined by calling Die::SpringbackCompensationBuilder::SetSprungPoints . Only when type is Die::SpringbackCompensationBuilder::DefinedByTypePoints . Optional.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
filenamefilename

Sets the step size.


Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
stepSizestepsize

Returns the parameter that determines the shape of the transition area.


Created in NX7.5.0.

License requirements : None

Returns the smoothing factor regulates a trade-off between interpolation error and smoothing when creating the result body.


Created in NX7.5.0.

License requirements : None

Returns the sprung facets.

Only when type is Die::SpringbackCompensationBuilder::DefinedByTypeFacetedBodies .
Created in NX7.5.0.

License requirements : None

Returns the sprung points file name.

This is saved for reference only. The product points are actually defined by calling Die::SpringbackCompensationBuilder::SetSprungPoints . Only when type is Die::SpringbackCompensationBuilder::DefinedByTypePoints . Optional.


Created in NX7.5.0.

License requirements : None

Returns the step size.


Created in NX7.5.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.