CombOptionsBuilder Class

class NXOpen.GeometricUtilities.CombOptionsBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a NXOpen.GeometricUtilities.CombOptionsBuilder

New in version NX6.0.0.

Properties

Property	Description
AnalysisType	Returns or sets the analysis type
AutoScale	Returns or sets the auto scale flag
Density	Returns or sets the density
HasMaxNeedleLength	Returns or sets the maximum needle flag
IntermediateDensity	Returns or sets the intermediate density
IsMaximumLabelEnabled	Returns or sets the value indicating if the maximum label is enabled
IsMinimumLabelEnabled	Returns or sets the value indicating if the minimum label is enabled
IsNormalToGridPlane	Returns or sets the normal to grid plane flag
MaxNeedleLength	Returns or sets the maximum needle length
ReverseNeedles	Returns or sets the reverse needles flag
SampleDistance	Returns or sets the sample distance
ScaleFactor	Returns or sets the scale factor
ShowNeedles	Returns or sets the show needles flag
Tag	Returns the Tag for this object.

Methods

Method	Description
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

CombOptionsBuilderAnalysisTypes Enumeration	Represents the Analysis types
CombOptionsBuilderLabelTypes Enumeration	Represents the Label types

Property Detail

AnalysisType

CombOptionsBuilder.AnalysisType

Returns or sets the analysis type

-------------------------------------

Getter Method

Signature AnalysisType

Returns: Return type:NXOpen.GeometricUtilities.CombOptionsBuilderAnalysisTypes

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AnalysisType

Parameters:analysis (NXOpen.GeometricUtilities.CombOptionsBuilderAnalysisTypes) –

New in version NX6.0.0.

License requirements: None.

AutoScale

CombOptionsBuilder.AutoScale

Returns or sets the auto scale flag

-------------------------------------

Getter Method

Signature AutoScale

Returns: Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AutoScale

Parameters:hasAutoScale (bool) –

New in version NX6.0.0.

License requirements: None.

Density

CombOptionsBuilder.Density

Returns or sets the density

-------------------------------------

Getter Method

Signature Density

Returns: Return type:int

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Density

Parameters:density (int) –

New in version NX6.0.0.

License requirements: None.

HasMaxNeedleLength

CombOptionsBuilder.HasMaxNeedleLength

Returns or sets the maximum needle flag

-------------------------------------

Getter Method

Signature HasMaxNeedleLength

Returns: Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature HasMaxNeedleLength

Parameters:hasMaxNeedleLength (bool) –

New in version NX6.0.0.

License requirements: None.

IntermediateDensity

CombOptionsBuilder.IntermediateDensity

Returns or sets the intermediate density

-------------------------------------

Getter Method

Signature IntermediateDensity

Returns: Return type:int

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IntermediateDensity

Parameters:intermediateDensity (int) –

New in version NX6.0.0.

License requirements: None.

IsMaximumLabelEnabled

CombOptionsBuilder.IsMaximumLabelEnabled

Returns or sets the value indicating if the maximum label is enabled

-------------------------------------

Getter Method

Signature IsMaximumLabelEnabled

Returns: Return type:bool

New in version NX7.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsMaximumLabelEnabled

Parameters:isMaximumLabelEnabled (bool) –

New in version NX7.0.0.

License requirements: None.

IsMinimumLabelEnabled

CombOptionsBuilder.IsMinimumLabelEnabled

Returns or sets the value indicating if the minimum label is enabled

-------------------------------------

Getter Method

Signature IsMinimumLabelEnabled

Returns: Return type:bool

New in version NX7.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsMinimumLabelEnabled

Parameters:isMinimumLabelEnabled (bool) –

New in version NX7.0.0.

License requirements: None.

IsNormalToGridPlane

CombOptionsBuilder.IsNormalToGridPlane

Returns or sets the normal to grid plane flag

-------------------------------------

Getter Method

Signature IsNormalToGridPlane

Returns: Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsNormalToGridPlane

Parameters:isNormalToGridPlane (bool) –

New in version NX6.0.0.

License requirements: None.

MaxNeedleLength

CombOptionsBuilder.MaxNeedleLength

Returns or sets the maximum needle length

-------------------------------------

Getter Method

Signature MaxNeedleLength

Returns: Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MaxNeedleLength

Parameters:maxNeedleLength (float) –

New in version NX6.0.0.

License requirements: None.

ReverseNeedles

CombOptionsBuilder.ReverseNeedles

Returns or sets the reverse needles flag

-------------------------------------

Getter Method

Signature ReverseNeedles

Returns: Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ReverseNeedles

Parameters:reverseNeedles (bool) –

New in version NX6.0.0.

License requirements: None.

SampleDistance

CombOptionsBuilder.SampleDistance

Returns or sets the sample distance

-------------------------------------

Getter Method

Signature SampleDistance

Returns: Return type:float

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SampleDistance

Parameters:sampleDistance (float) –

New in version NX11.0.0.

License requirements: None.

ScaleFactor

CombOptionsBuilder.ScaleFactor

Returns or sets the scale factor

-------------------------------------

Getter Method

Signature ScaleFactor

Returns: Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ScaleFactor

Parameters:scaleFactor (float) –

New in version NX6.0.0.

License requirements: None.

ShowNeedles

CombOptionsBuilder.ShowNeedles

Returns or sets the show needles flag

-------------------------------------

Getter Method

Signature ShowNeedles

Returns: Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowNeedles

Parameters:showNeedles (bool) –

New in version NX6.0.0.

License requirements: None.

Method Detail

Validate

CombOptionsBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.