#include <sprk_exchange.h>

Static Public Member Functions | |
static NURBSConversionOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::ExchangeNURBSConversionOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::SprocketKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
SprocketKit & | operator= (SprocketKit &&in_that) |
SprocketKit (SprocketKit &&in_that) | |
Detailed Description
The HPS::Exchange::NURBSConversionOptionsKit class is a user space object. It contains settings controlling how data is converted to NURBS curves and surfaces during import.
Constructor & Destructor Documentation
◆ NURBSConversionOptionsKit() [1/3]
HPS::Exchange::NURBSConversionOptionsKit::NURBSConversionOptionsKit | ( | ) |
The default constructor creates an empty NURBSConversionOptionsKit object.
◆ NURBSConversionOptionsKit() [2/3]
HPS::Exchange::NURBSConversionOptionsKit::NURBSConversionOptionsKit | ( | NURBSConversionOptionsKit const & | in_kit | ) |
The copy constructor creates a new NURBSConversionOptionsKit object that contains the same settings as the source NURBSConversionOptionsKit.
- Parameters
-
in_kit The source NURBSConversionOptionsKit to copy.
◆ NURBSConversionOptionsKit() [3/3]
HPS::Exchange::NURBSConversionOptionsKit::NURBSConversionOptionsKit | ( | NURBSConversionOptionsKit && | in_that | ) |
The move constructor creates an NURBSConversionOptionsKit by transferring the underlying impl of the rvalue reference to this NURBSConversionOptionsKit thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to an NURBSConversionOptionsKit to take the impl from.
Member Function Documentation
◆ Empty()
|
virtual |
Indicates whether this NURBSConversionOptionsKit has any values set on it.
- Returns
- true if no values are set on this NURBSConversionOptionsKit, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::Exchange::NURBSConversionOptionsKit::Equals | ( | NURBSConversionOptionsKit const & | in_kit | ) | const |
Check if the source NURBSConversionOptionsKit is equivalent to this NURBSConversionOptionsKit.
- Parameters
-
in_kit The source NURBSConversionOptionsKit to compare to this NURBSConversionOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ GetDefault()
|
static |
Creates a NURBSConversionOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
- Returns
- A NURBSConversionOptionsKit with the default settings.
◆ ObjectType()
|
inlinevirtual |
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::SprocketKit.
◆ operator!=()
bool HPS::Exchange::NURBSConversionOptionsKit::operator!= | ( | NURBSConversionOptionsKit const & | in_kit | ) | const |
Check if the source NURBSConversionOptionsKit is not equivalent to this NURBSConversionOptionsKit.
- Parameters
-
in_kit The source NURBSConversionOptionsKit to compare to this NURBSConversionOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::operator= | ( | NURBSConversionOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this NURBSConversionOptionsKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an NURBSConversionOptionsKit to take the impl from.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ operator=() [2/2]
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::operator= | ( | NURBSConversionOptionsKit const & | in_kit | ) |
Copies the source NURBSConversionOptionsKit into this NURBSConversionOptionsKit.
- Parameters
-
in_kit The source NURBSConversionOptionsKit to copy.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ operator==()
bool HPS::Exchange::NURBSConversionOptionsKit::operator== | ( | NURBSConversionOptionsKit const & | in_kit | ) | const |
Check if the source NURBSConversionOptionsKit is equivalent to this NURBSConversionOptionsKit.
- Parameters
-
in_kit The source NURBSConversionOptionsKit to compare to this NURBSConversionOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::Exchange::NURBSConversionOptionsKit::Set | ( | NURBSConversionOptionsKit const & | in_kit | ) |
Copies the source NURBSConversionOptionsKit into this NURBSConversionOptionsKit.
- Parameters
-
in_kit The source NURBSConversionOptionsKit to copy.
◆ Set3DCurvesComputation()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::Set3DCurvesComputation | ( | bool | in_state | ) |
Sets whether to compute 3D curves from BRep data. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bForceCompute3D.
- Parameters
-
in_state Whether to compute 3D curves from BRep data.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ SetAllowedCurves() [1/2]
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::SetAllowedCurves | ( | CurveTypeArray const & | in_allowed_curves | ) |
Sets a list of curves types which are allowed in the resulting conversion This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_puiAcceptableCurves. The array passed to this function will be sorted.
- Parameters
-
in_allowed_curves An array of curves which the conversion can produce.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ SetAllowedCurves() [2/2]
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::SetAllowedCurves | ( | size_t | in_count, |
CurveType const | in_allowed_curves[] | ||
) |
Sets a list of curves types which are allowed in the resulting conversion This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_puiAcceptableCurves. The array passed to this function will be sorted.
- Parameters
-
in_count The size of in_allowed_curves. in_allowed_curves An array of curves which the conversion can produce.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ SetAllowedSurfaces() [1/2]
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::SetAllowedSurfaces | ( | SurfaceTypeArray const & | in_allowed_surfaces | ) |
Sets a list of surface types which are allowed in the resulting conversion This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_puiAcceptableSurfaces. The array passed to this function will be sorted.
- Parameters
-
in_allowed_surfaces An array of surfaces which the conversion can produce.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ SetAllowedSurfaces() [2/2]
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::SetAllowedSurfaces | ( | size_t | in_count, |
SurfaceType const | in_allowed_surfaces[] | ||
) |
Sets a list of surface types which are allowed in the resulting conversion This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_puiAcceptableSurfaces. The array passed to this function will be sorted.
- Parameters
-
in_count The size of in_allowed_surfaces. in_allowed_surfaces An array of surfaces which the conversion can produce.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ SetClosedFaceSplitting()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::SetClosedFaceSplitting | ( | bool | in_state | ) |
Sets whether to split closed faces. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bSplitClosedFaces.
- Parameters
-
in_state Whether to split closed faces at the parametric seam and mid-parameter.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ SetCrossSeamCurveReplacement()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::SetCrossSeamCurveReplacement | ( | bool | in_state | ) |
Sets whether to replace UV curves which cross seams of periodic surfaces with 3D curves.
This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bDeleteCrossingUV.
- Parameters
-
in_state Whether to replace UV curves which cross seams of periodic surfaces.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ SetParameterization()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::SetParameterization | ( | bool | in_state | ) |
Sets whether to keep or recompute the parametrization of surfaces This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bUseSameParam.
- Parameters
-
in_state If true, the parametrization information for surfaces will be retained, otherwise it will be recalculated.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ SetPeriodicFaceSplitting()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::SetPeriodicFaceSplitting | ( | bool | in_state | ) |
Sets whether to split periodic faces. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bSplitFaces.
- Parameters
-
in_state Whether to split periodic faces on parametric seams.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ SetTolerance()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::SetTolerance | ( | double | in_tolerance | ) |
Sets the tolerance for the conversion. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_dTol.
- Parameters
-
in_tolerance The tolerance of the resulting BRep data. The value is relative to the scale of the model.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ SetUVCurvesComputation()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::SetUVCurvesComputation | ( | bool | in_state, |
bool | in_allow_cross_seam_curves | ||
) |
Sets whether to compute UV curves from BRep data.
- Parameters
-
in_state Whether to compute UV curves from BRep data. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bForceComputeUV. in_allow_cross_seam_curves Whether to allow UV curves to cross seams. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bAllowUVCrossingSeams.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ Show()
void HPS::Exchange::NURBSConversionOptionsKit::Show | ( | NURBSConversionOptionsKit & | out_kit | ) | const |
Copies this NURBSConversionOptionsKit into the given NURBSConversionOptionsKit.
- Parameters
-
out_kit The NURBSConversionOptionsKit to populate with the contents of this NURBSConversionOptionsKit.
◆ Show3DCurvesComputation()
bool HPS::Exchange::NURBSConversionOptionsKit::Show3DCurvesComputation | ( | bool & | out_state | ) | const |
Shows the 3D curve computation conversion setting.
- Parameters
-
out_state Whether 3D curves will be computed by the conversion
- Returns
- true if a 3D curve computation conversion setting was specified, false otherwise.
◆ ShowAllowedCurves()
bool HPS::Exchange::NURBSConversionOptionsKit::ShowAllowedCurves | ( | CurveTypeArray & | out_allowed_curves | ) | const |
Shows the allowed curves conversion setting.
- Parameters
-
out_allowed_curves The types of curves the conversion is allowed to produce.
- Returns
- true if an allowed curves conversion setting was specified, false otherwise.
◆ ShowAllowedSurfaces()
bool HPS::Exchange::NURBSConversionOptionsKit::ShowAllowedSurfaces | ( | SurfaceTypeArray & | out_allowed_surfaces | ) | const |
Shows the allowed surfaces conversion setting.
- Parameters
-
out_allowed_surfaces The types of surfaces the conversion is allowed to produce.
- Returns
- true if an allowed surfaces conversion setting was specified, false otherwise.
◆ ShowClosedFaceSplitting()
bool HPS::Exchange::NURBSConversionOptionsKit::ShowClosedFaceSplitting | ( | bool & | out_state | ) | const |
Shows the face splitting conversion setting.
- Parameters
-
out_state Whether faces will be split by the conversion
- Returns
- true if a closed face splitting conversion setting was specified, false otherwise.
◆ ShowCrossSeamCurveReplacement()
bool HPS::Exchange::NURBSConversionOptionsKit::ShowCrossSeamCurveReplacement | ( | bool & | out_state | ) | const |
Shows the cross seam curve replacement conversion setting.
- Parameters
-
out_state Whether cross seam curves are going to be replaced by the conversion
- Returns
- true if a cross seam replacement conversion setting was specified, false otherwise.
◆ ShowParameterization()
bool HPS::Exchange::NURBSConversionOptionsKit::ShowParameterization | ( | bool & | out_state | ) | const |
Shows the parameterization conversion setting.
- Parameters
-
out_state Whether existing parameterization will be maintained by the conversion
- Returns
- true if a parameterization conversion setting was specified, false otherwise.
◆ ShowPeriodicFaceSplitting()
bool HPS::Exchange::NURBSConversionOptionsKit::ShowPeriodicFaceSplitting | ( | bool & | out_state | ) | const |
Shows the periodic face splitting conversion setting.
- Parameters
-
out_state Whether periodic faces will be split by the conversion
- Returns
- true if a periodic face splitting conversion setting was specified, false otherwise.
◆ ShowTolerance()
bool HPS::Exchange::NURBSConversionOptionsKit::ShowTolerance | ( | double & | out_tolerance | ) | const |
Shows the tolerance conversion setting.
- Parameters
-
out_tolerance The tolerance that will be used for the conversion
- Returns
- true if a tolerance conversion setting was specified, false otherwise.
◆ ShowUVCurvesComputation()
bool HPS::Exchange::NURBSConversionOptionsKit::ShowUVCurvesComputation | ( | bool & | out_state, |
bool & | out_allow_cross_seam_curves | ||
) | const |
Shows the UV curve computation conversion setting.
- Parameters
-
out_state Whether UV curves will be computed by the conversion out_allow_cross_seam_curves Whether UV curves will be allowed to cross seams
- Returns
- true if a UV curve computation conversion setting was specified, false otherwise.
◆ Unset3DCurvesComputation()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::Unset3DCurvesComputation | ( | ) |
Removes the 3D curves computation conversion state.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ UnsetAllowedCurves()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::UnsetAllowedCurves | ( | ) |
Removes the allowed curves conversion state.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ UnsetAllowedSurfaces()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::UnsetAllowedSurfaces | ( | ) |
Removes the allowed surfaces conversion state.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ UnsetClosedFaceSplitting()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::UnsetClosedFaceSplitting | ( | ) |
Removes the closed face splitting conversion state.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ UnsetCrossSeamCurveReplacement()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::UnsetCrossSeamCurveReplacement | ( | ) |
Removes the cross seam replacement conversion state.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ UnsetEverything()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::UnsetEverything | ( | ) |
Removes all settings.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ UnsetParameterization()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::UnsetParameterization | ( | ) |
Removes the parameterization conversion state.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ UnsetPeriodicFaceSplitting()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::UnsetPeriodicFaceSplitting | ( | ) |
Removes the periodic face splitting conversion state.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ UnsetTolerance()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::UnsetTolerance | ( | ) |
Removes the tolerance conversion state.
- Returns
- A reference to this NURBSConversionOptionsKit.
◆ UnsetUVCurvesComputation()
NURBSConversionOptionsKit& HPS::Exchange::NURBSConversionOptionsKit::UnsetUVCurvesComputation | ( | ) |
Removes the UV curves computation conversion state.
- Returns
- A reference to this NURBSConversionOptionsKit.
The documentation for this class was generated from the following file:
- include/sprk_exchange.h