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

Represents a sketch-on-path evaluator. More...

Inheritance diagram for NXOpen::SketchEvaluator:
NXOpen::TaggedObject

Public Member Functions

double AngularTolerance ()
 Returns the angle tolerance [degrees]
Created in NX4.0.1. More...
 
bool CreateCurveOption ()
 Returns the option which allows automatic create of non-associative UG curves for the sketch evaluation. More...
 
void Destroy ()
 Deletes the sketch evaluator, and cleans up any objects created by the it
Created in NX4.0.1. More...
 
double DistanceTolerance ()
 Returns the distance tolerance
Created in NX4.0.1. More...
 
std::vector< NXOpen::Curve * > EvaluateOneSketch (double pathLocation)
 Work-horse method that evaluates the master section and its sketch on path at a specific path location. More...
 
NXOpen::SectionSection ()
 Returns the master section. More...
 
void SetAngularTolerance (double angleTolerance)
 Sets the angle tolerance [degrees]
Created in NX4.0.1. More...
 
void SetCreateCurveOption (bool createCurveOption)
 Sets the option which allows automatic create of non-associative UG curves for the sketch evaluation. More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance
Created in NX4.0.1. More...
 
void SetSection (NXOpen::Section *section)
 Sets the master section. More...
 
void SetSimplifyCurveOption (bool simplifySplineOption)
 Sets the option which allows the automatic conversion of curves into an approximation of sorted sequence of arcs and lines. More...
 
bool SimplifyCurveOption ()
 Returns the option which allows the automatic conversion of curves into an approximation of sorted sequence of arcs and lines. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a sketch-on-path evaluator.

It allows an application to evaluate a section and a sketch-on-path at specific path locations.
To create a new instance of this class, use NXOpen::SketchEvaluatorCollection::Create

Created in NX4.0.1.

Member Function Documentation

double NXOpen::SketchEvaluator::AngularTolerance ( )

Returns the angle tolerance [degrees]
Created in NX4.0.1.



License requirements : None

bool NXOpen::SketchEvaluator::CreateCurveOption ( )

Returns the option which allows automatic create of non-associative UG curves for the sketch evaluation.

Note: [1] This property is only used for a call to method "EvaluateOneSketch". [2] this property is defaulted to false.


Created in NX4.0.1.

License requirements : solid_modeling ("SOLIDS MODELING")

void NXOpen::SketchEvaluator::Destroy ( )

Deletes the sketch evaluator, and cleans up any objects created by the it
Created in NX4.0.1.



License requirements : None

double NXOpen::SketchEvaluator::DistanceTolerance ( )

Returns the distance tolerance
Created in NX4.0.1.



License requirements : None

std::vector<NXOpen::Curve *> NXOpen::SketchEvaluator::EvaluateOneSketch ( double  pathLocation)

Work-horse method that evaluates the master section and its sketch on path at a specific path location.

Pre-conditions : [1] A master section must have been registered with call to mutator set_section() or the sketch evaluator must be constructed with an existing feature.

[2] The application should edit the properties "CreateCurveOption", "SimplifyCurveOption" as needed before calling this method.

Post-conditions: [3] If the "create curve" option is set to false, the output curves should be accessed right away. The lifetime of these curves is as long as the next call to method "EvaluateOneSketch".

[4] If the application wants to evaluate the same sketch at multiple path location, it should make several consecutive calls to method "EvaluateOneSketch". At the end of the operation, the application must call method "Destroy".

[5] If the "simplify curve" option is false, the number of curves will always be the same.

[6] The design of this functionality has not been tailored for master section with multiple loops. If the master section has multiple loops, all the curves will be returned in the order of the loops in the section.

[7] Method "EvaluateOneSketch" changes the state of the sketch on path. Therefore, the part is temporarily in out of date state. The application should leverage the NX undo mechanism to reset the state to its original. An alternative solution is to suppress and unsuppress the sketch on path and variational sweep features involved.

Returns

Created in NX4.0.1.

License requirements : solid_modeling ("SOLIDS MODELING")
Parameters
pathLocationinput path arc length percent to evaluate at.
NXOpen::Section* NXOpen::SketchEvaluator::Section ( )

Returns the master section.

Variational sweep accepts sections created ONLY on in the context of a Sketch on Path. Make sure this section is coming from sketch curves created using the sketch on path feature. The application should not mutate the section if evaluator object is created with vsweep feature. Return code : 0 : no error, VARSWEEP_SKETCH_NOT_ON_PATH : on an error condition


Created in NX4.0.1.

License requirements : None

void NXOpen::SketchEvaluator::SetAngularTolerance ( double  angleTolerance)

Sets the angle tolerance [degrees]
Created in NX4.0.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
angleToleranceangle tolerance
void NXOpen::SketchEvaluator::SetCreateCurveOption ( bool  createCurveOption)

Sets the option which allows automatic create of non-associative UG curves for the sketch evaluation.

Note: [1] This property is only used for a call to method "EvaluateOneSketch". [2] this property is defaulted to false.


Created in NX4.0.1.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
createCurveOptioncreate curve option
void NXOpen::SketchEvaluator::SetDistanceTolerance ( double  distanceTolerance)

Sets the distance tolerance
Created in NX4.0.1.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
distanceTolerancedistance tolerance
void NXOpen::SketchEvaluator::SetSection ( NXOpen::Section section)

Sets the master section.

Variational sweep accepts sections created ONLY on in the context of a Sketch on Path. Make sure this section is coming from sketch curves created using the sketch on path feature. The application should not mutate the section if evaluator object is created with vsweep feature. Return code : 0 : no error, VARSWEEP_SKETCH_NOT_ON_PATH : on an error condition


Created in NX4.0.1.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
sectionmaster section
void NXOpen::SketchEvaluator::SetSimplifyCurveOption ( bool  simplifySplineOption)

Sets the option which allows the automatic conversion of curves into an approximation of sorted sequence of arcs and lines.

This option only convert curves that are not arcs and lines.

Note: [1] This property is only used for a call to method "EvaluateOneSketch". [2] This property is defaulted to false.


Created in NX4.0.1.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
simplifySplineOptionthe simplify spline option
bool NXOpen::SketchEvaluator::SimplifyCurveOption ( )

Returns the option which allows the automatic conversion of curves into an approximation of sorted sequence of arcs and lines.

This option only convert curves that are not arcs and lines.

Note: [1] This property is only used for a call to method "EvaluateOneSketch". [2] This property is defaulted to false.


Created in NX4.0.1.

License requirements : solid_modeling ("SOLIDS MODELING")


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