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

Represents a Distance Analysis builder. More...

Inheritance diagram for NXOpen::GeometricAnalysis::DistanceAnalysisBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DisplayModes { DisplayModesFringe, DisplayModesHedgehog, DisplayModesContourLines }
 The display type. More...
 

Public Member Functions

NXOpen::GeometricAnalysis::FaceAnalysisDataRangeBuilderDataRange ()
 Returns the distance analysis data range. More...
 
NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::DisplayModes DisplayMode ()
 Returns the display mode. More...
 
NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilderDisplaySettings ()
 Returns the distance analysis display settings. More...
 
NXOpen::SelectDisplayableObjectListFaces ()
 Returns the face to apply distance analysis. More...
 
NXOpen::GeometricAnalysis::FaceAnalysisNormalsBuilderNormals ()
 Returns the distance analysis normals. More...
 
int NumberOfContourLines ()
 Returns the number of contour lines. More...
 
NXOpen::PlanePlane ()
 Returns the reference plane for distance analysis. More...
 
void SetDisplayMode (NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::DisplayModes displayMode)
 Sets the display mode. More...
 
void SetNumberOfContourLines (int numberOfContourLines)
 Sets the number of contour lines. More...
 
void SetPlane (NXOpen::Plane *plane)
 Sets the reference plane for distance analysis. More...
 
void SetSpikeLength (double spikeLength)
 Sets the spike length. More...
 
double SpikeLength ()
 Returns the spike length. More...
 
void StartDistanceAnalysis ()
 Start distance analysis. More...
 
void UpdateDisplayOnPlaneChange ()
 Update display after plane changes. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a Distance Analysis builder.


To create a new instance of this class, use NXOpen::GeometricAnalysis::AnalysisObjectCollectionEx::CreateDistanceAnalysisBuilder
Default values.

Property Value

DataRange.IsFixed

1

DataRange.Max

0.010000

DataRange.Middle

0.000000

DataRange.MiddleScale

0.000000

DataRange.Min

-0.010000

DataRange.ZoomScale

8

DisplayMode

Fringe

DisplaySettings.CanShowFacet

0

DisplaySettings.ColorLegendOption

Blend

DisplaySettings.DisplayResolution.AngleTolerance

15.0

DisplaySettings.DisplayResolution.EdgeTolerance

0.005

DisplaySettings.DisplayResolution.FaceTolerance

0.005

DisplaySettings.DisplayResolution.Resolution

Standard

DisplaySettings.DisplayResolution.WidthTolerance

0.3

DisplaySettings.NumberOfColors

Seven

NumberOfContourLines

8

SpikeLength

25.4 (millimeters part), 1.0 (inches part)


Created in NX11.0.0.

Member Enumeration Documentation

The display type.

Enumerator
DisplayModesFringe 

Display in fringe.

DisplayModesHedgehog 

Display in hedgehog.

DisplayModesContourLines 

Display in contour lines.

Member Function Documentation

NXOpen::GeometricAnalysis::FaceAnalysisDataRangeBuilder* NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::DataRange ( )

Returns the distance analysis data range.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::DisplayModes NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::DisplayMode ( )

Returns the display mode.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder* NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::DisplaySettings ( )

Returns the distance analysis display settings.


Created in NX11.0.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::Faces ( )

Returns the face to apply distance analysis.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::FaceAnalysisNormalsBuilder* NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::Normals ( )

Returns the distance analysis normals.


Created in NX11.0.0.

License requirements : None

int NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::NumberOfContourLines ( )

Returns the number of contour lines.


Created in NX11.0.0.

License requirements : None

NXOpen::Plane* NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::Plane ( )

Returns the reference plane for distance analysis.


Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::SetDisplayMode ( NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::DisplayModes  displayMode)

Sets the display mode.


Created in NX11.0.0.

License requirements : None

Parameters
displayModedisplaymode
void NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::SetNumberOfContourLines ( int  numberOfContourLines)

Sets the number of contour lines.


Created in NX11.0.0.

License requirements : None

Parameters
numberOfContourLinesnumberofcontourlines
void NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::SetPlane ( NXOpen::Plane plane)

Sets the reference plane for distance analysis.


Created in NX11.0.0.

License requirements : None

Parameters
planeplane
void NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::SetSpikeLength ( double  spikeLength)

Sets the spike length.


Created in NX11.0.0.

License requirements : None

Parameters
spikeLengthspikelength
double NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::SpikeLength ( )

Returns the spike length.


Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::StartDistanceAnalysis ( )

Start distance analysis.


Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::DistanceAnalysisBuilder::UpdateDisplayOnPlaneChange ( )

Update display after plane changes.


Created in NX11.0.0.

License requirements : None


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