nxopen.geometricanalysis

Interface HighlightLinesAnalysisBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface HighlightLinesAnalysisBuilder
extends Builder

Represents a 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 AnalysisObjectCollection.createHighlightLinesAnalysisBuilder(nxopen.DisplayableObject)
Default values.

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

Created in NX6.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HighlightLinesAnalysisBuilder.DisplayMethods Deprecated. Deprecated in NX8.0.0. Use nxopen.geometricanalysis.HighlightLinesAnalysisBuilder#types2 instead.
static class	HighlightLinesAnalysisBuilder.LightPlacements light placement
static class	HighlightLinesAnalysisBuilder.LightPlaneOptions light plane options
static class	HighlightLinesAnalysisBuilder.Resolutions resolution options
static class	HighlightLinesAnalysisBuilder.Types Deprecated. Deprecated in NX8.0.0. Use nxopen.geometricanalysis.HighlightLinesAnalysisBuilder#lightPlacements instead.
static class	HighlightLinesAnalysisBuilder.Types2 four types of display methods

Method Summary

Modifier and Type	Method and Description
SelectPointList	betweenPoints() Returns the between points License requirements: None.
HighlightLinesAnalysisBuilder.DisplayMethods	displayMethod() Deprecated. Deprecated in NX8.0.0. Use type2() and setType2(nxopen.geometricanalysis.HighlightLinesAnalysisBuilder.Types2) instead.
Expression	endIsoAngle() Returns the end angle for isoclines (uniform) License requirements: None.
SelectDisplayableObjectList	faces() Returns the face list License requirements: None.
double[]	getBrightColor() Gets the color of the bright (lit) areas of reflection contours License requirements: None.
double[]	getDarkColor() Gets the color of the dark (unlit) areas of reflection contours License requirements: None.
Direction	isoclineVector() Returns the vector to define isoclines License requirements: None.
boolean	isReflectionLocked() Returns the lock reflection.
double	lightDiffuseness() Returns the ratio of blended texels to all light texels.
int	lightNumber() Returns the number of lights.
HighlightLinesAnalysisBuilder.LightPlacements	lightPlacement() Returns the light placement License requirements: None.
Point3d	lightPlaneOrigin() Returns the origin of the light plane License requirements: None.
Vector3d	lightPlaneXAxis() Returns the x-axis of the light plane License requirements: None.
Vector3d	lightPlaneYAxis() Returns the y-axis of the light plane License requirements: None.
double	lightSpacing() Returns the light spacing between two adjacent lights.
double	lightWidth() Returns the ratio of light size to light spacing.
void	reinitializePlane() Deprecated. Deprecated in NX8.0.0. This call currently does not do anything. Calls to this method can be safely removed.
HighlightLinesAnalysisBuilder.Resolutions	resolution() Returns the resolution.
void	setBrightColor(double[] brightColor) Sets the color of the bright (lit) areas of reflection contours License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setDarkColor(double[] darkColor) Sets the color of the dark (unlit) areas of reflection contours License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setDisplayMethod(HighlightLinesAnalysisBuilder.DisplayMethods displayMethod) Deprecated. Deprecated in NX8.0.0. Use type2() and setType2(nxopen.geometricanalysis.HighlightLinesAnalysisBuilder.Types2) instead.
void	setIsoclineVector(Direction isoclineVector) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setLightDiffuseness(double lightDiffuseness) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setLightNumber(int lightNumber) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setLightPlacement(HighlightLinesAnalysisBuilder.LightPlacements placement) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setLightPlaneOrigin(Point3d origin) Sets the origin of the light plane.
void	setLightPlaneXAxis(Vector3d xAxis) Sets the x-axis of the light plane.
void	setLightPlaneYAxis(Vector3d yAxis) Sets the y-axis of the light plane.
void	setLightSpacing(double lightSpacing) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setLightWidth(double lightWidth) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setReflectionLocked(boolean isReflectionLocked) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setResolution(HighlightLinesAnalysisBuilder.Resolutions resolution) License requirements: studio_analyze ("STUDIO ANALYZE") .
void	setType(HighlightLinesAnalysisBuilder.Types type) Deprecated. Deprecated in NX8.0.0. Use lightPlacement() and setLightPlacement(nxopen.geometricanalysis.HighlightLinesAnalysisBuilder.LightPlacements) instead.
void	setType2(HighlightLinesAnalysisBuilder.Types2 type) License requirements: studio_analyze ("STUDIO ANALYZE") .
Expression	startIsoAngle() Returns the start angle for isoclines (uniform) License requirements: None.
SelectPointList	throughPoints() Returns the through points License requirements: None.
HighlightLinesAnalysisBuilder.Types	type() Deprecated. Deprecated in NX8.0.0. Use lightPlacement() and setLightPlacement(nxopen.geometricanalysis.HighlightLinesAnalysisBuilder.LightPlacements) instead.
HighlightLinesAnalysisBuilder.Types2	type2() Returns the display type License requirements: None.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

faces

SelectDisplayableObjectList faces()
                           throws NXException,
                                  RemoteException

Returns the face list
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

throughPoints

SelectPointList throughPoints()
                       throws NXException,
                              RemoteException

Returns the through points
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

betweenPoints

SelectPointList betweenPoints()
                       throws NXException,
                              RemoteException

Returns the between points
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

lightNumber

int lightNumber()
         throws NXException,
                RemoteException

Returns the number of lights. It's used by Uniform type and Between Points type.
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setLightNumber

void setLightNumber(int lightNumber)
             throws NXException,
                    RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX6.0.0

Parameters:

lightNumber -

Throws:

NXException

RemoteException

lightSpacing

double lightSpacing()
             throws NXException,
                    RemoteException

Returns the light spacing between two adjacent lights. It's used by Uniform type
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setLightSpacing

void setLightSpacing(double lightSpacing)
              throws NXException,
                     RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX6.0.0

Parameters:

lightSpacing -

Throws:

NXException

RemoteException

lightWidth

double lightWidth()
           throws NXException,
                  RemoteException

Returns the ratio of light size to light spacing. It is used by reflection contours
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setLightWidth

void setLightWidth(double lightWidth)
            throws NXException,
                   RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

lightWidth -

Throws:

NXException

RemoteException

lightDiffuseness

double lightDiffuseness()
                 throws NXException,
                        RemoteException

Returns the ratio of blended texels to all light texels. It is used by reflection contours
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setLightDiffuseness

void setLightDiffuseness(double lightDiffuseness)
                  throws NXException,
                         RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

lightDiffuseness -

Throws:

NXException

RemoteException

getDarkColor

double[] getDarkColor()
               throws NXException,
                      RemoteException

Gets the color of the dark (unlit) areas of reflection contours
License requirements: None.

Created in NX9.0.0

Returns:

Array of 3 RGB values, each between 0 and 1

Throws:

NXException

RemoteException

setDarkColor

void setDarkColor(double[] darkColor)
           throws NXException,
                  RemoteException

Sets the color of the dark (unlit) areas of reflection contours
License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

darkColor - Array of 3 RGB values, each between 0 and 1

Throws:

NXException

RemoteException

getBrightColor

double[] getBrightColor()
                 throws NXException,
                        RemoteException

Gets the color of the bright (lit) areas of reflection contours
License requirements: None.

Created in NX9.0.0

Returns:

Array of 3 RGB values, each between 0 and 1

Throws:

NXException

RemoteException

setBrightColor

void setBrightColor(double[] brightColor)
             throws NXException,
                    RemoteException

Sets the color of the bright (lit) areas of reflection contours
License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX9.0.0

Parameters:

brightColor - Array of 3 RGB values, each between 0 and 1

Throws:

NXException

RemoteException

startIsoAngle

Expression startIsoAngle()
                  throws NXException,
                         RemoteException

Returns the start angle for isoclines (uniform)
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

endIsoAngle

Expression endIsoAngle()
                throws NXException,
                       RemoteException

Returns the end angle for isoclines (uniform)
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

isoclineVector

Direction isoclineVector()
                  throws NXException,
                         RemoteException

Returns the vector to define isoclines
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setIsoclineVector

void setIsoclineVector(Direction isoclineVector)
                throws NXException,
                       RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX8.5.0

Parameters:

isoclineVector -

Throws:

NXException

RemoteException

reinitializePlane

void reinitializePlane()
                throws NXException,
                       RemoteException

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

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.
License requirements: studio_analyze ("STUDIO ANALYZE")

Created in NX6.0.0

Throws:

NXException

RemoteException

lightPlaneOrigin

Point3d lightPlaneOrigin()
                  throws NXException,
                         RemoteException

Returns the origin of the light plane
License requirements: None.

Created in NX6.0.0

Returns:

coordinates of origin

Throws:

NXException

RemoteException

setLightPlaneOrigin

void setLightPlaneOrigin(Point3d origin)
                  throws NXException,
                         RemoteException

Sets the origin of the light plane.
License requirements: studio_analyze ("STUDIO ANALYZE")

Created in NX6.0.0

Parameters:

origin - coordinates of origin

Throws:

NXException

RemoteException

lightPlaneXAxis

Vector3d lightPlaneXAxis()
                  throws NXException,
                         RemoteException

Returns the x-axis of the light plane
License requirements: None.

Created in NX6.0.0

Returns:

x-axis vector

Throws:

NXException

RemoteException

setLightPlaneXAxis

void setLightPlaneXAxis(Vector3d xAxis)
                 throws NXException,
                        RemoteException

Sets the x-axis of the light plane.
License requirements: studio_analyze ("STUDIO ANALYZE")

Created in NX6.0.0

Parameters:

xAxis - x-axis vector

Throws:

NXException

RemoteException

lightPlaneYAxis

Vector3d lightPlaneYAxis()
                  throws NXException,
                         RemoteException

Returns the y-axis of the light plane
License requirements: None.

Created in NX6.0.0

Returns:

y-axis vector

Throws:

NXException

RemoteException

setLightPlaneYAxis

void setLightPlaneYAxis(Vector3d yAxis)
                 throws NXException,
                        RemoteException

Sets the y-axis of the light plane.
License requirements: studio_analyze ("STUDIO ANALYZE")

Created in NX6.0.0

Parameters:

yAxis - y-axis vector

Throws:

NXException

RemoteException

displayMethod

HighlightLinesAnalysisBuilder.DisplayMethods displayMethod()
                                                    throws NXException,
                                                           RemoteException

Deprecated. Deprecated in NX8.0.0. Use type2() and setType2(nxopen.geometricanalysis.HighlightLinesAnalysisBuilder.Types2) instead.

Returns the display method
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setDisplayMethod

void setDisplayMethod(HighlightLinesAnalysisBuilder.DisplayMethods displayMethod)
               throws NXException,
                      RemoteException

Deprecated. Deprecated in NX8.0.0. Use type2() and setType2(nxopen.geometricanalysis.HighlightLinesAnalysisBuilder.Types2) instead.

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX6.0.0

Parameters:

displayMethod -

Throws:

NXException

RemoteException

isReflectionLocked

boolean isReflectionLocked()
                    throws NXException,
                           RemoteException

Returns 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.
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setReflectionLocked

void setReflectionLocked(boolean isReflectionLocked)
                  throws NXException,
                         RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX6.0.0

Parameters:

isReflectionLocked -

Throws:

NXException

RemoteException

resolution

HighlightLinesAnalysisBuilder.Resolutions resolution()
                                              throws NXException,
                                                     RemoteException

Returns the resolution.
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setResolution

void setResolution(HighlightLinesAnalysisBuilder.Resolutions resolution)
            throws NXException,
                   RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX6.0.0

Parameters:

resolution -

Throws:

NXException

RemoteException

type

HighlightLinesAnalysisBuilder.Types type()
                                  throws NXException,
                                         RemoteException

Deprecated. Deprecated in NX8.0.0. Use lightPlacement() and setLightPlacement(nxopen.geometricanalysis.HighlightLinesAnalysisBuilder.LightPlacements) instead.

Returns the type
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setType

void setType(HighlightLinesAnalysisBuilder.Types type)
      throws NXException,
             RemoteException

Deprecated. Deprecated in NX8.0.0. Use lightPlacement() and setLightPlacement(nxopen.geometricanalysis.HighlightLinesAnalysisBuilder.LightPlacements) instead.

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX6.0.0

Parameters:

type -

Throws:

NXException

RemoteException

lightPlacement

HighlightLinesAnalysisBuilder.LightPlacements lightPlacement()
                                                      throws NXException,
                                                             RemoteException

Returns the light placement
License requirements: None.

Created in NX8.0.0

Throws:

NXException

RemoteException

setLightPlacement

void setLightPlacement(HighlightLinesAnalysisBuilder.LightPlacements placement)
                throws NXException,
                       RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX8.0.0

Parameters:

placement -

Throws:

NXException

RemoteException

type2

HighlightLinesAnalysisBuilder.Types2 type2()
                                    throws NXException,
                                           RemoteException

Returns the display type
License requirements: None.

Created in NX8.0.0

Throws:

NXException

RemoteException

setType2

void setType2(HighlightLinesAnalysisBuilder.Types2 type)
       throws NXException,
              RemoteException

License requirements: studio_analyze ("STUDIO ANALYZE")
.
Created in NX8.0.0

Parameters:

type -

Throws:

NXException

RemoteException