NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::GeometricUtilities::CurveShapingBuilder Class Reference

Represents a GeometricUtilities::CurveShapingBuilder . More...

Inheritance diagram for NXOpen::GeometricUtilities::CurveShapingBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  InsertionMethodOptions { InsertionMethodOptionsUniform, InsertionMethodOptionsThroughPoints, InsertionMethodOptionsBetweenPoints }
 Point insertion option. More...
enum  MovementMethodType {
  MovementMethodTypeWCS, MovementMethodTypeView, MovementMethodTypeVector, MovementMethodTypePlane,
  MovementMethodTypeNormal
}
 Curve parameter points movement types. More...
enum  WCSOptionType {
  WCSOptionTypeX, WCSOptionTypeY, WCSOptionTypeZ, WCSOptionTypeYZ,
  WCSOptionTypeXZ, WCSOptionTypeXY
}
 WCS principal axis or plane types. More...

Public Member Functions

void AddCurve (NXOpen::Curve *curve)
 Adds a curve for shaping
Created in NX7.5.0.
void ApplyParameterValue (NXOpen::Point *sourcePoint, const std::vector< NXOpen::Point * > &destinationPoints)
 Applies parameter value from a key point to a group of key points without affecting curve shape
Created in NX7.5.0.
bool CanMoveAlongCurve ()
 Returns the value indicating if point should be moved along curve.
NXOpen::Features::GeometricConstraintDataManagerConstraintManager ()
 Returns the constraint manager.
void Deform ()
 Deforms curves based on active points
Created in NX7.5.0.
void DeleteAllPoints (NXOpen::Spline *curve)
 Deletes all points on a curve.
NXOpen::GeometricUtilities::Continuity::ContinuityTypes EndContinuity ()
 Returns the continuity at end of the curve
Created in NX7.5.0.
bool HasLinearTransition ()
 Returns the value indicating if transition type is linear
Created in NX7.5.0.
NXOpen::GeometricUtilities::CurveShapingBuilder::InsertionMethodOptions InsertionMethod ()
 Returns the point insertion method
Created in NX7.5.0.
NXOpen::GeometricUtilities::CurveShapingBuilder::MovementMethodType MovementMethod ()
 Returns the movement method
Created in NX7.5.0.
NXOpen::PlaneMovementPlane ()
 Returns the movement plane
Created in NX7.5.0.
NXOpen::DirectionMovementVector ()
 Returns the movement vector
Created in NX7.5.0.
int Number ()
 Returns the number of points to be inserted
Created in NX7.5.0.
NXOpen::GeometricUtilities::OrientXpressBuilderOrientExpress ()
 Returns the orient express object
Created in NX7.5.0.
void RemoveCurve (NXOpen::Curve *curve)
 Removes a curve
Created in NX7.5.0.
NXOpen::SelectSplineListSelectCurves ()
 Returns the curve selection for point insertion
Created in NX7.5.0.
void SetActivePoints (const std::vector< NXOpen::Point * > &points, NXOpen::Point *masterPoint)
 Sets key points that are selected or will be moved
Created in NX7.5.0.
void SetCanMoveAlongCurve (bool canMoveAlongCurve)
 Sets the value indicating if point should be moved along curve.
void SetEndContinuity (NXOpen::GeometricUtilities::Continuity::ContinuityTypes endContinuity)
 Sets the continuity at end of the curve
Created in NX7.5.0.
void SetHasLinearTransition (bool hasLinear)
 Sets the value indicating if transition type is linear
Created in NX7.5.0.
void SetInsertionMethod (NXOpen::GeometricUtilities::CurveShapingBuilder::InsertionMethodOptions insertionMethod)
 Sets the point insertion method
Created in NX7.5.0.
void SetMovementMethod (NXOpen::GeometricUtilities::CurveShapingBuilder::MovementMethodType movementMethod)
 Sets the movement method
Created in NX7.5.0.
void SetMovementPlane (NXOpen::Plane *movementPlane)
 Sets the movement plane
Created in NX7.5.0.
void SetMovementVector (NXOpen::Direction *movementVector)
 Sets the movement vector
Created in NX7.5.0.
void SetNumber (int number)
 Sets the number of points to be inserted
Created in NX7.5.0.
void SetStartContinuity (NXOpen::GeometricUtilities::Continuity::ContinuityTypes startContinuity)
 Sets the continuity at start of the curve
Created in NX7.5.0.
void SetWCSOption (NXOpen::GeometricUtilities::CurveShapingBuilder::WCSOptionType wcsOption)
 Sets the WCS option
Created in NX7.5.0.
NXOpen::SelectPointListSpecifyPoints ()
 Returns the specified points to define insertion point locations
Created in NX7.5.0.
NXOpen::GeometricUtilities::Continuity::ContinuityTypes StartContinuity ()
 Returns the continuity at start of the curve
Created in NX7.5.0.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.
NXOpen::GeometricUtilities::CurveShapingBuilder::WCSOptionType WCSOption ()
 Returns the WCS option
Created in NX7.5.0.

Detailed Description

Represents a GeometricUtilities::CurveShapingBuilder .

This class allows shaping of curves by identifying key points on them and modifying the location of those points. It also allows constraining curve ends.
Created in NX7.5.0.


Member Enumeration Documentation

Point insertion option.

Enumerator:
InsertionMethodOptionsUniform 

Insert points uniformly.

InsertionMethodOptionsThroughPoints 

Insert points through points.

InsertionMethodOptionsBetweenPoints 

Insert points between points.

Curve parameter 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.

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

Adds a curve for shaping
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
curveCurve to be deformed
void NXOpen::GeometricUtilities::CurveShapingBuilder::ApplyParameterValue ( NXOpen::Point sourcePoint,
const std::vector< NXOpen::Point * > &  destinationPoints 
)

Applies parameter value from a key point to a group of key points without affecting curve shape
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
sourcePointPoint whose parameter value to be applied
destinationPointsPoints to be edited

Returns the value indicating if point should be moved along curve.

A key point is moved along the curve in order to change its parametric location without affecting curve shape.
Created in NX7.5.0.

License requirements : None

Returns the constraint manager.

Allows definition of key points to be used to shape the curve.
Created in NX7.5.0.

License requirements : None

Deforms curves based on active points
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Deletes all points on a curve.

If no curve is specified, deletes all points on all curves.
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
curveCurve

Returns the continuity at end of the curve
Created in NX7.5.0.



License requirements : None

Returns the value indicating if transition type is linear
Created in NX7.5.0.



License requirements : None

Returns the point insertion method
Created in NX7.5.0.



License requirements : None

Returns the movement method
Created in NX7.5.0.



License requirements : None

Returns the movement plane
Created in NX7.5.0.



License requirements : None

Returns the movement vector
Created in NX7.5.0.



License requirements : None

Returns the number of points to be inserted
Created in NX7.5.0.



License requirements : None

Returns the orient express object
Created in NX7.5.0.



License requirements : None

Removes a curve
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
curveCurve to be deleted

Returns the curve selection for point insertion
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

void NXOpen::GeometricUtilities::CurveShapingBuilder::SetActivePoints ( const std::vector< NXOpen::Point * > &  points,
NXOpen::Point masterPoint 
)

Sets key points that are selected or will be moved
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
pointsKey points
masterPointPoint which user actually moves to move a group of selected points

Sets the value indicating if point should be moved along curve.

A key point is moved along the curve in order to change its parametric location without affecting curve shape.
Created in NX7.5.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
canMoveAlongCurvecanmovealongcurve

Sets the continuity at end of the curve
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
endContinuityendcontinuity

Sets the value indicating if transition type is linear
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
hasLinearhaslinear

Sets the point insertion method
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
insertionMethodinsertionmethod

Sets the movement method
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
movementMethodmovementmethod

Sets the movement plane
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
movementPlanemovementplane

Sets the movement vector
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
movementVectormovementvector

Sets the number of points to be inserted
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
numbernumber

Sets the continuity at start of the curve
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
startContinuitystartcontinuity

Sets the WCS option
Created in NX7.5.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters:
wcsOptionwcsoption

Returns the specified points to define insertion point locations
Created in NX7.5.0.



License requirements : None

Returns the continuity at start of the curve
Created in NX7.5.0.



License requirements : None

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns:
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

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