NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder Class Reference

Represents a GeometricAnalysis::HighlightLinesAnalysis builder. More...

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

List of all members.

Public Types

enum  DisplayMethods { DisplayMethodsReflection, DisplayMethodsProjection }
 display methods
More...
enum  LightPlacements { LightPlacementsUniform, LightPlacementsThroughPoints, LightPlacementsBetweenPoints }
 light placement More...
enum  LightPlaneOptions { LightPlaneOptionsYZ, LightPlaneOptionsZX, LightPlaneOptionsXY, LightPlaneOptionsArbitrary }
 light plane options More...
enum  Resolutions {
  ResolutionsCoarse, ResolutionsStandard, ResolutionsFine, ResolutionsExtraFine,
  ResolutionsSuperFine, ResolutionsUltraFine
}
 resolution options More...
enum  Types { TypesUniform, TypesThroughPoints, TypesBetweenPoints }
 three types of light methods
More...
enum  Types2 { Types2Reflection, Types2Projection }
 two types of display methods More...

Public Member Functions

NXOpen::SelectPointListBetweenPoints ()
 Returns the between points
Created in NX6.0.0.
NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::DisplayMethods DisplayMethod ()
 Returns the display method

NXOpen::SelectDisplayableObjectListFaces ()
 Returns the face list
Created in NX6.0.0.
bool IsReflectionLocked ()
 Returns the lock reflection.
int LightNumber ()
 Returns the number of lights.
NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlacements LightPlacement ()
 Returns the light placement
Created in NX8.0.0.
NXOpen::Point3d LightPlaneOrigin ()
 Returns the origin of the light plane
Created in NX6.0.0.
NXOpen::Vector3d LightPlaneXAxis ()
 Returns the x-axis of the light plane
Created in NX6.0.0.
NXOpen::Vector3d LightPlaneYAxis ()
 Returns the y-axis of the light plane
Created in NX6.0.0.
double LightSpacing ()
 Returns the light spacing between two adjacent lights.
void ReinitializePlane ()
 Reinitialize light plane based on the selected faces.
NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Resolutions Resolution ()
 Returns the resolution.
void SetDisplayMethod (NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::DisplayMethods displayMethod)
 Sets the display method

void SetLightNumber (int lightNumber)
 Sets the number of lights.
void SetLightPlacement (NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlacements placement)
 Sets the light placement
Created in NX8.0.0.
void SetLightPlaneOrigin (const NXOpen::Point3d &origin)
 Sets the origin of the light plane.
void SetLightPlaneXAxis (const NXOpen::Vector3d &xAxis)
 Sets the x-axis of the light plane.
void SetLightPlaneYAxis (const NXOpen::Vector3d &yAxis)
 Sets the y-axis of the light plane.
void SetLightSpacing (double lightSpacing)
 Sets the light spacing between two adjacent lights.
void SetReflectionLocked (bool isReflectionLocked)
 Sets the lock reflection.
void SetResolution (NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Resolutions resolution)
 Sets the resolution.
void SetType (NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types type)
 Sets the type

void SetType2 (NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types2 type)
 Sets the display type
Created in NX8.0.0.
NXOpen::SelectPointListThroughPoints ()
 Returns the through points
Created in NX6.0.0.
NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types Type ()
 Returns the type

NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types2 Type2 ()
 Returns the display type
Created in NX8.0.0.

Detailed Description

Represents a 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 GeometricAnalysis::AnalysisObjectCollection::CreateHighlightLinesAnalysisBuilder
Default values.

Property Value

LightNumber

10

LightSpacing

50.0 (millimeters part), 2.0 (inches part)

Resolution

Fine


Created in NX6.0.0.


Member Enumeration Documentation

display methods

Deprecated:
Deprecated in NX8.0.0.


Enumerator:
DisplayMethodsReflection 

Create reflection lines.

DisplayMethodsProjection 

Create projection lines.

light placement

Enumerator:
LightPlacementsUniform 

Uniform: Lights are placed uniformly on light plane.

LightPlacementsThroughPoints 

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

LightPlacementsBetweenPoints 

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.

light plane options

Enumerator:
LightPlaneOptionsYZ 

Uses YC-ZC plane as light plane.

LightPlaneOptionsZX 

Uses XC-ZC plane as light plane.

LightPlaneOptionsXY 

Uses XC-YC plane as light plane.

LightPlaneOptionsArbitrary 

Uses an arbitrary plane as light plane.

resolution options

Enumerator:
ResolutionsCoarse 

Coarse.

ResolutionsStandard 

Standard.

ResolutionsFine 

Fine.

ResolutionsExtraFine 

Extra Fine.

ResolutionsSuperFine 

Super Fine.

ResolutionsUltraFine 

Ultra Fine.

three types of light methods

Deprecated:
Deprecated in NX8.0.0.


Enumerator:
TypesUniform 

Uniform: Lights are placed uniformly on light plane.

TypesThroughPoints 

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

TypesBetweenPoints 

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.

two types of display methods

Enumerator:
Types2Reflection 

Create reflection lines.

Types2Projection 

Create projection lines.


Member Function Documentation

Returns the between points
Created in NX6.0.0.



License requirements : None

Returns the display method

Deprecated:
Deprecated in NX8.0.0.



Created in NX6.0.0.

License requirements : None

Returns the face list
Created in NX6.0.0.



License requirements : None

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.
Created in NX6.0.0.

License requirements : None

Returns the number of lights.

It's used by Uniform type and Between Points type.
Created in NX6.0.0.

License requirements : None

Returns the light placement
Created in NX8.0.0.



License requirements : None

Returns the origin of the light plane
Created in NX6.0.0.



License requirements : None

Returns the x-axis of the light plane
Created in NX6.0.0.



License requirements : None

Returns the y-axis of the light plane
Created in NX6.0.0.



License requirements : None

Returns the light spacing between two adjacent lights.

It's used by Uniform type
Created in NX6.0.0.

License requirements : None

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.

Deprecated:
Deprecated in NX8.0.0.


Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Returns the resolution.


Created in NX6.0.0.

License requirements : None

Sets the display method

Deprecated:
Deprecated in NX8.0.0.



Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
displayMethoddisplaymethod

Sets the number of lights.

It's used by Uniform type and Between Points type.
Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
lightNumberlightnumber

Sets the light placement
Created in NX8.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
placementplacement

Sets the origin of the light plane.


Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
origincoordinates of origin

Sets the x-axis of the light plane.


Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
xAxisx-axis vector

Sets the y-axis of the light plane.


Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
yAxisy-axis vector

Sets the light spacing between two adjacent lights.

It's used by Uniform type
Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
lightSpacinglightspacing

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

Parameters:
isReflectionLockedisreflectionlocked

Sets the resolution.


Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
resolutionresolution

Sets the type

Deprecated:
Deprecated in NX8.0.0.



Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
typetype

Sets the display type
Created in NX8.0.0.



License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters:
typetype

Returns the through points
Created in NX6.0.0.



License requirements : None

Returns the type

Deprecated:
Deprecated in NX8.0.0.



Created in NX6.0.0.

License requirements : None

Returns the display type
Created in NX8.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.