HPS::Exchange::NURBSConversionOptionsKit

class HPS.Exchange.NURBSConversionOptionsKit : public HPS.SprocketKit 

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.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this NURBSConversionOptionsKit has any values set on it.

Return: true if no values are set on this NURBSConversionOptionsKit, false otherwise.

bool Equals (HPS.Exchange.NURBSConversionOptionsKit in_kit)

Check if the source NURBSConversionOptionsKit is equivalent to this NURBSConversionOptionsKit.

Param in_kit: The source NURBSConversionOptionsKit to compare to this NURBSConversionOptionsKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

NURBSConversionOptionsKit (): The default constructor creates an empty NURBSConversionOptionsKit object.

NURBSConversionOptionsKit (HPS.Exchange.NURBSConversionOptionsKit in_kit)

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

Param in_kit: The source NURBSConversionOptionsKit to copy.

override HPS.Type ObjectType ()

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

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.Exchange.NURBSConversionOptionsKit in_kit)

Copies the source NURBSConversionOptionsKit into this NURBSConversionOptionsKit.

Param in_kit: The source NURBSConversionOptionsKit to copy.

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.

Param in_state: Whether to compute 3D curves from BRep data.
Return: A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit SetAllowedCurves (HPS.Exchange.CurveType[] 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.

Param in_allowed_curves: An array of curves which the conversion can produce.
Return: A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit SetAllowedSurfaces (HPS.Exchange.SurfaceType[] 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.

Param in_allowed_surfaces: An array of surfaces which the conversion can produce.
Return: A reference to this 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.

Param in_state: Whether to split closed faces at the parametric seam and mid-parameter.
Return: A reference to this 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.

Param in_state: Whether to replace UV curves which cross seams of periodic surfaces.
Return: A reference to this 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.

Param in_state: If true, the parametrization information for surfaces will be retained, otherwise it will be recalculated.
Return: A reference to this 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.

Param in_state: Whether to split periodic faces on parametric seams.
Return: A reference to this 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.

Param in_tolerance: The tolerance of the resulting BRep data. The value is relative to the scale of the model.
Return: A reference to this NURBSConversionOptionsKit.

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

Sets whether to compute UV curves from BRep data.

Param in_state: Whether to compute UV curves from BRep data. This corresponds to the value that will be passed to A3DCopyAndAdaptBrepModelData::m_bForceComputeUV.
Param 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.
Return: A reference to this NURBSConversionOptionsKit.

void Show (out HPS.Exchange.NURBSConversionOptionsKit out_kit)

Copies this NURBSConversionOptionsKit into the given NURBSConversionOptionsKit.

Param out_kit: The NURBSConversionOptionsKit to populate with the contents of this NURBSConversionOptionsKit.

bool Show3DCurvesComputation (out bool out_state)

Shows the 3D curve computation conversion setting.

Param out_state: Whether 3D curves will be computed by the conversion
Return: true if a 3D curve computation conversion setting was specified, false otherwise.

bool ShowAllowedCurves (out HPS.Exchange.CurveType[] out_allowed_curves)

Shows the allowed curves conversion setting.

Param out_allowed_curves: The types of curves the conversion is allowed to produce.
Return: true if an allowed curves conversion setting was specified, false otherwise.

bool ShowAllowedSurfaces (out HPS.Exchange.SurfaceType[] out_allowed_surfaces)

Shows the allowed surfaces conversion setting.

Param out_allowed_surfaces: The types of surfaces the conversion is allowed to produce.
Return: true if an allowed surfaces conversion setting was specified, false otherwise.

bool ShowClosedFaceSplitting (out bool out_state)

Shows the face splitting conversion setting.

Param out_state: Whether faces will be split by the conversion
Return: true if a closed face splitting conversion setting was specified, false otherwise.

bool ShowCrossSeamCurveReplacement (out bool out_state)

Shows the cross seam curve replacement conversion setting.

Param out_state: Whether cross seam curves are going to be replaced by the conversion
Return: true if a cross seam replacement conversion setting was specified, false otherwise.

bool ShowParameterization (out bool out_state)

Shows the parameterization conversion setting.

Param out_state: Whether existing parameterization will be maintained by the conversion
Return: true if a parameterization conversion setting was specified, false otherwise.

bool ShowPeriodicFaceSplitting (out bool out_state)

Shows the periodic face splitting conversion setting.

Param out_state: Whether periodic faces will be split by the conversion
Return: true if a periodic face splitting conversion setting was specified, false otherwise.

bool ShowTolerance (out double out_tolerance)

Shows the tolerance conversion setting.

Param out_tolerance: The tolerance that will be used for the conversion
Return: true if a tolerance conversion setting was specified, false otherwise.

bool ShowUVCurvesComputation (out bool out_state, out bool out_allow_cross_seam_curves)

Shows the UV curve computation conversion setting.

Param out_state: Whether UV curves will be computed by the conversion
Param out_allow_cross_seam_curves: Whether UV curves will be allowed to cross seams
Return: true if a UV curve computation conversion setting was specified, false otherwise.

HPS.Exchange.NURBSConversionOptionsKit Unset3DCurvesComputation ()

Removes the 3D curves computation conversion state.

Return: A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetAllowedCurves ()

Removes the allowed curves conversion state.

Return: A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetAllowedSurfaces ()

Removes the allowed surfaces conversion state.

Return: A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetClosedFaceSplitting ()

Removes the closed face splitting conversion state.

Return: A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetCrossSeamCurveReplacement ()

Removes the cross seam replacement conversion state.

Return: A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetEverything ()

Removes all settings.

Return: A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetParameterization ()

Removes the parameterization conversion state.

Return: A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetPeriodicFaceSplitting ()

Removes the periodic face splitting conversion state.

Return: A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetTolerance ()

Removes the tolerance conversion state.

Return: A reference to this NURBSConversionOptionsKit.

HPS.Exchange.NURBSConversionOptionsKit UnsetUVCurvesComputation ()

Removes the UV curves computation conversion state.

Return: A reference to this NURBSConversionOptionsKit.

Public Static Functions

HPS.Exchange.NURBSConversionOptionsKit GetDefault ()

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.

Return: A NURBSConversionOptionsKit with the default settings.

bool operator!= (HPS.Exchange.NURBSConversionOptionsKit a, HPS.Exchange.NURBSConversionOptionsKit b)

bool operator== (HPS.Exchange.NURBSConversionOptionsKit a, HPS.Exchange.NURBSConversionOptionsKit b)