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

Studio Spline builder class. More...

Inheritance diagram for NXOpen::Features::StudioSplineBuilderEx:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Features::DraftingSplineBuilder NXOpen::Features::SketchSplineBuilder

List of all members.

Public Types

enum  DrawingPlaneOptions {
  DrawingPlaneOptionsView, DrawingPlaneOptionsXY, DrawingPlaneOptionsYZ, DrawingPlaneOptionsXZ,
  DrawingPlaneOptionsGeneral
}
 Drawing plane options. More...
enum  InputCurveOptions { InputCurveOptionsKeep, InputCurveOptionsHide, InputCurveOptionsDelete }
 Options of the actions to be taken on an input non-parametric spline after its editing is done. More...
enum  MatchKnotsTypes { MatchKnotsTypesNone, MatchKnotsTypesCubic, MatchKnotsTypesGeneral }
 Options for creating knots at the defining points in case of through point spline. More...
enum  MovementMethodType {
  MovementMethodTypeWCS, MovementMethodTypeView, MovementMethodTypeVector, MovementMethodTypePlane,
  MovementMethodTypeNormal, MovementMethodTypePolygon
}
 Points movement types. More...
enum  Types { TypesThroughPoints, TypesByPoles }
 Spline methods. More...
enum  WCSOptionType {
  WCSOptionTypeX, WCSOptionTypeY, WCSOptionTypeZ, WCSOptionTypeYZ,
  WCSOptionTypeXZ, WCSOptionTypeXY
}
 WCS principal axis or plane types. More...

Public Member Functions

NXOpen::Features::GeometricConstraintDataManagerConstraintManager ()
 Returns the constraint manager
Created in NX8.0.0.
NXOpen::CoordinateSystemConstraintPlane ()
 Returns the coordinate system defining plane constraint
Created in NX8.0.0.
NXOpen::SplineCurve ()
 Returns the spline curve
Created in NX8.0.0.
int Degree ()
 Returns the degree
Created in NX8.0.0.
NXOpen::PlaneDrawingPlane ()
 Returns the drawing plane
Created in NX8.0.0.
NXOpen::Features::StudioSplineBuilderEx::DrawingPlaneOptions DrawingPlaneOption ()
 Returns a drawing plane option
Created in NX8.0.0.
void EditSpline (NXOpen::NXObject *spline)
 Sets a non-parametric spline for editing
Created in NX8.0.0.
void Evaluate ()
 Evaluates the spline
Created in NX8.0.0.
NXOpen::GeometricUtilities::SplineExtensionBuilderExtender ()
 Returns the extension option
Created in NX8.0.0.
std::vector< double > GetKnots ()
 Queries the knot sequence for by pole spline.
std::vector< double > GetParameters ()
 Queries the parameters at defining points for a through point spline.
bool HasPlaneConstraint ()
 Returns the flag indicating if spline has plane constraint
Created in NX8.0.0.
bool HasProportionalUpdate ()
 Returns the flag indicating if free or non attached defining points or poles should be moved proportionally during update of the spline feature
Created in NX8.0.0.
NXOpen::Features::StudioSplineBuilderEx::InputCurveOptions InputCurveOption ()
 Returns the input curve option
Created in NX8.0.0.
void InsertKnot (const NXOpen::Point3d &point)
 Inserts knot at a closest point on the spline
Created in NX8.0.0.
void InsertPole (int afterIndex)
 Inserts a pole in the middle of a control polygon segment
Created in NX8.0.0.
bool IsAssociative ()
 Returns the flag indicating if a feature should be created
Created in NX8.0.0.
bool IsPeriodic ()
 Returns the periodicity
Created in NX8.0.0.
bool IsSingleSegment ()
 Returns a flag indicating if single segment by pole spline is to be created
Created in NX8.0.0.
NXOpen::Features::StudioSplineBuilderEx::MatchKnotsTypes MatchKnotsType ()
 Returns a constraint to match knots at the defining points for a through point spline
Created in NX8.0.0.
NXOpen::Features::StudioSplineBuilderEx::MovementMethodType MovementMethod ()
 Returns the movement method
Created in NX8.0.0.
NXOpen::PlaneMovementPlane ()
 Returns the movement plane
Created in NX8.0.0.
NXOpen::DirectionMovementVector ()
 Returns the movement vector
Created in NX8.0.0.
NXOpen::GeometricUtilities::OrientXpressBuilderOrientExpress ()
 Returns the orient express object
Created in NX8.0.0.
void SetAssociative (bool associative)
 Sets the flag indicating if a feature should be created
Created in NX8.0.0.
void SetConstraintPlane (NXOpen::CoordinateSystem *coordinateSystem)
 Sets the coordinate system defining plane constraint
Created in NX8.0.0.
void SetDegree (int degree)
 Sets the degree
Created in NX8.0.0.
void SetDrawingPlane (NXOpen::Plane *drawingPlane)
 Sets the drawing plane
Created in NX8.0.0.
void SetDrawingPlaneOption (NXOpen::Features::StudioSplineBuilderEx::DrawingPlaneOptions planeOption)
 Sets a drawing plane option
Created in NX8.0.0.
void SetHasPlaneConstraint (bool hasConstraint)
 Sets the flag indicating if spline has plane constraint
Created in NX8.0.0.
void SetHasProportionalUpdate (bool hasProportionalUpdate)
 Sets the flag indicating if free or non attached defining points or poles should be moved proportionally during update of the spline feature
Created in NX8.0.0.
void SetInputCurveOption (NXOpen::Features::StudioSplineBuilderEx::InputCurveOptions option)
 Sets the input curve option
Created in NX8.0.0.
void SetKnots (const std::vector< double > &knots)
 Sets the optional knot sequence for by pole spline
Created in NX8.0.0.
void SetMatchKnotsType (NXOpen::Features::StudioSplineBuilderEx::MatchKnotsTypes matchKnotsType)
 Sets a constraint to match knots at the defining points for a through point spline
Created in NX8.0.0.
void SetMovementMethod (NXOpen::Features::StudioSplineBuilderEx::MovementMethodType movementMethod)
 Sets the movement method
Created in NX8.0.0.
void SetMovementPlane (NXOpen::Plane *movementPlane)
 Sets the movement plane
Created in NX8.0.0.
void SetMovementVector (NXOpen::Direction *movementVector)
 Sets the movement vector
Created in NX8.0.0.
void SetParameters (const std::vector< double > &parameters)
 Sets the optional parameters at defining points for a through point spline
Created in NX8.0.0.
void SetPeriodic (bool periodicity)
 Sets the periodicity
Created in NX8.0.0.
void SetSingleSegment (bool isSingleSegment)
 Sets a flag indicating if single segment by pole spline is to be created
Created in NX8.0.0.
void SetType (NXOpen::Features::StudioSplineBuilderEx::Types type)
 Sets the spline method
Created in NX8.0.0.
void SetWCSOption (NXOpen::Features::StudioSplineBuilderEx::WCSOptionType wcsOption)
 Sets the WCS option
Created in NX8.0.0.
NXOpen::Features::StudioSplineBuilderEx::Types Type ()
 Returns the spline method
Created in NX8.0.0.
void UpdateOnConstraintPlane ()
 Updates spline based on constraint plane
Created in NX8.0.0.
NXOpen::Features::StudioSplineBuilderEx::WCSOptionType WCSOption ()
 Returns the WCS option
Created in NX8.0.0.

Detailed Description

Studio Spline builder class.


To create a new instance of this class, use Features::FeatureCollection::CreateStudioSplineBuilderEx
Default values.

Property Value

DrawingPlaneOption

View

Extender.EndExtensionOption

None

Extender.EndValue.Value

0 (millimeters part), 0 (inches part)

Extender.StartExtensionOption

None

Extender.StartValue.Value

0 (millimeters part), 0 (inches part)

InputCurveOption

Hide

MatchKnotsType

None

MovementMethod

View

Type

ThroughPoints

WCSOption

X


Created in NX8.0.0.


Member Enumeration Documentation

Drawing plane options.

Enumerator:
DrawingPlaneOptionsView 

View plane.

DrawingPlaneOptionsXY 

XY plane.

DrawingPlaneOptionsYZ 

YZ plane.

DrawingPlaneOptionsXZ 

XZ plane.

DrawingPlaneOptionsGeneral 

General plane.

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:
InputCurveOptionsKeep 

Keep original curve.

InputCurveOptionsHide 

Hide original curve.

InputCurveOptionsDelete 

Delete original curve.

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

Enumerator:
MatchKnotsTypesNone 

No knot matching.

MatchKnotsTypesCubic 

Match knots for cubic non-periodic spline.

MatchKnotsTypesGeneral 

Match knots for general spline.

Points movement types.

Enumerator:
MovementMethodTypeWCS 

Movement along WCS principal axis or plane.

MovementMethodTypeView 

Movement in view plane.

MovementMethodTypeVector 

Movement along arbitrary direction.

MovementMethodTypePlane 

Movement in arbitrary plane.

MovementMethodTypeNormal 

Movement along a face normal.

MovementMethodTypePolygon 

Movement along a relevant control polygon segment.

Spline methods.

Enumerator:
TypesThroughPoints 

Spline through points.

TypesByPoles 

Spline by poles.

WCS principal axis or plane types.

Enumerator:
WCSOptionTypeX 

Along X axis.

WCSOptionTypeY 

Along Y axis.

WCSOptionTypeZ 

Along Z axis.

WCSOptionTypeYZ 

In YZ plane.

WCSOptionTypeXZ 

In XZ plane.

WCSOptionTypeXY 

In XY plane.


Member Function Documentation

Returns the constraint manager
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Returns the coordinate system defining plane constraint
Created in NX8.0.0.



License requirements : None

Returns the spline curve
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Returns the degree
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Returns the drawing plane
Created in NX8.0.0.



License requirements : None

Returns a drawing plane option
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Sets a non-parametric spline for editing
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
splinespline

Evaluates the spline
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Returns the extension option
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Queries the knot sequence for by pole spline.

Returns:
The knot sequence
Created in NX8.0.0.

License requirements : features_modeling ("FEATURES MODELING")

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

Returns:
The parameters
Created in NX8.0.0.

License requirements : features_modeling ("FEATURES MODELING")

Returns the flag indicating if spline has plane constraint
Created in NX8.0.0.



License requirements : None

Returns the flag indicating if free or non attached defining points or poles should be moved proportionally during update of the spline feature
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Returns the input curve option
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Inserts knot at a closest point on the spline
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
pointPoint at which knot to be inserted

Inserts a pole in the middle of a control polygon segment
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
afterIndexIndex of a pole after which to insert new pole

Returns the flag indicating if a feature should be created
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Returns the periodicity
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Returns a flag indicating if single segment by pole spline is to be created
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Returns a constraint to match knots at the defining points for a through point spline
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Returns the movement method
Created in NX8.0.0.



License requirements : None

Returns the movement plane
Created in NX8.0.0.



License requirements : None

Returns the movement vector
Created in NX8.0.0.



License requirements : None

Returns the orient express object
Created in NX8.0.0.



License requirements : None

Sets the flag indicating if a feature should be created
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
associativeassociative

Sets the coordinate system defining plane constraint
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
coordinateSystemcoordinatesystem

Sets the degree
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
degreedegree

Sets the drawing plane
Created in NX8.0.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
drawingPlanedrawingplane

Sets a drawing plane option
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
planeOptionplaneoption

Sets the flag indicating if spline has plane constraint
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
hasConstrainthasconstraint

Sets the flag indicating if free or non attached defining points or poles should be moved proportionally during update of the spline feature
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
hasProportionalUpdatehasproportionalupdate

Sets the input curve option
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

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

Sets the optional knot sequence for by pole spline
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
knotsThe knot sequence

Sets a constraint to match knots at the defining points for a through point spline
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
matchKnotsTypematchknotstype

Sets the movement method
Created in NX8.0.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
movementMethodmovementmethod

Sets the movement plane
Created in NX8.0.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
movementPlanemovementplane

Sets the movement vector
Created in NX8.0.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
movementVectormovementvector
void NXOpen::Features::StudioSplineBuilderEx::SetParameters ( const std::vector< double > &  parameters)

Sets the optional parameters at defining points for a through point spline
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
parametersThe parameters

Sets the periodicity
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
periodicityperiodicity

Sets a flag indicating if single segment by pole spline is to be created
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
isSingleSegmentissinglesegment

Sets the spline method
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Parameters:
typetype

Sets the WCS option
Created in NX8.0.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
wcsOptionwcsoption

Returns the spline method
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Updates spline based on constraint plane
Created in NX8.0.0.



License requirements : features_modeling ("FEATURES MODELING")

Returns the WCS option
Created in NX8.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.