NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder Class Reference

Represents a GeometricAnalysis::FaceCurvatureAnalysisBuilder builder. More...

Inheritance diagram for NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder:

Public Types
enum	CurvatureTypes {   CurvatureTypesGaussian, CurvatureTypesAbsolute, CurvatureTypesMinimum, CurvatureTypesMaximum,   CurvatureTypesMean, CurvatureTypesNormal, CurvatureTypesSectional, CurvatureTypesU,   CurvatureTypesV }
	Represents the face curvature types. More...
enum	DirectionTypes { DirectionTypesPrimitive, DirectionTypesManipulator }
	Methods of specifiying the direction for normal and section curvatures. More...
enum	DisplayTypes { DisplayTypesColormap, DisplayTypesContours, DisplayTypesColormapAndContours }
	Represents the display types. More...
enum	ScaleTypes { ScaleTypesLinear, ScaleTypesLog, ScaleTypesArea }
	Represents the scaling types for curvature values. More...

Public Member Functions
int	ContourRefinement ()
	Returns the contour refinement level, in the range 0-6.
double	ContourShift ()
	Returns the starting contour shift or bias value, as % of the standard contour interval.
NXOpen::Plane *	CurvatureSectionPlane ()
	Returns the section curvature plane when sectional curvature values are to be computed and displayed.
NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::CurvatureTypes	CurvatureType ()
	Returns the curvature type to compute and display.
NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DisplayTypes	DisplayType ()
	Returns the display type for curvature values.
double	MapCenter ()
	Returns the center point of the color mapping and contouring, as % of the full range of curvature values present in the data.
double	MapRange ()
	Returns the color map and contour range, as % of the full range of curvature values present in the data.
NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DirectionTypes	NormalOption ()
	Returns the normal for the case of normal curvature type.
NXOpen::Matrix3x3	NormalOrientation ()
	Returns the normal orientation when the normal curvature values are to be computed and displayed.
NXOpen::Point3d	NormalOrigin ()
	Returns the normal origin when normal curvature values are to be computed and displayed.
NXOpen::Direction *	NormalVector ()
	Returns the normal vector for the case when normal curvature values are to be computed and displayed.
int	NumberOfContours ()
	Returns the number of contour lines to compute and display.
NXOpen::GeometricUtilities::DisplayResolutionBuilder *	Resolution ()
	Returns the tesselation resolution to use for curvature color map and contours.
void	ReverseAllNormals ()
	Reverses all normals.
NXOpen::SelectDisplayableObject *	ReverseIndividual ()
	Returns the individual face normal.
void	ReverseIndividualNormal (NXOpen::DisplayableObject *face)
	Reverses an individual face normal.
NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::ScaleTypes	ScaleType ()
	Returns the scaling type of curvature values.
NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DirectionTypes	SectionOption ()
	Returns whether to use a section plane or maninpulator for sectional curvatures.
NXOpen::Matrix3x3	SectionOrientation ()
	Returns the section orientation for sectional curvatures.
NXOpen::Point3d	SectionOrigin ()
	Returns the section origin for sectional curvatures.
NXOpen::SelectDisplayableObjectList *	SelectObject ()
	Returns the faces on which to perform curvature analysis.
void	SetContourRefinement (int contourRefinement)
	Sets the contour refinement level, in the range 0-6.
void	SetContourShift (double contourShift)
	Sets the starting contour shift or bias value, as % of the standard contour interval.
void	SetCurvatureSectionPlane (NXOpen::Plane *curvatureSectionPlane)
	Sets the section curvature plane when sectional curvature values are to be computed and displayed.
void	SetCurvatureType (NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::CurvatureTypes curvatureType)
	Sets the curvature type to compute and display.
void	SetDisplayType (NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DisplayTypes displayType)
	Sets the display type for curvature values.
void	SetMapCenter (double mapCenter)
	Sets the center point of the color mapping and contouring, as % of the full range of curvature values present in the data.
void	SetMapRange (double mapRange)
	Sets the color map and contour range, as % of the full range of curvature values present in the data.
void	SetNormalOption (NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DirectionTypes normalOption)
	Sets the normal for the case of normal curvature type.
void	SetNormalOrientation (const NXOpen::Matrix3x3 &normalOrientation)
	Sets the normal orientation when the normal curvature values are to be computed and displayed.
void	SetNormalOrigin (const NXOpen::Point3d &normalOrigin)
	Sets the normal origin when normal curvature values are to be computed and displayed.
void	SetNormalVector (NXOpen::Direction *normalVector)
	Sets the normal vector for the case when normal curvature values are to be computed and displayed.
void	SetNumberOfContours (int numberOfContours)
	Sets the number of contour lines to compute and display.
void	SetScaleType (NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::ScaleTypes scaleType)
	Sets the scaling type of curvature values.
void	SetSectionOption (NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DirectionTypes sectionOption)
	Sets whether to use a section plane or maninpulator for sectional curvatures.
void	SetSectionOrientation (const NXOpen::Matrix3x3 &sectionOrientation)
	Sets the section orientation for sectional curvatures.
void	SetSectionOrigin (const NXOpen::Point3d &sectionOrigin)
	Sets the section origin for sectional curvatures.
void	SetShowZeroContour (bool showContour)
	Sets the option to show zero curvature contour line.
bool	ShowZeroContour ()
	Returns the option to show zero curvature contour line.
void	UpdateReverseMap ()
	Updates reverse map.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a GeometricAnalysis::FaceCurvatureAnalysisBuilder builder.

    Use @link GeometricAnalysis::FaceCurvatureAnalysisBuilder GeometricAnalysis::FaceCurvatureAnalysisBuilder@endlink  to compute different
    types of curvature analysis for selected faces.  The result of the curvature analysis is
    displayed as color maps and contour lines on the faces.  For more details see the NX
    documentation for Face Curvature Analysis.
 <br> To create a new instance of this class, use @link GeometricAnalysis::AnalysisObjectCollection::CreateFaceCurvatureAnalysisBuilder  GeometricAnalysis::AnalysisObjectCollection::CreateFaceCurvatureAnalysisBuilder @endlink  <br> 

Default values.

Property	Value
ContourRefinement	0
ContourShift	0
DisplayType	Colormap
MapCenter	50
MapRange	100
NormalOption	Manipulator
NumberOfContours	10
Resolution.AngleTolerance	15.0
Resolution.EdgeTolerance	0.005
Resolution.FaceTolerance	0.005
Resolution.Resolution	Standard
Resolution.WidthTolerance	0.3
SectionOption	Manipulator
ShowZeroContour	0

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::CurvatureTypes

Represents the face curvature types.

Enumerator:

CurvatureTypesGaussian	Gausssian.
CurvatureTypesAbsolute	Absolute.
CurvatureTypesMinimum	Minimum.
CurvatureTypesMaximum	Maximum.
CurvatureTypesMean	Mean.
CurvatureTypesNormal	Normal.
CurvatureTypesSectional	Sectional.
CurvatureTypesU	U.
CurvatureTypesV	V.

enum NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DirectionTypes

Methods of specifiying the direction for normal and section curvatures.

Enumerator:

DirectionTypesPrimitive	vector or plane
DirectionTypesManipulator	orientation maninpulator

enum NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DisplayTypes

Represents the display types.

Enumerator:

DisplayTypesColormap	Color Map only.
DisplayTypesContours	Contours.
DisplayTypesColormapAndContours	Color Map and Contours.

enum NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::ScaleTypes

Represents the scaling types for curvature values.

Enumerator:

ScaleTypesLinear	Linear Scaling (No Scaling)
ScaleTypesLog	Log Scaling.
ScaleTypesArea	Equalized by Area.

Member Function Documentation

int NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::ContourRefinement

(

)

Returns the contour refinement level, in the range 0-6.

Increasing values compute more detailed and accurate contour lines on the face.
Created in NX9.0.0.

License requirements : None

double NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::ContourShift

(

)

Returns the starting contour shift or bias value, as % of the standard contour interval.

Valid values are -100 to 100.
Created in NX9.0.0.

License requirements : None

NXOpen::Plane* NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::CurvatureSectionPlane

(

)

Returns the section curvature plane when sectional curvature values are to be computed and displayed.

Created in NX9.0.0.

License requirements : None

NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::CurvatureTypes NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::CurvatureType

(

)

Returns the curvature type to compute and display.

Created in NX9.0.0.

License requirements : None

NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DisplayTypes NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DisplayType

(

)

Returns the display type for curvature values.

Created in NX9.0.0.

License requirements : None

double NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::MapCenter

(

)

Returns the center point of the color mapping and contouring, as % of the full range of curvature values present in the data.

Created in NX9.0.0.

License requirements : None

double NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::MapRange

(

)

Returns the color map and contour range, as % of the full range of curvature values present in the data.

Created in NX9.0.0.

License requirements : None

NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DirectionTypes NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::NormalOption

(

)

Returns the normal for the case of normal curvature type.

Created in NX9.0.0.

License requirements : None

NXOpen::Matrix3x3 NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::NormalOrientation

(

)

Returns the normal orientation when the normal curvature values are to be computed and displayed.

Created in NX9.0.0.

License requirements : None

NXOpen::Point3d NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::NormalOrigin

(

)

Returns the normal origin when normal curvature values are to be computed and displayed.

Created in NX9.0.0.

License requirements : None

NXOpen::Direction* NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::NormalVector

(

)

Returns the normal vector for the case when normal curvature values are to be computed and displayed.

Created in NX9.0.0.

License requirements : None

int NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::NumberOfContours

(

)

Returns the number of contour lines to compute and display.

Created in NX9.0.0.

License requirements : None

NXOpen::GeometricUtilities::DisplayResolutionBuilder* NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::Resolution

(

)

Returns the tesselation resolution to use for curvature color map and contours.

Created in NX9.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::ReverseAllNormals

(

)

Reverses all normals.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

NXOpen::SelectDisplayableObject* NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::ReverseIndividual

(

)

Returns the individual face normal.

Created in NX9.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::ReverseIndividualNormal

(

NXOpen::DisplayableObject *

face

)

Reverses an individual face normal.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

face

face

NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::ScaleTypes NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::ScaleType

(

)

Returns the scaling type of curvature values.

Created in NX9.0.0.

License requirements : None

NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DirectionTypes NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SectionOption

(

)

Returns whether to use a section plane or maninpulator for sectional curvatures.

Created in NX9.0.0.

License requirements : None

NXOpen::Matrix3x3 NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SectionOrientation

(

)

Returns the section orientation for sectional curvatures.

Created in NX9.0.0.

License requirements : None

NXOpen::Point3d NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SectionOrigin

(

)

Returns the section origin for sectional curvatures.

Created in NX9.0.0.

License requirements : None

NXOpen::SelectDisplayableObjectList* NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SelectObject

(

)

Returns the faces on which to perform curvature analysis.

Created in NX9.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetContourRefinement

(

int

contourRefinement

)

Sets the contour refinement level, in the range 0-6.

Increasing values compute more detailed and accurate contour lines on the face.
Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

contourRefinement

contourrefinement

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetContourShift

(

double

contourShift

)

Sets the starting contour shift or bias value, as % of the standard contour interval.

Valid values are -100 to 100.
Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

contourShift

contourshift

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetCurvatureSectionPlane

(

NXOpen::Plane *

curvatureSectionPlane

)

Sets the section curvature plane when sectional curvature values are to be computed and displayed.

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

curvatureSectionPlane

curvaturesectionplane

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetCurvatureType

(

NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::CurvatureTypes

curvatureType

)

Sets the curvature type to compute and display.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

curvatureType

curvaturetype

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetDisplayType

(

NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DisplayTypes

displayType

)

Sets the display type for curvature values.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

displayType

displaytype

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetMapCenter

(

double

mapCenter

)

Sets the center point of the color mapping and contouring, as % of the full range of curvature values present in the data.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

mapCenter

mapcenter

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetMapRange

(

double

mapRange

)

Sets the color map and contour range, as % of the full range of curvature values present in the data.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

mapRange

maprange

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetNormalOption

(

NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DirectionTypes

normalOption

)

Sets the normal for the case of normal curvature type.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

normalOption

normaloption

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetNormalOrientation

(

const NXOpen::Matrix3x3 &

normalOrientation

)

Sets the normal orientation when the normal curvature values are to be computed and displayed.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

normalOrientation

normalorientation

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetNormalOrigin

(

const NXOpen::Point3d &

normalOrigin

)

Sets the normal origin when normal curvature values are to be computed and displayed.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

normalOrigin

normalorigin

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetNormalVector

(

NXOpen::Direction *

normalVector

)

Sets the normal vector for the case when normal curvature values are to be computed and displayed.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

normalVector

normalvector

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetNumberOfContours

(

int

numberOfContours

)

Sets the number of contour lines to compute and display.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

numberOfContours

numberofcontours

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetScaleType

(

NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::ScaleTypes

scaleType

)

Sets the scaling type of curvature values.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

scaleType

scaletype

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetSectionOption

(

NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::DirectionTypes

sectionOption

)

Sets whether to use a section plane or maninpulator for sectional curvatures.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

sectionOption

sectionoption

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetSectionOrientation

(

const NXOpen::Matrix3x3 &

sectionOrientation

)

Sets the section orientation for sectional curvatures.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

sectionOrientation

sectionorientation

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetSectionOrigin

(

const NXOpen::Point3d &

sectionOrigin

)

Sets the section origin for sectional curvatures.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

sectionOrigin

sectionorigin

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::SetShowZeroContour

(

bool

showContour

)

Sets the option to show zero curvature contour line.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

Parameters

showContour

showcontour

bool NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::ShowZeroContour

(

)

Returns the option to show zero curvature contour line.

Created in NX9.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::FaceCurvatureAnalysisBuilder::UpdateReverseMap

(

)

Updates reverse map.

Created in NX9.0.0.

License requirements : studio_analyze ("STUDIO ANALYZE")

---

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

• GeometricAnalysis_FaceCurvatureAnalysisBuilder.hxx