All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATGSMUseItf Interface CATIGSMUseCurveSmooth

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATIGSMUseCurveSmooth

Interface to curve smoothing operation feature.
Role: Allows you to access (query and modifications) data of the curve smoothing operation.

See also:

Method Index

o AddFrozenCurveSegment(CATIMmiMechanicalFeature_var&): Adds a frozen curve segment.
o AddFrozenPoint(CATIMmiMechanicalFeature_var&): Adds a frozen point.
o GetCorrectionMode(enum CATGSMCSCorrectionMode&): Gets the correction mode (threshold, point, tangency or curvature) applied to the smoothed curve (default is threshold).
o GetCurvatureThreshold(double&): Gets the curvature deviation threshold value.
o GetCurvatureThreshold(CATICkeParm_var&): Gets the curvature deviation threshold literal feature.
o GetCurvatureThresholdActivity(CATBoolean&): Gets the curvature deviation threshold activity (whether it is taken into account or not).
o GetCurveToSmooth(CATIMmiMechanicalFeature_var&): Gets the curve to smooth.
o GetEndExtremityContinuityCondition(enum CATGSMContinuity&): Gets the continuity condition (curvature, tangency or point) applied to the smoothed curve with regard to the input curve (default is curvature) at the end extremity of the input curve.
o GetFrozenCurveSegments(CATLISTV(CATIMmiMechanicalFeature_var)&): Gets all frozen curve segments.
o GetFrozenPoints(CATLISTV(CATIMmiMechanicalFeature_var)&): Gets all frozen points.
o GetMaximumDeviation(double&): Sets the maximum deviation allowed for smoothing operation.
o GetMaximumDeviation(CATICkeParm_var&): Gets the maximum deviation allowed for smoothing operation.
o GetMaximumDeviationActivity(CATBoolean&): Gets the maximum deviation activity (whether it is taken into account or not).
o GetStartExtremityContinuityCondition(enum CATGSMContinuity&): Gets the continuity condition (curvature, tangency or point) applied to the smoothed curve with regard to the input curve (default is curvature) at the start extremity of the input curve.
o GetSupport(CATIMmiMechanicalFeature_var&): Gets optional curve support surface.
o GetTangencyThreshold(double&): Gets the tangency deviation threshold value.
o GetTangencyThreshold(CATICkeParm_var&): Gets the tangency deviation threshold literal feature.
o GetTopologySimplificationActivity(CATBoolean&): Gets the topology simplification activity (whether continuous vertices are erased or not).
o RemoveAllFrozenCurveSegments(): Removes all frozen curve segments.
o RemoveAllFrozenPoints(): Removes all frozen points.
o RemoveFrozenCurveSegment(CATIMmiMechanicalFeature_var&): Removes a frozen curve segment.
o RemoveFrozenPoint(CATIMmiMechanicalFeature_var&): Removes a frozen point.
o SetCorrectionMode(enum CATGSMCSCorrectionMode): Sets the correction mode (threshold, point, tangency or curvature) applied to the smoothed curve (default is threshold).
o SetCurvatureThreshold(double): Sets the curvature deviation threshold value.
o SetCurvatureThreshold(CATICkeParm_var): Sets the curvature deviation threshold literal feature.
o SetCurvatureThresholdActivity(CATBoolean): Sets the curvature deviation threshold activity (whether it is taken into account or not).
o SetCurveToSmooth(CATIMmiMechanicalFeature_var): Sets the curve to smooth.
o SetEndExtremityContinuityCondition(enum CATGSMContinuity): Sets the continuity condition (curvature, tangency or point) applied to the smoothed curve with regard to the input curve (default is curvature) at the end extremity of the input curve.
o SetMaximumDeviation(double): Sets the maximum deviation allowed for smoothing operation.
o SetMaximumDeviation(CATICkeParm_var): Gets the maximum deviation allowed for smoothing operation.
o SetMaximumDeviationActivity(CATBoolean): Sets the maximum deviation activity (whether it is taken into account or not).
o SetStartExtremityContinuityCondition(enum CATGSMContinuity): Sets the continuity condition (curvature, tangency or point) applied to the smoothed curve with regard to the input curve (default is curvature) at the start extremity of the input curve.
o SetSupport(CATIMmiMechanicalFeature_var): Sets optional curve support surface.
o SetTangencyThreshold(double): Sets the tangency deviation threshold value.
o SetTangencyThreshold(CATICkeParm_var): Sets the tangency deviation threshold literal feature.
o SetTopologySimplificationActivity(CATBoolean): Activates or deactivates topology simplification (whether continuous vertices are erased or not).

Methods

o AddFrozenCurveSegment

public virtual AddFrozenCurveSegment( const iElem)

Adds a frozen curve segment.

Parameters:

iElem: Frozen curve segment

o AddFrozenPoint

public virtual AddFrozenPoint( const iElem)

Adds a frozen point.

Parameters:

iElem: Frozen point

o GetCorrectionMode

public virtual GetCorrectionMode( oCorrectionMode)

Gets the correction mode (threshold, point, tangency or curvature) applied to the smoothed curve (default is threshold).

Parameters:

oCorrectionMode: Output continuity condition (CATGSMCSCorrectionMode_Threshold, CATGSMCSCorrectionMode_Point, CATGSMCSCorrectionMode_Tangency or CATGSMCSCorrectionMode_Curvature)

o GetCurvatureThreshold

public virtual GetCurvatureThreshold( val)

Gets the curvature deviation threshold value.
This threshold is a ratio between 0 and 1.
if sets to 0, all curvature discontinuities are smoothed.
if sets to 1, no curvature discontinuity is smoothed.

Parameters:

val: Tangency deviation threshold value

o GetCurvatureThreshold

public virtual GetCurvatureThreshold( Elem)

Gets the curvature deviation threshold literal feature.
This threshold is a ratio between 0 and 1
if sets to 0, all curvature discontinuities are smoothed.
if sets to 1, no curvature discontinuity is smoothed.

Parameters:

Elem: Tangency deviation threshold literal feature

o GetCurvatureThresholdActivity

public virtual GetCurvatureThresholdActivity( bAct)

Gets the curvature deviation threshold activity (whether it is taken into account or not).
This activity is a CATBoolean (TRUE or FALSE).

Parameters:

bAct: Curvature deviation threshold activity

o GetCurveToSmooth

public virtual GetCurveToSmooth( oElem)

Gets the curve to smooth.

Parameters:

oElem: Curve feature

o GetEndExtremityContinuityCondition

public virtual GetEndExtremityContinuityCondition( oEndCond)

Gets the continuity condition (curvature, tangency or point) applied to the smoothed curve with regard to the input curve (default is curvature) at the end extremity of the input curve.

Parameters:

oEndCond: Output continuity condition (CATGSMContinuity_Point, CATGSMContinuity_Tangency or CATGSMContinuity_Curvature)

o GetFrozenCurveSegments

public virtual GetFrozenCurveSegments( oElems)

Gets all frozen curve segments.

Parameters:

oElems: List of the frozen curve segments

o GetFrozenPoints

public virtual GetFrozenPoints( oElems)

Gets all frozen points.

Parameters:

oElems: List of the frozen points

o GetMaximumDeviation

public virtual GetMaximumDeviation( val)

Sets the maximum deviation allowed for smoothing operation.
Sets in distance unit, it corresponds to the radius of a pipe around the input curve in which the result is allowed to be.

Parameters:

val: Maximum deviation value
Note: value is expressed in MKS = Meters
Example to set up 1mm , use .001

o GetMaximumDeviation

public virtual GetMaximumDeviation( Elem)

Gets the maximum deviation allowed for smoothing operation.
Sets in distance unit, it corresponds to the radius of a pipe around the input curve in which the result is allowed to be.

Parameters:

Elem: Maximum deviation literal feature

o GetMaximumDeviationActivity

public virtual GetMaximumDeviationActivity( bAct)

Gets the maximum deviation activity (whether it is taken into account or not).
This activity is a CATBoolean (TRUE or FALSE).

Parameters:

bAct: Maximum deviation activity

o GetStartExtremityContinuityCondition

public virtual GetStartExtremityContinuityCondition( oStartCond)

Gets the continuity condition (curvature, tangency or point) applied to the smoothed curve with regard to the input curve (default is curvature) at the start extremity of the input curve.

Parameters:

oStartCond: Output continuity condition (CATGSMContinuity_Point, CATGSMContinuity_Tangency or CATGSMContinuity_Curvature)

o GetSupport

public virtual GetSupport( oElem)

Gets optional curve support surface.

Parameters:

oElem: Support surface feature

o GetTangencyThreshold

public virtual GetTangencyThreshold( val)

Gets the tangency deviation threshold value.
This threshold is to be compared with the angle of both tangency lines at the discontinuity.
Over this threshold, tangency discontinuities won't be smoothed.

Parameters:

val: Tangency deviation threshold value

o GetTangencyThreshold

public virtual GetTangencyThreshold( Elem)

Gets the tangency deviation threshold literal feature.
This threshold is to be compared with the angle of both tangency lines at the discontinuity.
Over this threshold, tangency discontinuities won't be smoothed.

Parameters:

Elem: Tangency deviation threshold literal feature

o GetTopologySimplificationActivity

public virtual GetTopologySimplificationActivity( bAct)

Gets the topology simplification activity (whether continuous vertices are erased or not).
This activity is a CATBoolean (TRUE or FALSE).

Parameters:

bAct: Topology simplification activity

o RemoveAllFrozenCurveSegments

public virtual RemoveAllFrozenCurveSegments(

)

Removes all frozen curve segments.

o RemoveAllFrozenPoints

public virtual RemoveAllFrozenPoints(

)

Removes all frozen points.

o RemoveFrozenCurveSegment

public virtual RemoveFrozenCurveSegment( const iElem)

Removes a frozen curve segment.

Parameters:

iElem: Frozen curve segment to be removed

o RemoveFrozenPoint

public virtual RemoveFrozenPoint( const iElem)

Removes a frozen point.

Parameters:

iElem: Frozen point to be removed

o SetCorrectionMode

public virtual SetCorrectionMode( const iCorrectionMode)

Sets the correction mode (threshold, point, tangency or curvature) applied to the smoothed curve (default is threshold).

Parameters:

oCorrectionMode: Input continuity condition (CATGSMCSCorrectionMode_Threshold, CATGSMCSCorrectionMode_Point, CATGSMCSCorrectionMode_Tangency or CATGSMCSCorrectionMode_Curvature)

o SetCurvatureThreshold

public virtual SetCurvatureThreshold( const val)

Sets the curvature deviation threshold value.
This threshold is a ratio between 0 and 1
if sets to 0, all curvature discontinuities are smoothed
if sets to 1, no curvature discontinuity is smoothed.

Parameters:

val: Tangency deviation threshold value

o SetCurvatureThreshold

public virtual SetCurvatureThreshold( const Elem)

Sets the curvature deviation threshold literal feature.
This threshold is a ratio between 0 and 1.
if sets to 0, all curvature discontinuities are smoothed.
if sets to 1, no curvature discontinuity is smoothed.

Parameters:

Elem: Tangency deviation threshold literal feature

o SetCurvatureThresholdActivity

public virtual SetCurvatureThresholdActivity( const bAct)

Sets the curvature deviation threshold activity (whether it is taken into account or not).
This activity is a CATBoolean (TRUE or FALSE).

Parameters:

bAct: Curvature deviation threshold activity

o SetCurveToSmooth

public virtual SetCurveToSmooth( const iElem)

Sets the curve to smooth.

Parameters:

iElem: Curve feature

o SetEndExtremityContinuityCondition

public virtual SetEndExtremityContinuityCondition( const iEndCond)

Sets the continuity condition (curvature, tangency or point) applied to the smoothed curve with regard to the input curve (default is curvature) at the end extremity of the input curve.

Parameters:

iEndCond: Input continuity condition (CATGSMContinuity_Point, CATGSMContinuity_Tangency or CATGSMContinuity_Curvature)

o SetMaximumDeviation

public virtual SetMaximumDeviation( const val)

Sets the maximum deviation allowed for smoothing operation.
Sets in distance unit, it corresponds to the radius of a pipe around the input curve in which the result is allowed to be.

Parameters:

val: Maximum deviation value
Note: value is expressed in MKS = Meters
Example to set up 1mm , use .001

o SetMaximumDeviation

public virtual SetMaximumDeviation( const Elem)

Gets the maximum deviation allowed for smoothing operation.
Sets in distance unit, it corresponds to the radius of a pipe around the input curve in which the result is allowed to be.

Parameters:

Elem: Maximum deviation literal feature

o SetMaximumDeviationActivity

public virtual SetMaximumDeviationActivity( const bAct)

Sets the maximum deviation activity (whether it is taken into account or not).
This activity is a CATBoolean (TRUE or FALSE).

Parameters:

bAct: Maximum deviation activity

o SetStartExtremityContinuityCondition

public virtual SetStartExtremityContinuityCondition( const iStartCond)

Sets the continuity condition (curvature, tangency or point) applied to the smoothed curve with regard to the input curve (default is curvature) at the start extremity of the input curve.

Parameters:

iStartCond: Input continuity condition (CATGSMContinuity_Point, CATGSMContinuity_Tangency or CATGSMContinuity_Curvature)

o SetSupport

public virtual SetSupport( const iElem)

Sets optional curve support surface.

Parameters:

iElem: Support surface feature

o SetTangencyThreshold

public virtual SetTangencyThreshold( const val)

Sets the tangency deviation threshold value.
This threshold is to be compared with the angle of both tangency lines at the discontinuity.
Over this threshold, tangency discontinuities won't be smoothed.

Parameters:

val: Tangency deviation threshold value

o SetTangencyThreshold

public virtual SetTangencyThreshold( const Elem)

Sets the tangency deviation threshold literal feature.
This threshold is to be compared with the angle of both tangency lines at the discontinuity.
Over this threshold, tangency discontinuities won't be smoothed.

Parameters:

Elem: Tangency deviation threshold literal feature

o SetTopologySimplificationActivity

public virtual SetTopologySimplificationActivity( const bAct)

Activates or deactivates topology simplification (whether continuous vertices are erased or not).
This activity is a CATBoolean (TRUE or FALSE).

Parameters:

bAct: Topology simplification activity

This object is included in the file: CATIGSMUseCurveSmooth.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf