NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | 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 NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  DisplayModes { Fringe, Hedgehog, ContourLines }
 The display type. More...
 

Public Member Functions

unsafe void StartDistanceAnalysis ()
 Start distance analysis. More...
 
unsafe void UpdateDisplayOnPlaneChange ()
 Update display after plane changes. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.GeometricAnalysis.FaceAnalysisDataRangeBuilder 
DataRange [get]
 Returns the distance analysis data range. More...
 
unsafe
NXOpen.GeometricAnalysis.DistanceAnalysisBuilder.DisplayModes 
DisplayMode [get, set]
 Returns or sets the display mode. More...
 
unsafe
NXOpen.GeometricAnalysis.FaceAnalysisDisplayBuilder 
DisplaySettings [get]
 Returns the distance analysis display settings. More...
 
unsafe
NXOpen.SelectDisplayableObjectList 
Faces [get]
 Returns the face to apply distance analysis. More...
 
unsafe
NXOpen.GeometricAnalysis.FaceAnalysisNormalsBuilder 
Normals [get]
 Returns the distance analysis normals. More...
 
unsafe int NumberOfContourLines [get, set]
 Returns or sets the number of contour lines. More...
 
unsafe NXOpen.Plane Plane [get, set]
 Returns or sets the reference plane for distance analysis. More...
 
unsafe double SpikeLength [get, set]
 Returns or sets the spike length. More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> 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
Fringe 

Display in fringe.

Hedgehog 

Display in hedgehog.

ContourLines 

Display in contour lines.

Member Function Documentation

unsafe void NXOpen.GeometricAnalysis.DistanceAnalysisBuilder.StartDistanceAnalysis ( )
inline

Start distance analysis.

Created in NX11.0.0

License requirements: None.

unsafe void NXOpen.GeometricAnalysis.DistanceAnalysisBuilder.UpdateDisplayOnPlaneChange ( )
inline

Update display after plane changes.

Created in NX11.0.0

License requirements: None.

Property Documentation

unsafe NXOpen.GeometricAnalysis.FaceAnalysisDataRangeBuilder NXOpen.GeometricAnalysis.DistanceAnalysisBuilder.DataRange
get

Returns the distance analysis data range.

Created in NX11.0.0

License requirements: None.

unsafe NXOpen.GeometricAnalysis.DistanceAnalysisBuilder.DisplayModes NXOpen.GeometricAnalysis.DistanceAnalysisBuilder.DisplayMode
getset

Returns or sets the display mode.

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.GeometricAnalysis.FaceAnalysisDisplayBuilder NXOpen.GeometricAnalysis.DistanceAnalysisBuilder.DisplaySettings
get

Returns the distance analysis display settings.

Created in NX11.0.0

License requirements: None.

unsafe NXOpen.SelectDisplayableObjectList NXOpen.GeometricAnalysis.DistanceAnalysisBuilder.Faces
get

Returns the face to apply distance analysis.

Created in NX11.0.0

License requirements: None.

unsafe NXOpen.GeometricAnalysis.FaceAnalysisNormalsBuilder NXOpen.GeometricAnalysis.DistanceAnalysisBuilder.Normals
get

Returns the distance analysis normals.

Created in NX11.0.0

License requirements: None.

unsafe int NXOpen.GeometricAnalysis.DistanceAnalysisBuilder.NumberOfContourLines
getset

Returns or sets the number of contour lines.

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Plane NXOpen.GeometricAnalysis.DistanceAnalysisBuilder.Plane
getset

Returns or sets the reference plane for distance analysis.

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.GeometricAnalysis.DistanceAnalysisBuilder.SpikeLength
getset

Returns or sets the spike length.

Created in NX11.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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