HPS.Exchange.NURBSConversionOptionsKit Class Reference
Inheritance diagram for HPS.Exchange.NURBSConversionOptionsKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.NURBSConversionOptionsKit in_kit)
 
override int GetHashCode ()
 
 NURBSConversionOptionsKit ()
 
 NURBSConversionOptionsKit (HPS.Exchange.NURBSConversionOptionsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.NURBSConversionOptionsKit in_kit)
 
HPS.Exchange.NURBSConversionOptionsKit Set3DCurvesComputation (bool in_state)
 
HPS.Exchange.NURBSConversionOptionsKit SetAllowedCurves (HPS.Exchange.CurveType[] in_allowed_curves)
 
HPS.Exchange.NURBSConversionOptionsKit SetAllowedSurfaces (HPS.Exchange.SurfaceType[] in_allowed_surfaces)
 
HPS.Exchange.NURBSConversionOptionsKit SetClosedFaceSplitting (bool in_state)
 
HPS.Exchange.NURBSConversionOptionsKit SetCrossSeamCurveReplacement (bool in_state)
 
HPS.Exchange.NURBSConversionOptionsKit SetParameterization (bool in_state)
 
HPS.Exchange.NURBSConversionOptionsKit SetPeriodicFaceSplitting (bool in_state)
 
HPS.Exchange.NURBSConversionOptionsKit SetTolerance (double in_tolerance)
 
HPS.Exchange.NURBSConversionOptionsKit SetUVCurvesComputation (bool in_state, bool in_allow_cross_seam_curves)
 
void Show (out HPS.Exchange.NURBSConversionOptionsKit out_kit)
 
bool Show3DCurvesComputation (out bool out_state)
 
bool ShowAllowedCurves (out HPS.Exchange.CurveType[] out_allowed_curves)
 
bool ShowAllowedSurfaces (out HPS.Exchange.SurfaceType[] out_allowed_surfaces)
 
bool ShowClosedFaceSplitting (out bool out_state)
 
bool ShowCrossSeamCurveReplacement (out bool out_state)
 
bool ShowParameterization (out bool out_state)
 
bool ShowPeriodicFaceSplitting (out bool out_state)
 
bool ShowTolerance (out double out_tolerance)
 
bool ShowUVCurvesComputation (out bool out_state, out bool out_allow_cross_seam_curves)
 
HPS.Exchange.NURBSConversionOptionsKit Unset3DCurvesComputation ()
 
HPS.Exchange.NURBSConversionOptionsKit UnsetAllowedCurves ()
 
HPS.Exchange.NURBSConversionOptionsKit UnsetAllowedSurfaces ()
 
HPS.Exchange.NURBSConversionOptionsKit UnsetClosedFaceSplitting ()
 
HPS.Exchange.NURBSConversionOptionsKit UnsetCrossSeamCurveReplacement ()
 
HPS.Exchange.NURBSConversionOptionsKit UnsetEverything ()
 
HPS.Exchange.NURBSConversionOptionsKit UnsetParameterization ()
 
HPS.Exchange.NURBSConversionOptionsKit UnsetPeriodicFaceSplitting ()
 
HPS.Exchange.NURBSConversionOptionsKit UnsetTolerance ()
 
HPS.Exchange.NURBSConversionOptionsKit UnsetUVCurvesComputation ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Exchange.NURBSConversionOptionsKit GetDefault ()
 
static bool operator!= (HPS.Exchange.NURBSConversionOptionsKit a, HPS.Exchange.NURBSConversionOptionsKit b)
 
static bool operator== (HPS.Exchange.NURBSConversionOptionsKit a, HPS.Exchange.NURBSConversionOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/2]

HPS.Exchange.NURBSConversionOptionsKit.NURBSConversionOptionsKit ( )
inline

The default constructor creates an empty NURBSConversionOptionsKit object.

◆ NURBSConversionOptionsKit() [2/2]

HPS.Exchange.NURBSConversionOptionsKit.NURBSConversionOptionsKit ( HPS.Exchange.NURBSConversionOptionsKit  in_kit)
inline

The copy constructor creates a new NURBSConversionOptionsKit object that contains the same settings as the source NURBSConversionOptionsKit.

Parameters
in_kitThe source NURBSConversionOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Exchange.NURBSConversionOptionsKit.Empty ( )
inlinevirtual

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 ( HPS.Exchange.NURBSConversionOptionsKit  in_kit)
inline

Check if the source NURBSConversionOptionsKit is equivalent to this NURBSConversionOptionsKit.

Parameters
in_kitThe source NURBSConversionOptionsKit to compare to this NURBSConversionOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.GetDefault ( )
inlinestatic

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()

override HPS.Type HPS.Exchange.NURBSConversionOptionsKit.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.

◆ Set()

void HPS.Exchange.NURBSConversionOptionsKit.Set ( HPS.Exchange.NURBSConversionOptionsKit  in_kit)
inline

Copies the source NURBSConversionOptionsKit into this NURBSConversionOptionsKit.

Parameters
in_kitThe source NURBSConversionOptionsKit to copy.

◆ Set3DCurvesComputation()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.Set3DCurvesComputation ( bool  in_state)
inline

Sets whether to compute 3D curves from BRep data. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bForceCompute3D.

Parameters
in_stateWhether to compute 3D curves from BRep data.
Returns
A reference to this NURBSConversionOptionsKit.

◆ SetAllowedCurves()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.SetAllowedCurves ( HPS.Exchange.CurveType []  in_allowed_curves)
inline

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_curvesAn array of curves which the conversion can produce.
Returns
A reference to this NURBSConversionOptionsKit.

◆ SetAllowedSurfaces()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.SetAllowedSurfaces ( HPS.Exchange.SurfaceType []  in_allowed_surfaces)
inline

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_surfacesAn array of surfaces which the conversion can produce.
Returns
A reference to this NURBSConversionOptionsKit.

◆ SetClosedFaceSplitting()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.SetClosedFaceSplitting ( bool  in_state)
inline

Sets whether to split closed faces. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bSplitClosedFaces.

Parameters
in_stateWhether to split closed faces at the parametric seam and mid-parameter.
Returns
A reference to this NURBSConversionOptionsKit.

◆ SetCrossSeamCurveReplacement()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.SetCrossSeamCurveReplacement ( bool  in_state)
inline

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_stateWhether to replace UV curves which cross seams of periodic surfaces.
Returns
A reference to this NURBSConversionOptionsKit.

◆ SetParameterization()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.SetParameterization ( bool  in_state)
inline

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_stateIf true, the parametrization information for surfaces will be retained, otherwise it will be recalculated.
Returns
A reference to this NURBSConversionOptionsKit.

◆ SetPeriodicFaceSplitting()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.SetPeriodicFaceSplitting ( bool  in_state)
inline

Sets whether to split periodic faces. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bSplitFaces.

Parameters
in_stateWhether to split periodic faces on parametric seams.
Returns
A reference to this NURBSConversionOptionsKit.

◆ SetTolerance()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.SetTolerance ( double  in_tolerance)
inline

Sets the tolerance for the conversion. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_dTol.

Parameters
in_toleranceThe tolerance of the resulting BRep data. The value is relative to the scale of the model.
Returns
A reference to this NURBSConversionOptionsKit.

◆ SetUVCurvesComputation()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.SetUVCurvesComputation ( bool  in_state,
bool  in_allow_cross_seam_curves 
)
inline

Sets whether to compute UV curves from BRep data.

Parameters
in_stateWhether to compute UV curves from BRep data. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bForceComputeUV.
in_allow_cross_seam_curvesWhether 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 ( out HPS.Exchange.NURBSConversionOptionsKit  out_kit)
inline

Copies this NURBSConversionOptionsKit into the given NURBSConversionOptionsKit.

Parameters
out_kitThe NURBSConversionOptionsKit to populate with the contents of this NURBSConversionOptionsKit.

◆ Show3DCurvesComputation()

bool HPS.Exchange.NURBSConversionOptionsKit.Show3DCurvesComputation ( out bool  out_state)
inline

Shows the 3D curve computation conversion setting.

Parameters
out_stateWhether 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 ( out HPS.Exchange.CurveType []  out_allowed_curves)
inline

Shows the allowed curves conversion setting.

Parameters
out_allowed_curvesThe 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 ( out HPS.Exchange.SurfaceType []  out_allowed_surfaces)
inline

Shows the allowed surfaces conversion setting.

Parameters
out_allowed_surfacesThe 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 ( out bool  out_state)
inline

Shows the face splitting conversion setting.

Parameters
out_stateWhether 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 ( out bool  out_state)
inline

Shows the cross seam curve replacement conversion setting.

Parameters
out_stateWhether 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 ( out bool  out_state)
inline

Shows the parameterization conversion setting.

Parameters
out_stateWhether 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 ( out bool  out_state)
inline

Shows the periodic face splitting conversion setting.

Parameters
out_stateWhether 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 ( out double  out_tolerance)
inline

Shows the tolerance conversion setting.

Parameters
out_toleranceThe 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 ( out bool  out_state,
out bool  out_allow_cross_seam_curves 
)
inline

Shows the UV curve computation conversion setting.

Parameters
out_stateWhether UV curves will be computed by the conversion
out_allow_cross_seam_curvesWhether UV curves will be allowed to cross seams
Returns
true if a UV curve computation conversion setting was specified, false otherwise.

◆ Unset3DCurvesComputation()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.Unset3DCurvesComputation ( )
inline

Removes the 3D curves computation conversion state.

Returns
A reference to this NURBSConversionOptionsKit.

◆ UnsetAllowedCurves()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.UnsetAllowedCurves ( )
inline

Removes the allowed curves conversion state.

Returns
A reference to this NURBSConversionOptionsKit.

◆ UnsetAllowedSurfaces()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.UnsetAllowedSurfaces ( )
inline

Removes the allowed surfaces conversion state.

Returns
A reference to this NURBSConversionOptionsKit.

◆ UnsetClosedFaceSplitting()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.UnsetClosedFaceSplitting ( )
inline

Removes the closed face splitting conversion state.

Returns
A reference to this NURBSConversionOptionsKit.

◆ UnsetCrossSeamCurveReplacement()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.UnsetCrossSeamCurveReplacement ( )
inline

Removes the cross seam replacement conversion state.

Returns
A reference to this NURBSConversionOptionsKit.

◆ UnsetEverything()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.UnsetEverything ( )
inline

Removes all settings.

Returns
A reference to this NURBSConversionOptionsKit.

◆ UnsetParameterization()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.UnsetParameterization ( )
inline

Removes the parameterization conversion state.

Returns
A reference to this NURBSConversionOptionsKit.

◆ UnsetPeriodicFaceSplitting()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.UnsetPeriodicFaceSplitting ( )
inline

Removes the periodic face splitting conversion state.

Returns
A reference to this NURBSConversionOptionsKit.

◆ UnsetTolerance()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.UnsetTolerance ( )
inline

Removes the tolerance conversion state.

Returns
A reference to this NURBSConversionOptionsKit.

◆ UnsetUVCurvesComputation()

HPS.Exchange.NURBSConversionOptionsKit HPS.Exchange.NURBSConversionOptionsKit.UnsetUVCurvesComputation ( )
inline

Removes the UV curves computation conversion state.

Returns
A reference to this NURBSConversionOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs