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

Use the SketchAlongPathBuilder to create or reattach a Sketch along a path. More...

Inheritance diagram for NXOpen::SketchAlongPathBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  PlaneOrientationType { PlaneOrientationTypeNormalToPath, PlaneOrientationTypeNormalToVector, PlaneOrientationTypeParallelToVector, PlaneOrientationTypeThroughAxis }
 Indicates the orientation of the plane. More...
enum  SketchOrientationType { SketchOrientationTypeAutomatic, SketchOrientationTypeRelativeToFace, SketchOrientationTypeUseCurveParameters }
 Indicates the sketch orientation method. More...

Public Member Functions

NXOpen::SelectIReferenceAxisAxis ()
 Returns the horizontal reference
Created in NX5.0.0.
double NextThroughPointSolution ()
 Returns the parameter indicating the location of the next solution
Created in NX5.0.0.
NXOpen::ScCollectorOrientingFace ()
 Returns the orienting faces to evaluate X and Y axis of sketch if SketchAlongPathBuilder::SketchOrientationType is SketchAlongPathBuilder::SketchOrientationTypeRelativeToFace .
NXOpen::GeometricUtilities::OnPathDimensionBuilderPlaneLocation ()
 Returns the plane location
Created in NX5.0.0.
NXOpen::SketchAlongPathBuilder::PlaneOrientationType PlaneOrientation ()
 Returns the plane orientation type
Created in NX5.0.0.
NXOpen::DirectionPlaneOrientationAxis ()
 Returns the plane orientation axis for one of the types of "Normal to Vector", "Parallel to Vector" and "Through Axis"
Created in NX5.0.0.
bool ReverseAxis ()
 Returns the flag to indicate the horizontal reference axis is reversed
Created in NX5.0.0.
bool ReversePlaneNormal ()
 Returns the flag to indicate the plane normal is reversed
Created in NX5.0.0.
NXOpen::SectionSection ()
 Returns the path
Created in NX5.0.0.
void SetPlaneOrientation (NXOpen::SketchAlongPathBuilder::PlaneOrientationType planeOrientationType)
 Sets the plane orientation type
Created in NX5.0.0.
void SetPlaneOrientationAxis (NXOpen::Direction *vector)
 Sets the plane orientation axis for one of the types of "Normal to Vector", "Parallel to Vector" and "Through Axis"
Created in NX5.0.0.
void SetReverseAxis (bool reverseAxis)
 Sets the flag to indicate the horizontal reference axis is reversed
Created in NX5.0.0.
void SetReversePlaneNormal (bool reversePlaneNormal)
 Sets the flag to indicate the plane normal is reversed
Created in NX5.0.0.
void SetShowAllDatumAxes (bool showAllDatumAxes)
 Sets the flag to create all datum axes for path having shared edge.
void SetSketchOrient (NXOpen::SketchAlongPathBuilder::SketchOrientationType sketchOrientMethod)
 Sets the sketch orientation method as SketchAlongPathBuilder::SketchOrientationType
Created in NX6.0.0.
bool ShowAllDatumAxes ()
 Returns the flag to create all datum axes for path having shared edge.
NXOpen::SketchAlongPathBuilder::SketchOrientationType SketchOrient ()
 Returns the sketch orientation method as SketchAlongPathBuilder::SketchOrientationType
Created in NX6.0.0.

Detailed Description

Use the SketchAlongPathBuilder to create or reattach a Sketch along a path.


To create a new instance of this class, use SketchCollection::CreateSketchAlongPathBuilder
Default values.

Property Value

ShowAllDatumAxes

True

SketchOrient

Automatic


Created in NX5.0.0.


Member Enumeration Documentation

Indicates the orientation of the plane.

Enumerator:
PlaneOrientationTypeNormalToPath 

Normal to Path.

PlaneOrientationTypeNormalToVector 

Normal to Vector.

PlaneOrientationTypeParallelToVector 

Parallel to Vector.

PlaneOrientationTypeThroughAxis 

Through Axis.

Indicates the sketch orientation method.

For the sketch orientation type is 'Automatic': two set of datum axes are created if the path contains a shared edge, one set of each face. For laminar edge one set of datum axes is created. If the path contains only wireframe the two set of axes are created. For the sketch orientation type is 'Relative to face': one set of datum axes is craeted using the orienting faces For the sketch orientation type is 'Use curve parameter': one set of datum axes is created using the the curve parameter

Enumerator:
SketchOrientationTypeAutomatic 

Automatic.

SketchOrientationTypeRelativeToFace 

Relative to face.

SketchOrientationTypeUseCurveParameters 

Based on curve parameter.


Member Function Documentation

Returns the horizontal reference
Created in NX5.0.0.



License requirements : None

Returns the parameter indicating the location of the next solution
Created in NX5.0.0.



License requirements : None

Returns the orienting faces to evaluate X and Y axis of sketch if SketchAlongPathBuilder::SketchOrientationType is SketchAlongPathBuilder::SketchOrientationTypeRelativeToFace .

The datum axes are evaluated as tangent and normal of the orienting face.
Created in NX6.0.0.

License requirements : None

Returns the plane location
Created in NX5.0.0.



License requirements : None

Returns the plane orientation type
Created in NX5.0.0.



License requirements : None

Returns the plane orientation axis for one of the types of "Normal to Vector", "Parallel to Vector" and "Through Axis"
Created in NX5.0.0.



License requirements : None

Returns the flag to indicate the horizontal reference axis is reversed
Created in NX5.0.0.



License requirements : None

Returns the flag to indicate the plane normal is reversed
Created in NX5.0.0.



License requirements : None

Returns the path
Created in NX5.0.0.



License requirements : None

Sets the plane orientation type
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
planeOrientationTypeplaneorientationtype

Sets the plane orientation axis for one of the types of "Normal to Vector", "Parallel to Vector" and "Through Axis"
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
vectorvector

Sets the flag to indicate the horizontal reference axis is reversed
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
reverseAxisreverseaxis
void NXOpen::SketchAlongPathBuilder::SetReversePlaneNormal ( bool  reversePlaneNormal)

Sets the flag to indicate the plane normal is reversed
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
reversePlaneNormalreverseplanenormal
void NXOpen::SketchAlongPathBuilder::SetShowAllDatumAxes ( bool  showAllDatumAxes)

Sets the flag to create all datum axes for path having shared edge.

This option is applicable only when SketchAlongPathBuilder::SketchOrientationType is SketchAlongPathBuilder::SketchOrientationTypeRelativeToFace
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
showAllDatumAxesshow all datum axes

Sets the sketch orientation method as SketchAlongPathBuilder::SketchOrientationType
Created in NX6.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
sketchOrientMethodsketch orient method

Returns the flag to create all datum axes for path having shared edge.

This option is applicable only when SketchAlongPathBuilder::SketchOrientationType is SketchAlongPathBuilder::SketchOrientationTypeRelativeToFace
Created in NX6.0.0.

License requirements : None

Returns the sketch orientation method as SketchAlongPathBuilder::SketchOrientationType
Created in NX6.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.