NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder Class Reference

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

Inheritance diagram for NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder:

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, Types2Isoclines, Types2Zebra }
	four types of display methods More...

Public Member Functions
NXOpen::SelectPointList *	BetweenPoints ()
	Returns the between points Created in NX6.0.0. More...
NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::DisplayMethods	DisplayMethod ()
	Returns the display method More...
NXOpen::Expression *	EndIsoAngle ()
	Returns the end angle for isoclines (uniform) Created in NX8.5.0. More...
NXOpen::SelectDisplayableObjectList *	Faces ()
	Returns the face list Created in NX6.0.0. More...
std::vector< double >	GetBrightColor ()
	Gets the color of the bright (lit) areas of reflection contours. More...
std::vector< double >	GetDarkColor ()
	Gets the color of the dark (unlit) areas of reflection contours. More...
NXOpen::Direction *	IsoclineVector ()
	Returns the vector to define isoclines Created in NX8.5.0. More...
bool	IsReflectionLocked ()
	Returns the lock reflection. More...
double	LightDiffuseness ()
	Returns the ratio of blended texels to all light texels. More...
int	LightNumber ()
	Returns the number of lights. More...
NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlacements	LightPlacement ()
	Returns the light placement Created in NX8.0.0. More...
NXOpen::Point3d	LightPlaneOrigin ()
	Returns the origin of the light plane Created in NX6.0.0. More...
NXOpen::Vector3d	LightPlaneXAxis ()
	Returns the x-axis of the light plane Created in NX6.0.0. More...
NXOpen::Vector3d	LightPlaneYAxis ()
	Returns the y-axis of the light plane Created in NX6.0.0. More...
double	LightSpacing ()
	Returns the light spacing between two adjacent lights. More...
double	LightWidth ()
	Returns the ratio of light size to light spacing. More...
void	ReinitializePlane ()
	Reinitialize light plane based on the selected faces. More...
NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Resolutions	Resolution ()
	Returns the resolution. More...
void	SetBrightColor (const std::vector< double > &brightColor)
	Sets the color of the bright (lit) areas of reflection contours Created in NX9.0.0. More...
void	SetDarkColor (const std::vector< double > &darkColor)
	Sets the color of the dark (unlit) areas of reflection contours Created in NX9.0.0. More...
void	SetDisplayMethod (NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::DisplayMethods displayMethod)
	Sets the display method More...
void	SetIsoclineVector (NXOpen::Direction *isoclineVector)
	Sets the vector to define isoclines Created in NX8.5.0. More...
void	SetLightDiffuseness (double lightDiffuseness)
	Sets the ratio of blended texels to all light texels. More...
void	SetLightNumber (int lightNumber)
	Sets the number of lights. More...
void	SetLightPlacement (NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlacements placement)
	Sets the light placement Created in NX8.0.0. More...
void	SetLightPlaneOrigin (const NXOpen::Point3d &origin)
	Sets the origin of the light plane. More...
void	SetLightPlaneXAxis (const NXOpen::Vector3d &xAxis)
	Sets the x-axis of the light plane. More...
void	SetLightPlaneYAxis (const NXOpen::Vector3d &yAxis)
	Sets the y-axis of the light plane. More...
void	SetLightSpacing (double lightSpacing)
	Sets the light spacing between two adjacent lights. More...
void	SetLightWidth (double lightWidth)
	Sets the ratio of light size to light spacing. More...
void	SetReflectionLocked (bool isReflectionLocked)
	Sets the lock reflection. More...
void	SetResolution (NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Resolutions resolution)
	Sets the resolution. More...
void	SetType (NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types type)
	Sets the type More...
void	SetType2 (NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types2 type)
	Sets the display type Created in NX8.0.0. More...
NXOpen::Expression *	StartIsoAngle ()
	Returns the start angle for isoclines (uniform) Created in NX8.5.0. More...
NXOpen::SelectPointList *	ThroughPoints ()
	Returns the through points Created in NX6.0.0. More...
NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types	Type ()
	Returns the type More...
NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types2	Type2 ()
	Returns the display type Created in NX8.0.0. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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

Deprecated:

Deprecated in NX8.0.0.

Use NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types2 instead.

Enumerator
DisplayMethodsReflection	Create reflection lines.
DisplayMethodsProjection	Create projection lines.

enum NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlacements

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.

enum NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlaneOptions

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.

enum NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Resolutions

resolution options

Enumerator
ResolutionsCoarse	Coarse.
ResolutionsStandard	Standard.
ResolutionsFine	Fine.
ResolutionsExtraFine	Extra Fine.
ResolutionsSuperFine	Super Fine.
ResolutionsUltraFine	Ultra Fine.

enum NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types

three types of light methods

Deprecated:

Deprecated in NX8.0.0.

Use NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlacements instead.

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.

enum NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types2

four types of display methods

Enumerator
Types2Reflection	Create reflection lines.
Types2Projection	Create projection lines.
Types2Isoclines	Create isoclines.
Types2Zebra	Create zebra contour lines.

Member Function Documentation

NXOpen::SelectPointList* NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::BetweenPoints

(

)

Returns the between points
Created in NX6.0.0.

License requirements : None

NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::DisplayMethods NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::DisplayMethod

(

)

Returns the display method

Deprecated:

Deprecated in NX8.0.0.

Use NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Type2 and NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetType2 instead.

Created in NX6.0.0.

License requirements : None

NXOpen::Expression* NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::EndIsoAngle

(

)

Returns the end angle for isoclines (uniform)
Created in NX8.5.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Faces

(

)

Returns the face list
Created in NX6.0.0.

License requirements : None

std::vector<double> NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::GetBrightColor

(

)

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

Returns

Array of 3 RGB values, each between 0 and 1
Created in NX9.0.0.

License requirements : None

std::vector<double> NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::GetDarkColor

(

)

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

Returns

Array of 3 RGB values, each between 0 and 1
Created in NX9.0.0.

License requirements : None

NXOpen::Direction* NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::IsoclineVector

(

)

Returns the vector to define isoclines
Created in NX8.5.0.

License requirements : None

bool NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::IsReflectionLocked

(

)

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

double NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightDiffuseness

(

)

Returns the ratio of blended texels to all light texels.

It is used by reflection contours
Created in NX9.0.0.

License requirements : None

int NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightNumber

(

)

Returns the number of lights.

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

License requirements : None

NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlacements NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlacement

(

)

Returns the light placement
Created in NX8.0.0.

License requirements : None

NXOpen::Point3d NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlaneOrigin

(

)

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

License requirements : None

NXOpen::Vector3d NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlaneXAxis

(

)

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

License requirements : None

NXOpen::Vector3d NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlaneYAxis

(

)

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

License requirements : None

double NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightSpacing

(

)

Returns the light spacing between two adjacent lights.

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

License requirements : None

double NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightWidth

(

)

Returns the ratio of light size to light spacing.

It is used by reflection contours
Created in NX9.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::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.

Deprecated:

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

Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Resolutions NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Resolution

(

)

Returns the resolution.

Created in NX6.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetBrightColor

(

const std::vector< double > &

brightColor

)

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

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetDarkColor

(

const std::vector< double > &

darkColor

)

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

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetDisplayMethod

(

NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::DisplayMethods

displayMethod

)

Sets the display method

Deprecated:

Deprecated in NX8.0.0.

Use NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Type2 and NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetType2 instead.

Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

displayMethod

displaymethod

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetIsoclineVector

(

NXOpen::Direction *

isoclineVector

)

Sets the vector to define isoclines
Created in NX8.5.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

isoclineVector

isoclinevector

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetLightDiffuseness

(

double

lightDiffuseness

)

Sets the ratio of blended texels to all light texels.

It is used by reflection contours
Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

lightDiffuseness

lightdiffuseness

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetLightNumber

(

int

lightNumber

)

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

lightNumber

lightnumber

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetLightPlacement

(

NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlacements

placement

)

Sets the light placement
Created in NX8.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

placement

placement

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetLightPlaneOrigin

(

const NXOpen::Point3d &

origin

)

Sets the origin of the light plane.

Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

origin

coordinates of origin

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetLightPlaneXAxis

(

const NXOpen::Vector3d &

xAxis

)

Sets the x-axis of the light plane.

Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

xAxis

x-axis vector

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetLightPlaneYAxis

(

const NXOpen::Vector3d &

yAxis

)

Sets the y-axis of the light plane.

Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

yAxis

y-axis vector

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetLightSpacing

(

double

lightSpacing

)

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

lightSpacing

lightspacing

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetLightWidth

(

double

lightWidth

)

Sets the ratio of light size to light spacing.

It is used by reflection contours
Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

lightWidth

lightwidth

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetReflectionLocked

(

bool

isReflectionLocked

)

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

isReflectionLocked

isreflectionlocked

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetResolution

(

NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Resolutions

resolution

)

Sets the resolution.

Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

resolution

resolution

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetType

(

NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types

type

)

Sets the type

Deprecated:

Deprecated in NX8.0.0.

Use NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlacement and NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetLightPlacement instead.

Created in NX6.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

type

type

void NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetType2

(

NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types2

type

)

Sets the display type
Created in NX8.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

type

type

NXOpen::Expression* NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::StartIsoAngle

(

)

Returns the start angle for isoclines (uniform)
Created in NX8.5.0.

License requirements : None

NXOpen::SelectPointList* NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::ThroughPoints

(

)

Returns the through points
Created in NX6.0.0.

License requirements : None

NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Type

(

)

Returns the type

Deprecated:

Deprecated in NX8.0.0.

Use NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::LightPlacement and NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::SetLightPlacement instead.

Created in NX6.0.0.

License requirements : None

NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Types2 NXOpen::GeometricAnalysis::HighlightLinesAnalysisBuilder::Type2

(

)

Returns the display type
Created in NX8.0.0.

License requirements : None

---

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

• GeometricAnalysis_HighlightLinesAnalysisBuilder.hxx