HighlightLinesAnalysisBuilder Class

class NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder

Bases: NXOpen.Builder

Represents a NXOpen.GeometricAnalysis.HighlightLinesAnalysis builder.

Highlight Lines Analysis function can produce both reflection lines and projection lines which are used to evaluate the surface quality and continuity between adjacent surfaces.

To create a new instance of this class, use NXOpen.GeometricAnalysis.AnalysisObjectCollection.CreateHighlightLinesAnalysisBuilder()

Default values.

Property Value
EndIsoAngle.Value 90
LightNumber 10
LightSpacing 50.0 (millimeters part), 2.0 (inches part)
Resolution Fine
StartIsoAngle.Value -90

New in version NX6.0.0.

Properties

Property Description
BetweenPoints Returns the between points
DisplayMethod Returns or sets the display method
EndIsoAngle Returns the end angle for isoclines (uniform)
Faces Returns the face list
IsReflectionLocked Returns or sets the lock reflection.
IsoclineVector Returns or sets the vector to define isoclines
LightDiffuseness Returns or sets the ratio of blended texels to all light texels.
LightNumber Returns or sets the number of lights.
LightPlacement Returns or sets the light placement
LightPlaneOrigin Returns the origin of the light plane
LightPlaneXAxis Returns the x-axis of the light plane
LightPlaneYAxis Returns the y-axis of the light plane
LightSpacing Returns or sets the light spacing between two adjacent lights.
LightWidth Returns or sets the ratio of light size to light spacing.
Resolution Returns or sets the resolution.
StartIsoAngle Returns the start angle for isoclines (uniform)
Tag Returns the Tag for this object.
ThroughPoints Returns the through points
Type Returns or sets the type
Type2 Returns or sets the display 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.
GetBrightColor Gets the color of the bright (lit) areas of reflection contours
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetDarkColor Gets the color of the dark (unlit) areas of reflection contours
GetObject Returns the object currently being edited by this builder.
ReinitializePlane Reinitialize light plane based on the selected faces.
SetBrightColor Sets the color of the bright (lit) areas of reflection contours
SetDarkColor Sets the color of the dark (unlit) areas of reflection contours
SetLightPlaneOrigin Sets the origin of the light plane.
SetLightPlaneXAxis Sets the x-axis of the light plane.
SetLightPlaneYAxis Sets the y-axis of the light plane.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

BetweenPoints

HighlightLinesAnalysisBuilder.BetweenPoints

Returns the between points

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

Getter Method

Signature BetweenPoints

Returns:
Return type:NXOpen.SelectPointList

New in version NX6.0.0.

License requirements: None.

DisplayMethod

HighlightLinesAnalysisBuilder.DisplayMethod

Returns or sets the display method

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

Getter Method

Signature DisplayMethod

Returns:
Return type:NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilderDisplayMethods

New in version NX6.0.0.

Deprecated since version NX8.0.0: Use NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Type2`() instead.

License requirements: None.

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

Setter Method

Signature DisplayMethod

Parameters:displayMethod (NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilderDisplayMethods) –

New in version NX6.0.0.

Deprecated since version NX8.0.0: Use NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Type2`() instead.

License requirements: studio_analyze (“STUDIO ANALYZE”)

EndIsoAngle

HighlightLinesAnalysisBuilder.EndIsoAngle

Returns the end angle for isoclines (uniform)

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

Getter Method

Signature EndIsoAngle

Returns:
Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: None.

Faces

HighlightLinesAnalysisBuilder.Faces

Returns the face list

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

Getter Method

Signature Faces

Returns:
Return type:NXOpen.SelectDisplayableObjectList

New in version NX6.0.0.

License requirements: None.

IsReflectionLocked

HighlightLinesAnalysisBuilder.IsReflectionLocked

Returns or sets the lock reflection.

When the lock is on, the reflection lines will be freezed while the view is changing. Otherwise, the reflection lines will be updated continuously while view is changing.

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

Getter Method

Signature IsReflectionLocked

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature IsReflectionLocked

Parameters:isReflectionLocked (bool) –

New in version NX6.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

IsoclineVector

HighlightLinesAnalysisBuilder.IsoclineVector

Returns or sets the vector to define isoclines

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

Getter Method

Signature IsoclineVector

Returns:
Return type:NXOpen.Direction

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature IsoclineVector

Parameters:isoclineVector (NXOpen.Direction) –

New in version NX8.5.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

LightDiffuseness

HighlightLinesAnalysisBuilder.LightDiffuseness

Returns or sets the ratio of blended texels to all light texels.

It is used by reflection contours

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

Getter Method

Signature LightDiffuseness

Returns:
Return type:float

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature LightDiffuseness

Parameters:lightDiffuseness (float) –

New in version NX9.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

LightNumber

HighlightLinesAnalysisBuilder.LightNumber

Returns or sets the number of lights.

It’s used by Uniform type and Between Points type.

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

Getter Method

Signature LightNumber

Returns:
Return type:int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature LightNumber

Parameters:lightNumber (int) –

New in version NX6.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

LightPlacement

HighlightLinesAnalysisBuilder.LightPlacement

Returns or sets the light placement

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

Getter Method

Signature LightPlacement

Returns:
Return type:NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilderLightPlacements

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature LightPlacement

Parameters:placement (NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilderLightPlacements) –

New in version NX8.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

LightPlaneOrigin

HighlightLinesAnalysisBuilder.LightPlaneOrigin

Returns the origin of the light plane

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

Getter Method

Signature LightPlaneOrigin

Returns:coordinates of origin
Return type:NXOpen.Point3d

New in version NX6.0.0.

License requirements: None.

LightPlaneXAxis

HighlightLinesAnalysisBuilder.LightPlaneXAxis

Returns the x-axis of the light plane

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

Getter Method

Signature LightPlaneXAxis

Returns:x-axis vector
Return type:NXOpen.Vector3d

New in version NX6.0.0.

License requirements: None.

LightPlaneYAxis

HighlightLinesAnalysisBuilder.LightPlaneYAxis

Returns the y-axis of the light plane

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

Getter Method

Signature LightPlaneYAxis

Returns:y-axis vector
Return type:NXOpen.Vector3d

New in version NX6.0.0.

License requirements: None.

LightSpacing

HighlightLinesAnalysisBuilder.LightSpacing

Returns or sets the light spacing between two adjacent lights.

It’s used by Uniform type

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

Getter Method

Signature LightSpacing

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature LightSpacing

Parameters:lightSpacing (float) –

New in version NX6.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

LightWidth

HighlightLinesAnalysisBuilder.LightWidth

Returns or sets the ratio of light size to light spacing.

It is used by reflection contours

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

Getter Method

Signature LightWidth

Returns:
Return type:float

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature LightWidth

Parameters:lightWidth (float) –

New in version NX9.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

Resolution

HighlightLinesAnalysisBuilder.Resolution

Returns or sets the resolution.

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

Getter Method

Signature Resolution

Returns:
Return type:NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilderResolutions

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Resolution

Parameters:resolution (NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilderResolutions) –

New in version NX6.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

StartIsoAngle

HighlightLinesAnalysisBuilder.StartIsoAngle

Returns the start angle for isoclines (uniform)

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

Getter Method

Signature StartIsoAngle

Returns:
Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: None.

ThroughPoints

HighlightLinesAnalysisBuilder.ThroughPoints

Returns the through points

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

Getter Method

Signature ThroughPoints

Returns:
Return type:NXOpen.SelectPointList

New in version NX6.0.0.

License requirements: None.

Type

HighlightLinesAnalysisBuilder.Type

Returns or sets the type

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

Getter Method

Signature Type

Returns:
Return type:NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilderTypes

New in version NX6.0.0.

Deprecated since version NX8.0.0: Use NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightPlacement`() instead.

License requirements: None.

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

Setter Method

Signature Type

Parameters:type (NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilderTypes) –

New in version NX6.0.0.

Deprecated since version NX8.0.0: Use NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightPlacement`() instead.

License requirements: studio_analyze (“STUDIO ANALYZE”)

Type2

HighlightLinesAnalysisBuilder.Type2

Returns or sets the display type

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

Getter Method

Signature Type2

Returns:
Return type:NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilderTypes2

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Type2

Parameters:type (NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilderTypes2) –

New in version NX8.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

Method Detail

GetBrightColor

HighlightLinesAnalysisBuilder.GetBrightColor

Gets the color of the bright (lit) areas of reflection contours

Signature GetBrightColor()

Returns:Array of 3 RGB values, each between 0 and 1
Return type:list of float

New in version NX9.0.0.

License requirements: None.

GetDarkColor

HighlightLinesAnalysisBuilder.GetDarkColor

Gets the color of the dark (unlit) areas of reflection contours

Signature GetDarkColor()

Returns:Array of 3 RGB values, each between 0 and 1
Return type:list of float

New in version NX9.0.0.

License requirements: None.

ReinitializePlane

HighlightLinesAnalysisBuilder.ReinitializePlane

Reinitialize light plane based on the selected faces.

If more faces are selected, you may need to change light plane, so the light plane could be better centered.

Signature ReinitializePlane()

New in version NX6.0.0.

Deprecated since version NX8.0.0: This call currently does not do anything. Calls to this method can be safely removed.

License requirements: studio_analyze (“STUDIO ANALYZE”)

SetBrightColor

HighlightLinesAnalysisBuilder.SetBrightColor

Sets the color of the bright (lit) areas of reflection contours

Signature SetBrightColor(brightColor)

Parameters:brightColor (list of float) – Array of 3 RGB values, each between 0 and 1

New in version NX9.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

SetDarkColor

HighlightLinesAnalysisBuilder.SetDarkColor

Sets the color of the dark (unlit) areas of reflection contours

Signature SetDarkColor(darkColor)

Parameters:darkColor (list of float) – Array of 3 RGB values, each between 0 and 1

New in version NX9.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

SetLightPlaneOrigin

HighlightLinesAnalysisBuilder.SetLightPlaneOrigin

Sets the origin of the light plane.

Signature SetLightPlaneOrigin(origin)

Parameters:origin (NXOpen.Point3d) – coordinates of origin

New in version NX6.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

SetLightPlaneXAxis

HighlightLinesAnalysisBuilder.SetLightPlaneXAxis

Sets the x-axis of the light plane.

Signature SetLightPlaneXAxis(xAxis)

Parameters:xAxis (NXOpen.Vector3d) – x-axis vector

New in version NX6.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

SetLightPlaneYAxis

HighlightLinesAnalysisBuilder.SetLightPlaneYAxis

Sets the y-axis of the light plane.

Signature SetLightPlaneYAxis(yAxis)

Parameters:yAxis (NXOpen.Vector3d) – y-axis vector

New in version NX6.0.0.

License requirements: studio_analyze (“STUDIO ANALYZE”)

Validate

HighlightLinesAnalysisBuilder.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.