NX Open C++ Reference Guide
Public Member Functions | Public Attributes | List of all members
NXOpen::Facet::FacetingParameters Struct Reference

The structure of JA faceting parameters. More...

Public Member Functions

 FacetingParameters (int maximumFacetEdgesInitial, bool specifySurfaceToleranceInitial, double surfaceDistanceToleranceInitial, double surfaceAngularToleranceInitial, bool specifyCurveToleranceInitial, double curveDistanceToleranceInitial, double curveAngularToleranceInitial, double curveMaximumLengthInitial, bool specifyConvexFacetsInitial, bool specifyMaximumFacetSizeInitial, double maximumFacetSizeInitial, bool specifyParametersInitial, int numberStorageTypeInitial, bool specifyViewDirectionInitial, const NXOpen::Vector3d &silhouetteViewDirectionInitial, double silhouetteChordToleranceInitial, bool storeFaceTagInitial, bool withLODSInitial)
 Constructor for the FacetingParameters struct. More...
 

Public Attributes

double CurveAngularTolerance
 This is the maximum angular variation in radians of the curve tangent along the curve segment represented by the facet edge. More...
 
double CurveDistanceTolerance
 This is the maximum distance between the facet edge and the curve segment represented by the facet edge. More...
 
double CurveMaximumLength
 The maximum length of a curve, default is 1000.0. More...
 
int MaximumFacetEdges
 The maximum number of edges allowed in the facets that are to be generated (this does not apply to JT). More...
 
double MaximumFacetSize
 This is the maximum width of a facet. More...
 
int 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). More...
 
double 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). More...
 
NXOpen::Vector3d SilhouetteViewDirection
 If specifyViewDirection is specified, then this is the view direction to use (this does not apply to JT). More...
 
bool SpecifyConvexFacets
 This indicates that the facets generated by the faceter should all be convex (this does not apply to JT). More...
 
bool SpecifyCurveTolerance
 This indicates that values are to be specified for curveDistanceTolerance and curveAngularTolerance and curve_max_length. More...
 
bool SpecifyMaximumFacetSize
 This indicates that a maximum width of facet is to be specified using maximumFacetSize. More...
 
bool SpecifyParameters
 This indicates that the model will be created with the parametric information for each vertex. More...
 
bool SpecifySurfaceTolerance
 If this value is true, then values must be specified for surfaceDistanceTolerance and surfaceAngularTolerance. More...
 
bool SpecifyViewDirection
 Should we use a viewing direction for denser faceting around silhouettes. More...
 
bool StoreFaceTag
 Should this FACET body record face tags or not (this does not apply to JT). More...
 
double SurfaceAngularTolerance
 This is the maximum angular variation in radians of the surface normal over the facet. More...
 
double SurfaceDistanceTolerance
 This is the maximum distance from the surface to the facet. More...
 
bool WithLODS
 When creating a JT facet body whether to create LODs or not (this does not apply to NX). More...
 

Detailed Description

The structure of JA faceting parameters.

Constructor & Destructor Documentation

NXOpen::Facet::FacetingParameters::FacetingParameters ( int  maximumFacetEdgesInitial,
bool  specifySurfaceToleranceInitial,
double  surfaceDistanceToleranceInitial,
double  surfaceAngularToleranceInitial,
bool  specifyCurveToleranceInitial,
double  curveDistanceToleranceInitial,
double  curveAngularToleranceInitial,
double  curveMaximumLengthInitial,
bool  specifyConvexFacetsInitial,
bool  specifyMaximumFacetSizeInitial,
double  maximumFacetSizeInitial,
bool  specifyParametersInitial,
int  numberStorageTypeInitial,
bool  specifyViewDirectionInitial,
const NXOpen::Vector3d silhouetteViewDirectionInitial,
double  silhouetteChordToleranceInitial,
bool  storeFaceTagInitial,
bool  withLODSInitial 
)

Constructor for the FacetingParameters struct.

Parameters
maximumFacetEdgesInitialThe maximum number of edges allowed in the facets that are to be generated (this does not apply to JT).
specifySurfaceToleranceInitialIf 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.
surfaceDistanceToleranceInitialThis is the maximum distance from the surface to the facet.
surfaceAngularToleranceInitialThis is the maximum angular variation in radians of the surface normal over the facet. A value of zero indicates no constraint.
specifyCurveToleranceInitialThis 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.
curveDistanceToleranceInitialThis 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.
curveAngularToleranceInitialThis 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.
curveMaximumLengthInitialThe maximum length of a curve, default is 1000.0
specifyConvexFacetsInitialThis indicates that the facets generated by the faceter should all be convex (this does not apply to JT).
specifyMaximumFacetSizeInitialThis 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.
maximumFacetSizeInitialThis is the maximum width of a facet. This is only used if specifyMaximumFacetSize is true.
specifyParametersInitialThis 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).
numberStorageTypeInitialThis 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 option is not applicable to JT creation or update.
specifyViewDirectionInitialShould 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).
silhouetteViewDirectionInitialIf specifyViewDirection is specified, then this is the view direction to use (this does not apply to JT).
silhouetteChordToleranceInitialIf 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).
storeFaceTagInitialShould this FACET body record face tags or not (this does not apply to JT).
withLODSInitialWhen creating a JT facet body whether to create LODs or not (this does not apply to NX).

Member Data Documentation

double NXOpen::Facet::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.

double NXOpen::Facet::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.

double NXOpen::Facet::FacetingParameters::CurveMaximumLength

The maximum length of a curve, default is 1000.0.

int NXOpen::Facet::FacetingParameters::MaximumFacetEdges

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

double NXOpen::Facet::FacetingParameters::MaximumFacetSize

This is the maximum width of a facet.

This is only used if specifyMaximumFacetSize is true.

int NXOpen::Facet::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 option is not applicable to JT creation or update.

double NXOpen::Facet::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).

NXOpen::Vector3d NXOpen::Facet::FacetingParameters::SilhouetteViewDirection

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

bool NXOpen::Facet::FacetingParameters::SpecifyConvexFacets

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

bool NXOpen::Facet::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.

bool NXOpen::Facet::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.

bool NXOpen::Facet::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).

bool NXOpen::Facet::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.

bool NXOpen::Facet::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).

bool NXOpen::Facet::FacetingParameters::StoreFaceTag

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

double NXOpen::Facet::FacetingParameters::SurfaceAngularTolerance

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

A value of zero indicates no constraint.

double NXOpen::Facet::FacetingParameters::SurfaceDistanceTolerance

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

bool NXOpen::Facet::FacetingParameters::WithLODS

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


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