Represents a NXOpen.GeometricAnalysis.HighlightLinesAnalysis builder. More...

Inheritance diagram for NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder:

Public Types
enum	DisplayMethods { Reflection, Projection }
	display methods More...

enum	LightPlacements { Uniform, ThroughPoints, BetweenPoints }
	light placement More...

enum	LightPlaneOptions { YZ, ZX, XY, Arbitrary }
	light plane options More...

enum	Resolutions { Coarse, Standard, Fine, ExtraFine, SuperFine, UltraFine }
	resolution options More...

enum	Types { Uniform, ThroughPoints, BetweenPoints }
	three types of light methods More...

enum	Types2 { Reflection, Projection, Isoclines, Zebra }
	four types of display methods More...

Public Member Functions
unsafe double[]	GetBrightColor ()
	Gets the color of the bright (lit) areas of reflection contours More...

unsafe double[]	GetDarkColor ()
	Gets the color of the dark (unlit) areas of reflection contours More...

unsafe void	ReinitializePlane ()
	Reinitialize light plane based on the selected faces. More...

unsafe void	SetBrightColor (double[] brightColor)
	Sets the color of the bright (lit) areas of reflection contours More...

unsafe void	SetDarkColor (double[] darkColor)
	Sets the color of the dark (unlit) areas of reflection contours More...

unsafe void	SetLightPlaneOrigin (NXOpen.Point3d origin)
	Sets the origin of the light plane. More...

unsafe void	SetLightPlaneXAxis (NXOpen.Vector3d xAxis)
	Sets the x-axis of the light plane. More...

unsafe void	SetLightPlaneYAxis (NXOpen.Vector3d yAxis)
	Sets the y-axis of the light plane. 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.SelectPointList	BetweenPoints `[get]`
	Returns the between points More...

unsafe NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.DisplayMethods	DisplayMethod `[get, set]`
	Returns or sets the display method More...

unsafe NXOpen.Expression	EndIsoAngle `[get]`
	Returns the end angle for isoclines (uniform) More...

unsafe NXOpen.SelectDisplayableObjectList	Faces `[get]`
	Returns the face list More...

unsafe NXOpen.Direction	IsoclineVector `[get, set]`
	Returns or sets the vector to define isoclines More...

unsafe bool	IsReflectionLocked `[get, set]`
	Returns or sets the lock reflection. More...

unsafe double	LightDiffuseness `[get, set]`
	Returns or sets the ratio of blended texels to all light texels. More...

unsafe int	LightNumber `[get, set]`
	Returns or sets the number of lights. More...

unsafe NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightPlacements	LightPlacement `[get, set]`
	Returns or sets the light placement More...

unsafe NXOpen.Point3d	LightPlaneOrigin `[get]`
	Returns the origin of the light plane More...

unsafe NXOpen.Vector3d	LightPlaneXAxis `[get]`
	Returns the x-axis of the light plane More...

unsafe NXOpen.Vector3d	LightPlaneYAxis `[get]`
	Returns the y-axis of the light plane More...

unsafe double	LightSpacing `[get, set]`
	Returns or sets the light spacing between two adjacent lights. More...

unsafe double	LightWidth `[get, set]`
	Returns or sets the ratio of light size to light spacing. More...

unsafe NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Resolutions	Resolution `[get, set]`
	Returns or sets the resolution. More...

unsafe NXOpen.Expression	StartIsoAngle `[get]`
	Returns the start angle for isoclines (uniform) More...

unsafe NXOpen.SelectPointList	ThroughPoints `[get]`
	Returns the through points More...

unsafe NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Types	Type `[get, set]`
	Returns or sets the type More...

unsafe NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Types2	Type2 `[get, set]`
	Returns or sets the display type 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 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

Created in NX6.0.0

Member Enumeration Documentation

enum NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.DisplayMethods

display methods

Enumerator
Reflection	Create reflection lines
Projection	Create projection lines

enum NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightPlacements

light placement

Enumerator

Uniform

Uniform: Lights are placed uniformly on light plane

ThroughPoints

Through Points: A highlight line is guaranteed to pass through a surface point.

BetweenPoints

Between Points: Two highlight lines are guaranteed to pass through two given surface points.

More highlight lines are created between these two highlight lines when light number is more than two.

enum NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightPlaneOptions

light plane options

Enumerator
YZ	Uses YC-ZC plane as light plane
ZX	Uses XC-ZC plane as light plane
XY	Uses XC-YC plane as light plane
Arbitrary	Uses an arbitrary plane as light plane

enum NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Resolutions

resolution options

Enumerator
Coarse	Coarse
Standard	Standard
Fine	Fine
ExtraFine	Extra Fine
SuperFine	Super Fine
UltraFine	Ultra Fine

enum NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Types

three types of light methods

Enumerator

Uniform

Uniform: Lights are placed uniformly on light plane

ThroughPoints

Through Points: A highlight line is guaranteed to pass through a surface point.

BetweenPoints

Between Points: Two highlight lines are guaranteed to pass through two given surface points.

More highlight lines are created between these two highlight lines when light number is more than two.

enum NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Types2

four types of display methods

Enumerator
Reflection	Create reflection lines
Projection	Create projection lines
Isoclines	Create isoclines
Zebra	Create zebra contour lines

Member Function Documentation

unsafe double [] NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.GetBrightColor ( )

inline

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

Created in NX9.0.0

License requirements: None.

Returns: Array of 3 RGB values, each between 0 and 1

unsafe double [] NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.GetDarkColor ( )

inline

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

Created in NX9.0.0

License requirements: None.

Returns: Array of 3 RGB values, each between 0 and 1

unsafe void NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.ReinitializePlane ( )

inline

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.

Created in NX6.0.0

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

License requirements: studio_analyze ("STUDIO ANALYZE")

unsafe void NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.SetBrightColor ( double[] brightColor )

inline

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

Created in NX9.0.0

License requirements: studio_analyze ("STUDIO ANALYZE")

Parameters

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

unsafe void NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.SetDarkColor ( double[] darkColor )

inline

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

Created in NX9.0.0

License requirements: studio_analyze ("STUDIO ANALYZE")

Parameters

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

unsafe void NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.SetLightPlaneOrigin ( NXOpen.Point3d origin )

inline

Sets the origin of the light plane.

Created in NX6.0.0

License requirements: studio_analyze ("STUDIO ANALYZE")

Parameters

origin coordinates of origin

unsafe void NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.SetLightPlaneXAxis ( NXOpen.Vector3d xAxis )

inline

Sets the x-axis of the light plane.

Created in NX6.0.0

License requirements: studio_analyze ("STUDIO ANALYZE")

Parameters

xAxis x-axis vector

unsafe void NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.SetLightPlaneYAxis ( NXOpen.Vector3d yAxis )

inline

Sets the y-axis of the light plane.

Created in NX6.0.0

License requirements: studio_analyze ("STUDIO ANALYZE")

Parameters

yAxis y-axis vector

Property Documentation

unsafe NXOpen.SelectPointList NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.BetweenPoints

get

Returns the between points

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.DisplayMethods NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.DisplayMethod

getset

Returns or sets the display method

Created in NX6.0.0

Deprecated in NX8.0.0. Use NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Type2 instead.

License requirements to get this property: None.

License requirements to set this property: studio_analyze ("STUDIO ANALYZE")

unsafe NXOpen.Expression NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.EndIsoAngle

get

Returns the end angle for isoclines (uniform)

Created in NX8.5.0

License requirements: None.

unsafe NXOpen.SelectDisplayableObjectList NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Faces

get

Returns the face list

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Direction NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.IsoclineVector

getset

Returns or sets the vector to define isoclines

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: studio_analyze ("STUDIO ANALYZE")

unsafe bool NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.IsReflectionLocked

getset

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.

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: studio_analyze ("STUDIO ANALYZE")

unsafe double NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightDiffuseness

getset

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

It is used by reflection contours

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: studio_analyze ("STUDIO ANALYZE")

unsafe int NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightNumber

getset

Returns or sets the number of lights.

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

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: studio_analyze ("STUDIO ANALYZE")

unsafe NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightPlacements NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightPlacement

getset

Returns or sets the light placement

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: studio_analyze ("STUDIO ANALYZE")

unsafe NXOpen.Point3d NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightPlaneOrigin

get

Returns the origin of the light plane

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Vector3d NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightPlaneXAxis

get

Returns the x-axis of the light plane

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Vector3d NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightPlaneYAxis

get

Returns the y-axis of the light plane

Created in NX6.0.0

License requirements: None.

unsafe double NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightSpacing

getset

Returns or sets the light spacing between two adjacent lights.

It's used by Uniform type

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: studio_analyze ("STUDIO ANALYZE")

unsafe double NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightWidth

getset

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

It is used by reflection contours

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: studio_analyze ("STUDIO ANALYZE")

unsafe NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Resolutions NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Resolution

getset

Returns or sets the resolution.

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: studio_analyze ("STUDIO ANALYZE")

unsafe NXOpen.Expression NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.StartIsoAngle

get

Returns the start angle for isoclines (uniform)

Created in NX8.5.0

License requirements: None.

unsafe NXOpen.SelectPointList NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.ThroughPoints

get

Returns the through points

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Types NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Type

getset

Returns or sets the type

Created in NX6.0.0

Deprecated in NX8.0.0. Use NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.LightPlacement instead.

License requirements to get this property: None.

License requirements to set this property: studio_analyze ("STUDIO ANALYZE")

unsafe NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Types2 NXOpen.GeometricAnalysis.HighlightLinesAnalysisBuilder.Type2

getset

Returns or sets the display type

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: studio_analyze ("STUDIO ANALYZE")

The documentation for this class was generated from the following file:

GeometricAnalysis_HighlightLinesAnalysisBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation