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

Studio Spline builder class. More...

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

Public Types

enum  CurveOption { CurveOptionRetain, CurveOptionBlank, CurveOptionDelete }
 Options of the actions to be taken on an input non-parametric spline after its editing is done. More...
 
enum  MatchKnotsType { MatchKnotsTypeNone, MatchKnotsTypeCubic, MatchKnotsTypeGeneral }
 Options for creating knots at the defining points in case of through point spline. More...
 
enum  Method { MethodThroughPoints, MethodByPoles }
 Spline methods. More...
 

Public Member Functions

bool Associative ()
 Returns the associative or non associative way of spline creation
More...
 
NXOpen::Features::GeometricConstraintDataManagerConstraintManager ()
 Returns the constraint manager
More...
 
NXOpen::SplineCurve ()
 Returns the spline curve
More...
 
int Degree ()
 Returns the degree
More...
 
std::vector< double > GetKnots ()
 Queries the knot sequence for by pole spline. More...
 
std::vector< double > GetParameters ()
 Queries the parameters at defining points for a through point spline. More...
 
NXOpen::Features::StudioSplineBuilder::CurveOption InputCurveOption ()
 Returns the input curve option
More...
 
bool IsPeriodic ()
 Returns the periodicity
More...
 
NXOpen::Features::StudioSplineBuilder::MatchKnotsType MatchKnots ()
 Returns a constraint to match knots at the defining points for a through point spline
More...
 
void SetAssociative (bool associative)
 Sets the associative or non associative way of spline creation
More...
 
void SetDegree (int degree)
 Sets the degree
More...
 
void SetInputCurveOption (NXOpen::Features::StudioSplineBuilder::CurveOption option)
 Sets the input curve option
More...
 
void SetKnots (const std::vector< double > &knots)
 Sets the optional knot sequence for by pole spline
More...
 
void SetMatchKnots (NXOpen::Features::StudioSplineBuilder::MatchKnotsType matchKnots)
 Sets a constraint to match knots at the defining points for a through point spline
More...
 
void SetNonParametricSpline (NXOpen::Spline *spline, NXOpen::Features::StudioSplineBuilder::Method method)
 Sets a non-parametric spline for editing
More...
 
void SetParameters (const std::vector< double > &parameters)
 Sets the optional parameters at defining points for a through point spline
More...
 
void SetPeriodic (bool periodicity)
 Sets the periodicity
More...
 
void SetSplineMethod (NXOpen::Features::StudioSplineBuilder::Method method)
 Sets the spline method
More...
 
NXOpen::Features::StudioSplineBuilder::Method SplineMethod ()
 Returns the spline method
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

Studio Spline builder class.


To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateStudioSplineBuilder

Deprecated:
Deprecated in NX8.0.0. Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

Member Enumeration Documentation

Options of the actions to be taken on an input non-parametric spline after its editing is done.

These options are used only while trying to make non-parametric spline a feature.

Enumerator
CurveOptionRetain 

Retain input curve.

CurveOptionBlank 

Blank input curve.

CurveOptionDelete 

Delete input curve.

Options for creating knots at the defining points in case of through point spline.

Enumerator
MatchKnotsTypeNone 

No knot matching.

MatchKnotsTypeCubic 

Match knots for cubic non-periodic spline.

MatchKnotsTypeGeneral 

Match knots for general spline.

Spline methods.

Enumerator
MethodThroughPoints 

Spline through points.

MethodByPoles 

Spline by poles.

Member Function Documentation

bool NXOpen::Features::StudioSplineBuilder::Associative ( )

Returns the associative or non associative way of spline creation

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

NXOpen::Features::GeometricConstraintDataManager* NXOpen::Features::StudioSplineBuilder::ConstraintManager ( )

Returns the constraint manager

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

NXOpen::Spline* NXOpen::Features::StudioSplineBuilder::Curve ( )

Returns the spline curve

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

int NXOpen::Features::StudioSplineBuilder::Degree ( )

Returns the degree

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

std::vector<double> NXOpen::Features::StudioSplineBuilder::GetKnots ( )

Queries the knot sequence for by pole spline.

Returns
The knot sequence
Deprecated:
Deprecated in NX8.0.0. Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

std::vector<double> NXOpen::Features::StudioSplineBuilder::GetParameters ( )

Queries the parameters at defining points for a through point spline.

Returns
The parameters
Deprecated:
Deprecated in NX8.0.0. Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

NXOpen::Features::StudioSplineBuilder::CurveOption NXOpen::Features::StudioSplineBuilder::InputCurveOption ( )

Returns the input curve option

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

bool NXOpen::Features::StudioSplineBuilder::IsPeriodic ( )

Returns the periodicity

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

NXOpen::Features::StudioSplineBuilder::MatchKnotsType NXOpen::Features::StudioSplineBuilder::MatchKnots ( )

Returns a constraint to match knots at the defining points for a through point spline

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

void NXOpen::Features::StudioSplineBuilder::SetAssociative ( bool  associative)

Sets the associative or non associative way of spline creation

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters
associativeassociative
void NXOpen::Features::StudioSplineBuilder::SetDegree ( int  degree)

Sets the degree

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters
degreedegree
void NXOpen::Features::StudioSplineBuilder::SetInputCurveOption ( NXOpen::Features::StudioSplineBuilder::CurveOption  option)

Sets the input curve option

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters
optionoption
void NXOpen::Features::StudioSplineBuilder::SetKnots ( const std::vector< double > &  knots)

Sets the optional knot sequence for by pole spline

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters
knotsThe knot sequence
void NXOpen::Features::StudioSplineBuilder::SetMatchKnots ( NXOpen::Features::StudioSplineBuilder::MatchKnotsType  matchKnots)

Sets a constraint to match knots at the defining points for a through point spline

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters
matchKnotsmatch knots
void NXOpen::Features::StudioSplineBuilder::SetNonParametricSpline ( NXOpen::Spline spline,
NXOpen::Features::StudioSplineBuilder::Method  method 
)

Sets a non-parametric spline for editing

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters
splineNon parameteric spline
methodSpline method for parameterization
void NXOpen::Features::StudioSplineBuilder::SetParameters ( const std::vector< double > &  parameters)

Sets the optional parameters at defining points for a through point spline

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters
parametersThe parameters
void NXOpen::Features::StudioSplineBuilder::SetPeriodic ( bool  periodicity)

Sets the periodicity

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters
periodicityperiodicity
void NXOpen::Features::StudioSplineBuilder::SetSplineMethod ( NXOpen::Features::StudioSplineBuilder::Method  method)

Sets the spline method

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Parameters
methodmethod
NXOpen::Features::StudioSplineBuilder::Method NXOpen::Features::StudioSplineBuilder::SplineMethod ( )

Returns the spline method

Deprecated:
Deprecated in NX8.0.0.

Use NXOpen::Features::StudioSplineBuilderEx instead.


Created in NX5.0.0.

License requirements : features_modeling ("FEATURES MODELING")


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