NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder Class Reference

Represents a NXOpen::GeometricAnalysis::CurveCurvatureAnalysis builder
To create a new instance of this class, use NXOpen::GeometricAnalysis::AnalysisObjectCollection::CreateCurveCurvatureAnalysisBuilder
Default values. More...

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

Public Types

enum  CalculationMethod { CalculationMethodCurvature, CalculationMethodRadiusofCurvature }
 Enumeration for needle calculation method. More...
 
enum  DisplayStyle { DisplayStyleLinear, DisplayStyleLogarithmic }
 Enumeration for needle display type. More...
 
enum  LabelValues { LabelValuesCurvature, LabelValuesRadiusofCurvature }
 Enumeration for label computation method. More...
 
enum  NeedleDirection { NeedleDirectionInside, NeedleDirectionOutside }
 Enumeration for needle direction type. More...
 
enum  ProjectionTypes {
  ProjectionTypesNone, ProjectionTypesCurvePlane, ProjectionTypesVector, ProjectionTypesView,
  ProjectionTypesXyz
}
 Projection plane types. More...
 
enum  XyzTypes { XyzTypesX, XyzTypesY, XyzTypesZ }
 Enumeration for X, Y or Z projection plane. More...
 

Public Member Functions

NXOpen::GeometricUtilities::CombOptionsBuilderCombOptions ()
 Returns the comb display block options
Created in NX7.0.0. More...
 
NXOpen::GeometricUtilities::CurveRangeBuilderCombRange ()
 Returns the comb range
Created in NX7.0.0. More...
 
std::vector< NXOpen::Point * > CreateDumbInflectionPoints ()
 Create inflection points. More...
 
std::vector< NXOpen::Point * > CreateDumbPeakPoints ()
 Create peak points. More...
 
bool DynamicProjection ()
 Returns the dynamic projection
Created in NX7.0.0. More...
 
NXOpen::GeometricUtilities::CurveRangeBuilderGetCurveRange (int index)
 Returns the NXOpen::GeometricUtilities::CurveRangeBuilder object at a given index from the list. More...
 
int GetCurveRangeListLength ()
 Get the number of NXOpen::GeometricUtilities::CurveRangeBuilder objects in the list. More...
 
NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::CalculationMethod Method ()
 Returns the method
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::ProjectionTypes Projection ()
 Returns the projection
Created in NX7.0.0. More...
 
int ReverseDirection ()
 Returns the reverse direction
Created in NX7.0.0. More...
 
NXOpen::ScCollectorSelectedCurves ()
 Returns the selected curves and/or edges
Created in NX7.0.0. More...
 
void SetDynamicProjection (bool dynamicProjection)
 Sets the dynamic projection
Created in NX7.0.0. More...
 
void SetMethod (NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::CalculationMethod method)
 Sets the method
Created in NX7.0.0. More...
 
void SetProjection (NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::ProjectionTypes projection)
 Sets the projection
Created in NX7.0.0. More...
 
void SetReverseDirection (int reverseDirection)
 Sets the reverse direction
Created in NX7.0.0. More...
 
void SetShowCombs (bool showCombs)
 Sets the show combs
Created in NX7.0.0. More...
 
void SetShowInflections (bool showInflections)
 Sets the show inflections
Created in NX7.0.0. More...
 
void SetShowMaxLabels (bool showMaxLabels)
 Sets the show max labels
Created in NX7.0.1. More...
 
void SetShowMinLabels (bool showMinLabels)
 Sets the show min labels
Created in NX7.0.1. More...
 
void SetShowPeaks (bool showPeaks)
 Sets the show peaks
Created in NX7.0.0. More...
 
void SetStyle (NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::DisplayStyle style)
 Sets the style
Created in NX7.0.0. More...
 
void SetVector (NXOpen::Direction *vector)
 Sets the vector
Created in NX7.0.0. More...
 
void SetXyz (NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::XyzTypes xyz)
 Sets the xyz
Created in NX7.0.0. More...
 
bool ShowCombs ()
 Returns the show combs
Created in NX7.0.0. More...
 
bool ShowInflections ()
 Returns the show inflections
Created in NX7.0.0. More...
 
bool ShowMaxLabels ()
 Returns the show max labels
Created in NX7.0.1. More...
 
bool ShowMinLabels ()
 Returns the show min labels
Created in NX7.0.1. More...
 
bool ShowPeaks ()
 Returns the show peaks
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::DisplayStyle Style ()
 Returns the style
Created in NX7.0.0. More...
 
void UpdateWorkView ()
 Update work view with a given view matrix
Created in NX7.0.0. More...
 
NXOpen::DirectionVector ()
 Returns the vector
Created in NX7.0.0. More...
 
NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::XyzTypes Xyz ()
 Returns the xyz
Created in NX7.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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::CurveCurvatureAnalysis builder
To create a new instance of this class, use NXOpen::GeometricAnalysis::AnalysisObjectCollection::CreateCurveCurvatureAnalysisBuilder
Default values.

Property Value

CombRange.AnchorPosition

Start

DynamicProjection

1

Method

Curvature

Projection

None

ReverseDirection

0

ShowInflections

0

ShowPeaks

0

Style

Linear

Xyz

X


Created in NX7.0.0.

Member Enumeration Documentation

Enumeration for needle calculation method.

Enumerator
CalculationMethodCurvature 

needle of curvature value

CalculationMethodRadiusofCurvature 

needle of radius of curvature value

Enumeration for needle display type.

Enumerator
DisplayStyleLinear 

linear needle

DisplayStyleLogarithmic 

logarithmic needle

Enumeration for label computation method.

Enumerator
LabelValuesCurvature 

label showing curvature value

LabelValuesRadiusofCurvature 

label showing radius of curvature value

Enumeration for needle direction type.

Enumerator
NeedleDirectionInside 

needle pointing inside

NeedleDirectionOutside 

needle pointing outside

Projection plane types.

Enumerator
ProjectionTypesNone 

no projection

ProjectionTypesCurvePlane 

best fit plane

ProjectionTypesVector 

specify vector

ProjectionTypesView 

view plane

ProjectionTypesXyz 

specify x,y,z plane

Enumeration for X, Y or Z projection plane.

Enumerator
XyzTypesX 

x-axis plane

XyzTypesY 

y-axis plane

XyzTypesZ 

z-axis plane

Member Function Documentation

NXOpen::GeometricUtilities::CombOptionsBuilder* NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::CombOptions ( )

Returns the comb display block options
Created in NX7.0.0.



License requirements : None

NXOpen::GeometricUtilities::CurveRangeBuilder* NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::CombRange ( )

Returns the comb range
Created in NX7.0.0.



License requirements : None

std::vector<NXOpen::Point *> NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::CreateDumbInflectionPoints ( )

Create inflection points.

Returns

Created in NX7.0.0.

License requirements : None
std::vector<NXOpen::Point *> NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::CreateDumbPeakPoints ( )

Create peak points.

Returns

Created in NX7.0.0.

License requirements : None
bool NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::DynamicProjection ( )

Returns the dynamic projection
Created in NX7.0.0.



License requirements : None

NXOpen::GeometricUtilities::CurveRangeBuilder* NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::GetCurveRange ( int  index)

Returns the NXOpen::GeometricUtilities::CurveRangeBuilder object at a given index from the list.

Returns

Created in NX8.0.1.

License requirements : None
Parameters
indexindex
int NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::GetCurveRangeListLength ( )

Get the number of NXOpen::GeometricUtilities::CurveRangeBuilder objects in the list.

Returns

Created in NX8.0.1.

License requirements : None
NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::CalculationMethod NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::Method ( )

Returns the method
Created in NX7.0.0.



License requirements : None

NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::ProjectionTypes NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::Projection ( )

Returns the projection
Created in NX7.0.0.



License requirements : None

int NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::ReverseDirection ( )

Returns the reverse direction
Created in NX7.0.0.



License requirements : None

NXOpen::ScCollector* NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::SelectedCurves ( )

Returns the selected curves and/or edges
Created in NX7.0.0.



License requirements : None

void NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::SetDynamicProjection ( bool  dynamicProjection)

Sets the dynamic projection
Created in NX7.0.0.



License requirements : None

Parameters
dynamicProjectiondynamicprojection
void NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::SetMethod ( NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::CalculationMethod  method)

Sets the method
Created in NX7.0.0.



License requirements : None

Parameters
methodmethod
void NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::SetProjection ( NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::ProjectionTypes  projection)

Sets the projection
Created in NX7.0.0.



License requirements : None

Parameters
projectionprojection
void NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::SetReverseDirection ( int  reverseDirection)

Sets the reverse direction
Created in NX7.0.0.



License requirements : None

Parameters
reverseDirectionreversedirection
void NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::SetShowCombs ( bool  showCombs)

Sets the show combs
Created in NX7.0.0.



License requirements : None

Parameters
showCombsshowcombs
void NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::SetShowInflections ( bool  showInflections)

Sets the show inflections
Created in NX7.0.0.



License requirements : None

Parameters
showInflectionsshowinflections
void NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::SetShowMaxLabels ( bool  showMaxLabels)

Sets the show max labels
Created in NX7.0.1.



License requirements : None

Parameters
showMaxLabelsshowmaxlabels
void NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::SetShowMinLabels ( bool  showMinLabels)

Sets the show min labels
Created in NX7.0.1.



License requirements : None

Parameters
showMinLabelsshowminlabels
void NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::SetShowPeaks ( bool  showPeaks)

Sets the show peaks
Created in NX7.0.0.



License requirements : None

Parameters
showPeaksshowpeaks
void NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::SetStyle ( NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::DisplayStyle  style)

Sets the style
Created in NX7.0.0.



License requirements : None

Parameters
stylestyle
void NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::SetVector ( NXOpen::Direction vector)

Sets the vector
Created in NX7.0.0.



License requirements : None

Parameters
vectorvector
void NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::SetXyz ( NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::XyzTypes  xyz)

Sets the xyz
Created in NX7.0.0.



License requirements : None

Parameters
xyzxyz
bool NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::ShowCombs ( )

Returns the show combs
Created in NX7.0.0.



License requirements : None

bool NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::ShowInflections ( )

Returns the show inflections
Created in NX7.0.0.



License requirements : None

bool NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::ShowMaxLabels ( )

Returns the show max labels
Created in NX7.0.1.



License requirements : None

bool NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::ShowMinLabels ( )

Returns the show min labels
Created in NX7.0.1.



License requirements : None

bool NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::ShowPeaks ( )

Returns the show peaks
Created in NX7.0.0.



License requirements : None

NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::DisplayStyle NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::Style ( )

Returns the style
Created in NX7.0.0.



License requirements : None

void NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::UpdateWorkView ( )

Update work view with a given view matrix
Created in NX7.0.0.



License requirements : None

NXOpen::Direction* NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::Vector ( )

Returns the vector
Created in NX7.0.0.



License requirements : None

NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::XyzTypes NXOpen::GeometricAnalysis::CurveCurvatureAnalysisBuilder::Xyz ( )

Returns the xyz
Created in NX7.0.0.



License requirements : None


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