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

Represents a Radius Analysis builder. More...

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

Public Types

enum  DisplayModes { DisplayModesFringe, DisplayModesHedgehog, DisplayModesContourLines }
 The display type. More...
 
enum  Types {
  TypesGaussian, TypesMinimum, TypesMaximum, TypesMean,
  TypesNormal, TypesSectional, TypesU, TypesV
}
 Represents the radius type. More...
 

Public Member Functions

NXOpen::GeometricAnalysis::FaceAnalysisDataRangeBuilderDataRange ()
 Returns the radius analysis data range. More...
 
NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::DisplayModes DisplayMode ()
 Returns the display mode. More...
 
NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilderDisplaySettings ()
 Returns the radius analysis display settings. More...
 
NXOpen::SelectDisplayableObjectListFaces ()
 Returns the face to apply radius analysis. More...
 
NXOpen::GeometricAnalysis::FaceAnalysisNormalsBuilderNormals ()
 Returns the radius analysis normals. More...
 
int NumberOfContourLines ()
 Returns the number of contour lines. More...
 
NXOpen::PlanePlane ()
 Returns the reference plane used for NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::TypesSectional . More...
 
void SetDisplayMode (NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::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 used for NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::TypesSectional . More...
 
void SetSpikeLength (double spikeLength)
 Sets the spike length. More...
 
void SetType (NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::Types type)
 Sets the radius type. More...
 
void SetVector (NXOpen::Direction *vector)
 Sets the reference vector for NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::TypesNormal . More...
 
double SpikeLength ()
 Returns the spike length. More...
 
void StartRadiusAnalysis ()
 Start radius analysis. More...
 
NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::Types Type ()
 Returns the radius type. More...
 
void UpdateDisplayOnPlaneChange ()
 Update display after plane changes. More...
 
NXOpen::DirectionVector ()
 Returns the reference vector for NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::TypesNormal . 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 Radius Analysis builder.


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

Property Value

DataRange.IsFixed

1

DataRange.Max

0.01

DataRange.Middle

0.00001

DataRange.MiddleScale

999999

DataRange.Min

-0.01

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.

Represents the radius type.

Enumerator
TypesGaussian 

Gaussian radius.

TypesMinimum 

Minimum radius.

TypesMaximum 

Maximum radius.

TypesMean 

Mean radius.

TypesNormal 

Normal radius.

TypesSectional 

Sectional radius.

TypesU 

Radius in U direction.

TypesV 

Radius in V direction.

Member Function Documentation

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

Returns the radius analysis data range.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::DisplayModes NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::DisplayMode ( )

Returns the display mode.


Created in NX11.0.0.

License requirements : None

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

Returns the radius analysis display settings.


Created in NX11.0.0.

License requirements : None

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

Returns the face to apply radius analysis.


Created in NX11.0.0.

License requirements : None

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

Returns the radius analysis normals.


Created in NX11.0.0.

License requirements : None

int NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::NumberOfContourLines ( )

Returns the number of contour lines.


Created in NX11.0.0.

License requirements : None

NXOpen::Plane* NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::Plane ( )

Returns the reference plane used for NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::TypesSectional .


Created in NX11.0.0.

License requirements : None

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

Sets the display mode.


Created in NX11.0.0.

License requirements : None

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

Sets the number of contour lines.


Created in NX11.0.0.

License requirements : None

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

Sets the reference plane used for NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::TypesSectional .


Created in NX11.0.0.

License requirements : None

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

Sets the spike length.


Created in NX11.0.0.

License requirements : None

Parameters
spikeLengthspikelength
void NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::SetType ( NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::Types  type)

Sets the radius type.


Created in NX11.0.0.

License requirements : None

Parameters
typetype
void NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::SetVector ( NXOpen::Direction vector)

Sets the reference vector for NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::TypesNormal .


Created in NX11.0.0.

License requirements : None

Parameters
vectorvector
double NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::SpikeLength ( )

Returns the spike length.


Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::StartRadiusAnalysis ( )

Start radius analysis.


Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::Types NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::Type ( )

Returns the radius type.


Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::UpdateDisplayOnPlaneChange ( )

Update display after plane changes.


Created in NX11.0.0.

License requirements : None

NXOpen::Direction* NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::Vector ( )

Returns the reference vector for NXOpen::GeometricAnalysis::RadiusAnalysisBuilder::TypesNormal .


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.