ReflectionAnalysisBuilder Class

class NXOpen.GeometricAnalysis.ReflectionAnalysisBuilder

Bases: NXOpen.Builder

Represents a Reflection Analysis builder.

To create a new instance of this class, use NXOpen.GeometricAnalysis.AnalysisObjectCollectionEx.CreateReflectionAnalysisBuilder()

Default values.

Property Value
DisplayResolution.AngleTolerance 15.0
DisplayResolution.EdgeTolerance 0.005
DisplayResolution.FaceTolerance 0.005
DisplayResolution.Resolution Standard
DisplayResolution.WidthTolerance 0.3
FaceReflectivityScale 100
ImagePosition 0
LineNumber ThirtyTwo
ShowFacetEdge 0

New in version NX11.0.0.

Properties

Property Description
DisplayResolution Returns the display resolution.
FaceReflectivityScale Returns or sets the face reflectivity scale from 0 to 100.
Faces Returns the face to apply reflection analysis.
FileName Returns or sets the file browser.
ImageMovementType Returns or sets the orientation to move reflection lines.
ImagePosition Returns or sets the moving image scale.
ImageSizeSetting Returns or sets the image size setting.
LineImageType Returns or sets the image type.
LineNumber Returns or sets the reflection line number.
LineOrientation Returns or sets the reflection line orientation.
LineThickness Returns or sets the reflection line thickness.
Normals Returns the reflection analysis normals.
SceneImageOption Returns or sets the scene image option.
ShowFacetEdge Returns or sets the flag indicating if facet edges should be shown.
Tag Returns the Tag for this object.
Type Returns or sets the reflection analysis type.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
StartReflectionAnalysis Start reflection analysis.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

DisplayResolution

ReflectionAnalysisBuilder.DisplayResolution

Returns the display resolution.

-------------------------------------

Getter Method

Signature DisplayResolution

Returns:
Return type:NXOpen.GeometricUtilities.DisplayResolutionBuilder

New in version NX11.0.0.

License requirements: None.

FaceReflectivityScale

ReflectionAnalysisBuilder.FaceReflectivityScale

Returns or sets the face reflectivity scale from 0 to 100.

-------------------------------------

Getter Method

Signature FaceReflectivityScale

Returns:
Return type:int

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FaceReflectivityScale

Parameters:faceReflectivityScale (int) –

New in version NX11.0.0.

License requirements: None.

Faces

ReflectionAnalysisBuilder.Faces

Returns the face to apply reflection analysis.

-------------------------------------

Getter Method

Signature Faces

Returns:
Return type:NXOpen.SelectDisplayableObjectList

New in version NX11.0.0.

License requirements: None.

FileName

ReflectionAnalysisBuilder.FileName

Returns or sets the file browser.

-------------------------------------

Getter Method

Signature FileName

Returns:
Return type:str

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FileName

Parameters:filename (str) –

New in version NX11.0.0.

License requirements: None.

ImageMovementType

ReflectionAnalysisBuilder.ImageMovementType

Returns or sets the orientation to move reflection lines.

-------------------------------------

Getter Method

Signature ImageMovementType

Returns:
Return type:NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderImageMovementTypes

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ImageMovementType

Parameters:imageMovementType (NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderImageMovementTypes) –

New in version NX11.0.0.

License requirements: None.

ImagePosition

ReflectionAnalysisBuilder.ImagePosition

Returns or sets the moving image scale.

-------------------------------------

Getter Method

Signature ImagePosition

Returns:
Return type:int

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ImagePosition

Parameters:imagePosition (int) –

New in version NX11.0.0.

License requirements: None.

ImageSizeSetting

ReflectionAnalysisBuilder.ImageSizeSetting

Returns or sets the image size setting.

-------------------------------------

Getter Method

Signature ImageSizeSetting

Returns:
Return type:NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderImageSizeOption

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ImageSizeSetting

Parameters:imageSizeSetting (NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderImageSizeOption) –

New in version NX11.0.0.

License requirements: None.

LineImageType

ReflectionAnalysisBuilder.LineImageType

Returns or sets the image type.

-------------------------------------

Getter Method

Signature LineImageType

Returns:
Return type:NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderLineImageTypes

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LineImageType

Parameters:lineImageType (NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderLineImageTypes) –

New in version NX11.0.0.

License requirements: None.

LineNumber

ReflectionAnalysisBuilder.LineNumber

Returns or sets the reflection line number.

-------------------------------------

Getter Method

Signature LineNumber

Returns:
Return type:NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderNumberOfLinesOptions

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LineNumber

Parameters:lineNumber (NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderNumberOfLinesOptions) –

New in version NX11.0.0.

License requirements: None.

LineOrientation

ReflectionAnalysisBuilder.LineOrientation

Returns or sets the reflection line orientation.

-------------------------------------

Getter Method

Signature LineOrientation

Returns:
Return type:NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderLineOrientationType

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LineOrientation

Parameters:lineOrientation (NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderLineOrientationType) –

New in version NX11.0.0.

License requirements: None.

LineThickness

ReflectionAnalysisBuilder.LineThickness

Returns or sets the reflection line thickness.

-------------------------------------

Getter Method

Signature LineThickness

Returns:
Return type:NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderLineThicknessType

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LineThickness

Parameters:lineThickness (NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderLineThicknessType) –

New in version NX11.0.0.

License requirements: None.

Normals

ReflectionAnalysisBuilder.Normals

Returns the reflection analysis normals.

-------------------------------------

Getter Method

Signature Normals

Returns:
Return type:NXOpen.GeometricAnalysis.FaceAnalysisNormalsBuilder

New in version NX11.0.0.

License requirements: None.

SceneImageOption

ReflectionAnalysisBuilder.SceneImageOption

Returns or sets the scene image option.

-------------------------------------

Getter Method

Signature SceneImageOption

Returns:
Return type:NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderSceneImageType

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SceneImageOption

Parameters:sceneImageOption (NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderSceneImageType) –

New in version NX11.0.0.

License requirements: None.

ShowFacetEdge

ReflectionAnalysisBuilder.ShowFacetEdge

Returns or sets the flag indicating if facet edges should be shown.

-------------------------------------

Getter Method

Signature ShowFacetEdge

Returns:
Return type:bool

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowFacetEdge

Parameters:showFacetEdge (bool) –

New in version NX11.0.0.

License requirements: None.

Type

ReflectionAnalysisBuilder.Type

Returns or sets the reflection analysis type.

-------------------------------------

Getter Method

Signature Type

Returns:
Return type:NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderTypes

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Type

Parameters:type (NXOpen.GeometricAnalysis.ReflectionAnalysisBuilderTypes) –

New in version NX11.0.0.

License requirements: None.

Method Detail

StartReflectionAnalysis

ReflectionAnalysisBuilder.StartReflectionAnalysis

Start reflection analysis.

Signature StartReflectionAnalysis()

New in version NX11.0.0.

License requirements: None.

Validate

ReflectionAnalysisBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.