FacetingParameters Struct¶

class NXOpen.Facet.FacetingParameters¶

Bases: object

The structure of JA faceting parameters

Fields¶

Field	Description
MaximumFacetEdges	The maximum number of edges allowed in the facets that are to be generated (this does not apply to JT).
SpecifySurfaceTolerance	If this value is true, then values must be specified for surfaceDistanceTolerance and surfaceAngularTolerance.
SurfaceDistanceTolerance	This is the maximum distance from the surface to the facet.
SurfaceAngularTolerance	This is the maximum angular variation in radians of the surface normal over the facet.
SpecifyCurveTolerance	This indicates that values are to be specified for curveDistanceTolerance and curveAngularTolerance and curve_max_length.
CurveDistanceTolerance	This is the maximum distance between the facet edge and the curve segment represented by the facet edge.
CurveAngularTolerance	This is the maximum angular variation in radians of the curve tangent along the curve segment represented by the facet edge.
CurveMaximumLength	The maximum length of a curve, default is 1000.
SpecifyConvexFacets	This indicates that the facets generated by the faceter should all be convex (this does not apply to JT).
SpecifyMaximumFacetSize	This indicates that a maximum width of facet is to be specified using maximumFacetSize.
MaximumFacetSize	This is the maximum width of a facet.
SpecifyParameters	This indicates that the model will be created with the parametric information for each vertex.
NumberStorageType	This indicates whether the real numbers for facet vertices and facet normals should be stored as floats (UF_FACET_TYPE_FLOAT) or as doubles (UF_FACET_TYPE_DOUBLE).
SpecifyViewDirection	Should we use a viewing direction for denser faceting around silhouettes.
SilhouetteViewDirection	If specifyViewDirection is specified, then this is the view direction to use (this does not apply to JT).
SilhouetteChordTolerance	If specifyViewDirection is specified then this is the tolerance which will be used as a tighter surface tolerance in the silhouette area specified by the view direction (this does not apply to JT).
StoreFaceTag	Should this FACET body record face tags or not (this does not apply to JT).
WithLODS	When creating a JT facet body whether to create LODs or not (this does not apply to NX).

MaximumFacetEdges¶

FacetingParameters.MaximumFacetEdges¶

The maximum number of edges allowed in the facets that are to be generated (this does not apply to JT).

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

Getter Method Signature MaximumFacetEdges()

Returns:
Return type:	int

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

Setter Method

Signature MaximumFacetEdges(value)

Parameters:	value (int) –

SpecifySurfaceTolerance¶

FacetingParameters.SpecifySurfaceTolerance¶

If this value is true, then values must be specified for surfaceDistanceTolerance and surfaceAngularTolerance.

If this value is false then values for surfaceDistanceTolerance and surfaceAngularTolerance will be determined by the system based on the body box or face box of the solid entity being faceted.

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

Getter Method Signature SpecifySurfaceTolerance()

Returns:
Return type:	bool

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

Setter Method

Signature SpecifySurfaceTolerance(value)

Parameters:	value (bool) –

SurfaceDistanceTolerance¶

FacetingParameters.SurfaceDistanceTolerance¶

This is the maximum distance from the surface to the facet.

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

Getter Method Signature SurfaceDistanceTolerance()

Returns:
Return type:	float

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

Setter Method

Signature SurfaceDistanceTolerance(value)

Parameters:	value (float) –

SurfaceAngularTolerance¶

FacetingParameters.SurfaceAngularTolerance¶

This is the maximum angular variation in radians of the surface normal over the facet.

A value of zero indicates no constraint.

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

Getter Method Signature SurfaceAngularTolerance()

Returns:
Return type:	float

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

Setter Method

Signature SurfaceAngularTolerance(value)

Parameters:	value (float) –

SpecifyCurveTolerance¶

FacetingParameters.SpecifyCurveTolerance¶

This indicates that values are to be specified for curveDistanceTolerance and curveAngularTolerance and curve_max_length.

If this value is false then values for curveDistanceTolerance and curveAngularTolerance will be determined by the system based on the body box or face box of the solid entity being faceted, and no restriction will be placed on the maximum length of curve that can be represented by a single facet edge.

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

Getter Method Signature SpecifyCurveTolerance()

Returns:
Return type:	bool

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

Setter Method

Signature SpecifyCurveTolerance(value)

Parameters:	value (bool) –

CurveDistanceTolerance¶

FacetingParameters.CurveDistanceTolerance¶

This is the maximum distance between the facet edge and the curve segment represented by the facet edge.

This applies only to those facet edges lying along solid edges.

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

Getter Method Signature CurveDistanceTolerance()

Returns:
Return type:	float

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

Setter Method

Signature CurveDistanceTolerance(value)

Parameters:	value (float) –

CurveAngularTolerance¶

FacetingParameters.CurveAngularTolerance¶

This is the maximum angular variation in radians of the curve tangent along the curve segment represented by the facet edge.

This applies only to those facet edges lying along solid edges. A value of zero indicates no constraint.

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

Getter Method Signature CurveAngularTolerance()

Returns:
Return type:	float

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

Setter Method

Signature CurveAngularTolerance(value)

Parameters:	value (float) –

CurveMaximumLength¶

FacetingParameters.CurveMaximumLength¶

The maximum length of a curve, default is 1000.

0 -------------------------------------

Getter Method Signature CurveMaximumLength()

Returns:
Return type:	float

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

Setter Method

Signature CurveMaximumLength(value)

Parameters:	value (float) –

SpecifyConvexFacets¶

FacetingParameters.SpecifyConvexFacets¶

This indicates that the facets generated by the faceter should all be convex (this does not apply to JT).

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

Getter Method Signature SpecifyConvexFacets()

Returns:
Return type:	bool

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

Setter Method

Signature SpecifyConvexFacets(value)

Parameters:	value (bool) –

SpecifyMaximumFacetSize¶

FacetingParameters.SpecifyMaximumFacetSize¶

This indicates that a maximum width of facet is to be specified using maximumFacetSize.

If this field is false then no maximum facet size is imposed.

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

Getter Method Signature SpecifyMaximumFacetSize()

Returns:
Return type:	bool

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

Setter Method

Signature SpecifyMaximumFacetSize(value)

Parameters:	value (bool) –

MaximumFacetSize¶

FacetingParameters.MaximumFacetSize¶

This is the maximum width of a facet.

This is only used if specifyMaximumFacetSize is true.

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

Getter Method Signature MaximumFacetSize()

Returns:
Return type:	float

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

Setter Method

Signature MaximumFacetSize(value)

Parameters:	value (float) –

SpecifyParameters¶

FacetingParameters.SpecifyParameters¶

This indicates that the model will be created with the parametric information for each vertex.

Should parameters at the vertices be obtained for the facets of the model (this does not apply to JT).

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

Getter Method Signature SpecifyParameters()

Returns:
Return type:	bool

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

Setter Method

Signature SpecifyParameters(value)

Parameters:	value (bool) –

NumberStorageType¶

FacetingParameters.NumberStorageType¶

This indicates whether the real numbers for facet vertices and facet normals should be stored as floats (UF_FACET_TYPE_FLOAT) or as doubles (UF_FACET_TYPE_DOUBLE).

Note that this option applies only when a faceted model is being created, and is ignored when the model is updated (this does not apply to JT).

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

Getter Method Signature NumberStorageType()

Returns:
Return type:	int

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

Setter Method

Signature NumberStorageType(value)

Parameters:	value (int) –

SpecifyViewDirection¶

FacetingParameters.SpecifyViewDirection¶

Should we use a viewing direction for denser faceting around silhouettes.

The denser faceting will honor the tolerance specified by silhouetteChordTolerance in the silhouette with respect to the view direction specified by silhouetteViewDirection vector. If this is false, there is no special consideration for any silhouette area (this does not apply to JT).

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

Getter Method Signature SpecifyViewDirection()

Returns:
Return type:	bool

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

Setter Method

Signature SpecifyViewDirection(value)

Parameters:	value (bool) –

SilhouetteViewDirection¶

FacetingParameters.SilhouetteViewDirection¶

If specifyViewDirection is specified, then this is the view direction to use (this does not apply to JT).

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

Getter Method Signature SilhouetteViewDirection()

Returns:
Return type:	`NXOpen.Vector3d`

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

Setter Method

Signature SilhouetteViewDirection(value)

Parameters:	value (`NXOpen.Vector3d`) –

SilhouetteChordTolerance¶

FacetingParameters.SilhouetteChordTolerance¶

If specifyViewDirection is specified then this is the tolerance which will be used as a tighter surface tolerance in the silhouette area specified by the view direction (this does not apply to JT).

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

Getter Method Signature SilhouetteChordTolerance()

Returns:
Return type:	float

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

Setter Method

Signature SilhouetteChordTolerance(value)

Parameters:	value (float) –

StoreFaceTag¶

FacetingParameters.StoreFaceTag¶

Should this FACET body record face tags or not (this does not apply to JT).

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

Getter Method Signature StoreFaceTag()

Returns:
Return type:	bool

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

Setter Method

Signature StoreFaceTag(value)

Parameters:	value (bool) –

WithLODS¶

FacetingParameters.WithLODS¶

When creating a JT facet body whether to create LODs or not (this does not apply to NX).

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

Getter Method Signature WithLODS()

Returns:
Return type:	bool

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

Setter Method

Signature WithLODS(value)

Parameters:	value (bool) –