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

This class represents a offset surface builder, used for creating or editing an offset surface feature. More...

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

List of all members.

Public Types

enum  OrientationMethodType { OrientationMethodTypeUseExistingNormals, OrientationMethodTypeSpecifyInteriorPosition }
 Represents the type of orientation method. More...
enum  OutputOptionType { OutputOptionTypeOneFeatureForConnectedFaces, OutputOptionTypeOneFeatureForEachFace, OutputOptionTypeOneFeatureForAllFaces }
 Represents the type of output option. More...

Public Member Functions

void AddFaceSets (const std::vector< NXOpen::GeometricUtilities::FaceSetOffset * > &faceSets)
 Adds face sets to the face set list This method is deprecated.
bool ApproxOption ()
 Returns the option to create approximate offset surface if the offset surface has self-intersections.
void DeleteFaceSet (int index)
 Deletes a face set at the specified index from the face set list This method is deprecated.
NXOpen::GeometricUtilities::FaceSetOffsetListFaceSets ()
 Returns the list of face sets.
NXOpen::GeometricUtilities::FaceSetOffsetFindFaceSet (int index)
 Finds and returns a face set at the specified index from the face set list This method is deprecated.
NXOpen::ObjectListGetFaceSetList ()
 Gets the list of face sets.
std::vector
< NXOpen::GeometricUtilities::FaceSetOffset * > 
GetFaceSets ()
 Gets the face sets.
NXOpen::Point3d GetInteriorPosition ()
 Gets the offset surface interior position for specify interior position method.
NXOpen::Features::OffsetSurfaceBuilder::OrientationMethodType GetOrientationMethod ()
 Returns the offset surface orientation method based on the Features::OffsetSurfaceBuilder::OutputOptionType.
int MaximumExcludedObjects ()
 Returns the maximum excluded objects during partial offset.
NXOpen::Features::OffsetSurfaceBuilder::OutputOptionType OutputOption ()
 Returns the offset surface output option based on the enum Features::OffsetSurfaceBuilder::OutputOptionType.
bool PartialOption ()
 Returns the option to pursue a partial offset result.
NXOpen::ExpressionRadius ()
 Returns the radius for error vertex excision during partial offset.
bool RemoveProblemVerticesOption ()
 Returns the option to remove problem vertices.
void SetApproxOption (bool approxOption)
 Sets the option to create approximate offset surface if the offset surface has self-intersections.
void SetInteriorPosition (const NXOpen::Point3d &point)
 Sets the offset surface interior position for specify interior position method.
void SetMaximumExcludedObjects (int maximumExcludedObjects)
 Sets the maximum excluded objects during partial offset.
void SetOrientationMethod (NXOpen::Features::OffsetSurfaceBuilder::OrientationMethodType orientationMethod)
 Sets the orientation method
Created in NX4.0.0.
void SetOutputOption (NXOpen::Features::OffsetSurfaceBuilder::OutputOptionType outputOption)
 Sets the offset surface output option based on the enum Features::OffsetSurfaceBuilder::OutputOptionType.
void SetPartialOption (bool partialOption)
 Sets the option to pursue a partial offset result.
void SetRemoveProblemVerticesOption (bool removeProblemVerticesOption)
 Sets the option to remove problem vertices.
void SetStepOption (bool stepOption)
 Sets the offset surface allow step boundaries option.
void SetTolerance (double tolerance)
 Sets the offset surface tolerance.
bool StepOption ()
 Returns the offset surface allow step boundaries option.
double Tolerance ()
 Returns the offset surface tolerance.

Detailed Description

This class represents a offset surface builder, used for creating or editing an offset surface feature.

The offset surface feature allows different face sets to be offset by different distances.
To create a new instance of this class, use Features::FeatureCollection::CreateOffsetSurfaceBuilder
Default values.

Property Value

ApproxOption

False

OutputOption

OneFeatureForConnectedFaces

PartialOption

False

StepOption

True


Created in NX4.0.0.


Member Enumeration Documentation

Represents the type of orientation method.

This is applicable only if the output output is Features::OffsetSurfaceBuilder::OutputOptionTypeOneFeatureForEachFace . The first enum value implies that the offset direction will be that of the surface normal whereas the second enum value implies that am interior position will be specified and the offset direction will be away from this point

Enumerator:
OrientationMethodTypeUseExistingNormals 

use existing normals

OrientationMethodTypeSpecifyInteriorPosition 

specify interior position

Represents the type of output option.

The faces to be offset can be disconnected and also from multiple bodies. If either is the case, then multiple features are created. For deciding whether there should be one feature for each topologically connected set of faces or one feature for each face selected the enum below has been provided

Enumerator:
OutputOptionTypeOneFeatureForConnectedFaces 

one feature for connected faces

OutputOptionTypeOneFeatureForEachFace 

one feature for each face

OutputOptionTypeOneFeatureForAllFaces 

one feature for all faces


Member Function Documentation

Adds face sets to the face set list This method is deprecated.

Please use FaceSets instead.


Deprecated:
Deprecated in NX5.0.0.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
faceSetsFace set list

Returns the option to create approximate offset surface if the offset surface has self-intersections.


Created in NX4.0.0.

License requirements : None

Deletes a face set at the specified index from the face set list This method is deprecated.

Please use FaceSets instead.


Deprecated:
Deprecated in NX5.0.0.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
indexIndex of face set to be deleted

Returns the list of face sets.

Each element defines a set of faces, and an offset distance applied to those faces.


Created in NX4.0.0.

License requirements : None

Finds and returns a face set at the specified index from the face set list This method is deprecated.

Please use FaceSets instead.

Returns:
Face set returned
Deprecated:
Deprecated in NX5.0.0.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
indexIndex of face set to be returned

Gets the list of face sets.

This list is a simple variable length array of any JA object. This method is deprecated. Please use FaceSets instead.

Returns:
Face set list
Deprecated:
Deprecated in NX5.0.0.


Created in NX4.0.0.

License requirements : None

Gets the face sets.

A face set is a combination of a face collector and an offset distance. This method is deprecated. Please use FaceSets instead.

Returns:
Face set list
Deprecated:
Deprecated in NX5.0.0.


Created in NX4.0.0.

License requirements : None

Gets the offset surface interior position for specify interior position method.

Returns:
Interior position for specify interior position method
Created in NX4.0.0.

License requirements : None

Returns the offset surface orientation method based on the Features::OffsetSurfaceBuilder::OutputOptionType.

Returns:
Orientation method
Created in NX4.0.0.

License requirements : None

Returns the maximum excluded objects during partial offset.

If the excluded objects reach this number, the partial offset will stop.


Created in NX7.5.0.

License requirements : None

Returns the offset surface output option based on the enum Features::OffsetSurfaceBuilder::OutputOptionType.


Created in NX4.0.0.

License requirements : None

Returns the option to pursue a partial offset result.


Created in NX7.5.0.

License requirements : None

Returns the radius for error vertex excision during partial offset.


Created in NX7.5.0.

License requirements : None

Returns the option to remove problem vertices.


Created in NX7.5.0.

License requirements : None

Sets the option to create approximate offset surface if the offset surface has self-intersections.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
approxOptionApproximate offset option

Sets the offset surface interior position for specify interior position method.

This allows the specified faces to be offset away from the interior position.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
pointInterior position for specify interior position method

Sets the maximum excluded objects during partial offset.

If the excluded objects reach this number, the partial offset will stop.


Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
maximumExcludedObjectsMaximum excluded objects

Sets the orientation method
Created in NX4.0.0.



License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
orientationMethodOrientation method

Sets the offset surface output option based on the enum Features::OffsetSurfaceBuilder::OutputOptionType.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
outputOptionOutput option

Sets the option to pursue a partial offset result.


Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
partialOptionpartialoption

Sets the option to remove problem vertices.


Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
removeProblemVerticesOptionremoveproblemverticesoption

Sets the offset surface allow step boundaries option.

If this option is true then side faces will be created along any smooth edge between a face which is offset and one which is not.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
stepOptionAllow step boundaries option

Sets the offset surface tolerance.


Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
toleranceTolerance

Returns the offset surface allow step boundaries option.

If this option is true then side faces will be created along any smooth edge between a face which is offset and one which is not.


Created in NX4.0.0.

License requirements : None

Returns the offset surface tolerance.


Created in NX4.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.