CATGSMUseItf Interface CATIGSMUseSweepConic
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUseSweepConic
Interace to conical sweep feature.
Role: Allows you to access data of the conical sweep.
- See also:
-
Method Index
- o
GetCanonicalDetectionMode(CATGSMCanonicalSurfaceDetection&)
- Gets information about detection of canonical surfaces of the output surface.
- o
GetGuide(CATIMmiMechanicalFeature_var&,int)
- Gets a guide curve given its index (default = 1).
- o
GetGuideDeviation(double&)
- Gets deviation value (length) from guide curves allowed during sweeping
operation in order to smooth it.
- o
GetGuideDeviation(CATICkeParm_var&)
- Gets deviation value (length) from guide curves allowed during sweeping
operation in order to smooth it.
- o
GetGuideDeviationActivity(CATBoolean&)
- Gets information whether a deviation from guide curves is allowed or not
during sweeping operation in order to smooth it.
- o
GetLongitudinalRelimiters(CATIMmiMechanicalFeature_var&,CATBoolean&,CATIMmiMechanicalFeature_var&,CATBoolean&)
- Gets the elements relimiting the spine (or the default spine).
- o
GetNbGuide(int&)
- Gets the number of guide curves.
- o
GetParameter(double&)
- Gets the conical parameter value.
- o
GetParameter(CATICkeParm_var&)
- Gets the literal feature representing the conical parameter.
- o
GetParameterLaw(CATICkeLaw_var&)
- Gets conical parameter law feature.
- o
GetParameterLaw(double&,double&,enum CATGSMBasicLawType&)
- Gets the values and the law type representing the conical parameter law.
- o
GetParameterLaw(CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType&)
- Gets the literal features and the law type representing the conical parameter
law.
- o
GetParameterLawInversion(CATBoolean&)
- Gets information whether parameter law has to be inverted or not.
- o
GetParameterLawType(enum CATGSMBasicLawType&)
- Gets parameter law type.
- o
GetSmoothActivity(CATBoolean&)
- Gets information whether sweeping operation is smoothed or not.
- o
GetSmoothAngleThreshold(double&)
- Gets angular threshold under which discontinuities (moving frame,
tangency net on reference surface) will be smoothed when sweeping.
- o
GetSmoothAngleThreshold(CATICkeParm_var&)
- Gets angular threshold under which discontinuities (moving frame,
tangency net on reference surface) will be smoothed when sweeping.
- o
GetSpine(CATIMmiMechanicalFeature_var&)
- Gets the spine.
- o
GetTangency(CATIMmiMechanicalFeature_var&,CATICkeLaw_var&,int)
- Gets tangency surface or curve and its angle given the guide curve index.
- o
GetTangency(CATIMmiMechanicalFeature_var&,CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType&,int)
- Gets tangency surface or curve and its angle given the guide curve index.
- o
GetTangencyAngleLawInversion(int,CATBoolean&)
- Gets information whether tangency angle law has to be inverted or not
for a specified guide curve.
- o
InsertGuideAtPosition(CATIMmiMechanicalFeature_var,int)
- Insert a guide at a given position.
- o
RemoveGuide(int)
- Removes a guide curve given its index (default = 1).
- o
RemoveParameter()
- Removes conical sweep parameter, whether it is a single value or a law.
- o
RemoveTangency(int)
- Removes tangency surface or curve and its angle given the guide curve index.
- o
SetCanonicalDetectionMode(CATGSMCanonicalSurfaceDetection)
- Sets information about detection of canonical surfaces of the output surface.
- o
SetGuide(CATIMmiMechanicalFeature_var,int)
- Sets a guide curve given its index (default = 1).
- o
SetGuideDeviation(double)
- Sets deviation value (length) from guide curves allowed during sweeping
operation in order to smooth it.
- o
SetGuideDeviation(CATICkeParm_var&)
- Sets deviation value (length) from guide curves allowed during sweeping
operation in order to smooth it.
- o
SetGuideDeviationActivity(CATBoolean)
- Sets information whether a deviation from guide curves is allowed or not
during sweeping operation in order to smooth it.
- o
SetLongitudinalRelimiters(CATIMmiMechanicalFeature_var&,CATBoolean,CATIMmiMechanicalFeature_var&,CATBoolean)
- Sets the elements relimiting the spine (or the default spine).
- o
SetParameter(double)
- Sets the conical parameter value.
- o
SetParameter(CATICkeParm_var)
- Sets the literal feature representing the conical parameter.
- o
SetParameterLaw(CATICkeLaw_var)
- Sets conical parameter law feature.
- o
SetParameterLaw(double,double,enum CATGSMBasicLawType)
- Sets the values and the law type representing the conical parameter law.
- o
SetParameterLaw(CATICkeParm_var,CATICkeParm_var,enum CATGSMBasicLawType)
- Sets the literal features and the law type representing the conical parameter
law.
- o
SetParameterLawInversion(CATBoolean)
- Sets information whether parameter law has to be inverted or not.
- o
SetParameterLawType(enum CATGSMBasicLawType)
- Sets parameter law type.
- o
SetSmoothActivity(CATBoolean)
- Sets information whether sweeping operation is smoothed or not.
- o
SetSmoothAngleThreshold(double)
- Sets angular threshold under which discontinuities (moving frame,
tangency net on reference surface) will be smoothed when sweeping.
- o
SetSmoothAngleThreshold(CATICkeParm_var&)
- Sets angular threshold under which discontinuities (moving frame,
tangency net on reference surface) will be smoothed when sweeping.
- o
SetSpine(CATIMmiMechanicalFeature_var)
- Sets the spine.
- o
SetTangency(CATIMmiMechanicalFeature_var,CATICkeLaw_var,int)
- Sets tangency surface or curve and its angle given the guide curve index.
- o
SetTangency(CATIMmiMechanicalFeature_var,CATICkeParm_var,CATICkeParm_var,enum CATGSMBasicLawType&,int)
- Sets tangency surface or curve and its angle given the guide curve index.
- o
SetTangencyAngleLawInversion(int,CATBoolean)
- Sets information whether tangency angle law has to be inverted or not
for a specified guide curve.
Methods
o GetCanonicalDetectionMode
| public virtual GetCanonicalDetectionMode( | | oDetection) |
-
Gets information about detection of canonical surfaces of the output surface.
- Parameters:
-
- oDetection
- If canonical surfaces are detected or not.
Possible values are CATGSMNoDetection and CATGSMCanonicalDetection.
- See also:
-
o GetGuide
| public virtual GetGuide( | | oElem, |
| const | iI | = 1) |
-
Gets a guide curve given its index (default = 1).
- Parameters:
-
- oElem
- Guide curve feature.
- iI
- Guide curve index : 1 to 5.
o GetGuideDeviation
| public virtual GetGuideDeviation( | | oElem) |
-
Gets deviation value (length) from guide curves allowed during sweeping
operation in order to smooth it.
- Parameters:
-
- oElem
- Numerical value.
o GetGuideDeviation
| public virtual GetGuideDeviation( | | oElem) |
-
Gets deviation value (length) from guide curves allowed during sweeping
operation in order to smooth it.
- Parameters:
-
- oElem
- Length literal feature.
o GetGuideDeviationActivity
| public virtual GetGuideDeviationActivity( | | oActi) |
-
Gets information whether a deviation from guide curves is allowed or not
during sweeping operation in order to smooth it.
- Parameters:
-
- oSmooth
- TRUE or FALSE (FALSE if not specified).
o GetLongitudinalRelimiters
| public virtual GetLongitudinalRelimiters( | | oElem1, |
| | boInv1, |
| | oElem2, |
| | boInv2) |
-
Gets the elements relimiting the spine (or the default spine).
- Parameters:
-
- oElem1
- First relimiting feature (plane or point)
- boInv1
- Split direction for the first relimitation
FALSE means that the beginning of the spine (considering its orientation) is removed, TRUE means that the end of the spine is removed
- oElem2
- Second relimiting feature (plane or point)
- boInv2
- Split direction for the second relimitation
o GetNbGuide
| public virtual GetNbGuide( | | oI) |
-
Gets the number of guide curves.
- Parameters:
-
- oI
- Number of guide curves.
o GetParameter
| public virtual GetParameter( | | oElem) |
-
Gets the conical parameter value. If the parameter is a law, oElem equals 0
and the method returns E_FAIL.
- Parameters:
-
- oElem
- Parameter value.
- See also:
-
o GetParameter
| public virtual GetParameter( | | oElem) |
-
Gets the literal feature representing the conical parameter. If the parameter
is a law, oElem equals NULL_var and the method returns E_FAIL.
- Parameters:
-
- oElem
- Parameter literal feature.
- See also:
-
o GetParameterLaw
| public virtual GetParameterLaw( | | oElem) |
-
Gets conical parameter law feature.
- Parameters:
-
- Elem
- Conical parameter law feature
- See also:
-
o GetParameterLaw
| public virtual GetParameterLaw( | | oParamStart, |
| | oParamEnd, |
| | oType) |
-
Gets the values and the law type representing the conical parameter law.
- Parameters:
-
- oParamStart
- Parameter start value.
- oParamEnd
- Parameter end value.
- oType
- Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
- See also:
-
o GetParameterLaw
| public virtual GetParameterLaw( | | oParamStart, |
| | oParamEnd, |
| | oType) |
-
Gets the literal features and the law type representing the conical parameter
law.
- Parameters:
-
- oParamStart
- Start parameter literal feature.
- oParamEnd
- End parameter literal feature.
- oType
- Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
- See also:
-
o GetParameterLawInversion
| public virtual GetParameterLawInversion( | | oInversion) |
-
Gets information whether parameter law has to be inverted or not.
- Parameters:
-
- oInversion
- TRUE or FALSE (FALSE if not specified).
- See also:
-
o GetParameterLawType
| public virtual GetParameterLawType( | | eType) |
-
Gets parameter law type.
- Parameters:
-
- eType
- Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
- See also:
-
o GetSmoothActivity
| public virtual GetSmoothActivity( | | oSmooth) |
-
Gets information whether sweeping operation is smoothed or not.
- Parameters:
-
- oSmooth
- TRUE or FALSE (FALSE if not specified).
o GetSmoothAngleThreshold
| public virtual GetSmoothAngleThreshold( | | oElem) |
-
Gets angular threshold under which discontinuities (moving frame,
tangency net on reference surface) will be smoothed when sweeping.
- Parameters:
-
- oElem
- Numerical value.
o GetSmoothAngleThreshold
| public virtual GetSmoothAngleThreshold( | | oElem) |
-
Gets angular threshold under which discontinuities (moving frame,
tangency net on reference surface) will be smoothed when sweeping.
- Parameters:
-
- oElem
- Angular literal feature.
o GetSpine
| public virtual GetSpine( | | oElem) |
-
Gets the spine.
- Parameters:
-
- oElem
- Spine feature.
o GetTangency
| public virtual GetTangency( | | oElem, |
| | oAngleLaw, |
| const | iI) |
-
Gets tangency surface or curve and its angle given the guide curve index.
- Parameters:
-
- oElem
- Tangency surface or curve feature.
- oAngleLaw
- Start tangency angle from surface or curve reference.
- iI
- Guide curve index : 1 to 5.
o GetTangency
| public virtual GetTangency( | | oElem, |
| | oAngleStart, |
| | oAngleEnd, |
| | oType, |
| const | iI) |
-
Gets tangency surface or curve and its angle given the guide curve index.
- Parameters:
-
- oElem
- Tangency surface or curve feature.
- oAngleStart
- Start tangency angle from surface or curve reference.
- oAngleEnd
- End tangency angle from surface or curve reference.
- oAngleLawType
- Type of law used for tangency angle from surface or curve reference.
- iI
- Guide curve index : 1 to 5.
o GetTangencyAngleLawInversion
| public virtual GetTangencyAngleLawInversion( | const | iI, |
| | oInversion) |
-
Gets information whether tangency angle law has to be inverted or not
for a specified guide curve.
- Parameters:
-
- iI
- Guide curve index : 1 to 5.
- oInversion
- TRUE or FALSE (FALSE if not specified).
- See also:
-
o InsertGuideAtPosition
| public virtual InsertGuideAtPosition( | const | iElem, |
| const | iI) |
-
Insert a guide at a given position. Impossible if the number of guides
has already reached 5.
- Parameters:
-
- iElem
- Guide curve feature.
- iI
- Guide curve index : 1 to 5.
o RemoveGuide
| public virtual RemoveGuide( | const | iI | = 1) |
-
Removes a guide curve given its index (default = 1). Also removes tangency
element if specified.
- Parameters:
-
- iI
- Guide curve index : 1 to 5. If 0, all guides are removed.
o RemoveParameter
| public virtual RemoveParameter( | ) |
-
Removes conical sweep parameter, whether it is a single value or a law.
o RemoveTangency
| public virtual RemoveTangency( | const | iI) |
-
Removes tangency surface or curve and its angle given the guide curve index.
- Parameters:
-
- iI
- Guide curve index : 1 to 5.
o SetCanonicalDetectionMode
| public virtual SetCanonicalDetectionMode( | | iDetection | = CATGSMNoDetection) |
-
Sets information about detection of canonical surfaces of the output surface.
- Parameters:
-
- iDetection
- If canonical surfaces are detected or not.
Possible values are CATGSMNoDetection and CATGSMCanonicalDetection.
- See also:
-
o SetGuide
| public virtual SetGuide( | const | iElem, |
| const | iI | = 1) |
-
Sets a guide curve given its index (default = 1).
- Parameters:
-
- iElem
- Guide curve feature.
- iI
- Guide curve index : 1 to 5.
o SetGuideDeviation
| public virtual SetGuideDeviation( | const | iElem) |
-
Sets deviation value (length) from guide curves allowed during sweeping
operation in order to smooth it.
- Parameters:
-
- iElem
- Numerical value.
o SetGuideDeviation
| public virtual SetGuideDeviation( | const | iElem) |
-
Sets deviation value (length) from guide curves allowed during sweeping
operation in order to smooth it.
- Parameters:
-
- iElem
- Length literal feature.
o SetGuideDeviationActivity
| public virtual SetGuideDeviationActivity( | const | iActi) |
-
Sets information whether a deviation from guide curves is allowed or not
during sweeping operation in order to smooth it.
- Parameters:
-
- iSmooth
- TRUE or FALSE.
o SetLongitudinalRelimiters
| public virtual SetLongitudinalRelimiters( | const | iElem1, |
| const | biInv1, |
| const | iElem2, |
| const | biInv2) |
-
Sets the elements relimiting the spine (or the default spine).
- Parameters:
-
- iElem1
- First relimiting feature (plane or point)
- biInv1
- Split direction for the first relimitation
FALSE means that the beginning of the spine (considering its orientation) is removed, TRUE means that the end of the spine is removed
- iElem2
- Second relimiting feature (plane or point)
- biInv2
- Split direction for the second relimitation
o SetParameter
| public virtual SetParameter( | const | iElem) |
-
Sets the conical parameter value.
- Parameters:
-
- iElem
- Parameter value.
- See also:
-
o SetParameter
| public virtual SetParameter( | const | iElem) |
-
Sets the literal feature representing the conical parameter.
- Parameters:
-
- iElem
- Parameter literal feature.
- See also:
-
o SetParameterLaw
| public virtual SetParameterLaw( | const | iElem) |
-
Sets conical parameter law feature.
- Parameters:
-
- Elem
- Conical parameter law feature
- See also:
-
o SetParameterLaw
| public virtual SetParameterLaw( | const | iParamStart, |
| const | iParamEnd, |
| const | iType) |
-
Sets the values and the law type representing the conical parameter law.
- Parameters:
-
- iParamStart
- Parameter start value.
- iParamEnd
- Parameter end value.
- iType
- Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
- See also:
-
o SetParameterLaw
| public virtual SetParameterLaw( | const | iParamStart, |
| const | iParamEnd, |
| const | iType) |
-
Sets the literal features and the law type representing the conical parameter
law.
- Parameters:
-
- iParamStart
- Start parameter literal feature.
- iParamEnd
- End parameter literal feature.
- iType
- Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
- See also:
-
o SetParameterLawInversion
| public virtual SetParameterLawInversion( | const | iInversion) |
-
Sets information whether parameter law has to be inverted or not.
- Parameters:
-
- iInversion
- TRUE or FALSE.
- See also:
-
o SetParameterLawType
| public virtual SetParameterLawType( | const | eType) |
-
Sets parameter law type.
- Parameters:
-
- eType
- Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
- See also:
-
o SetSmoothActivity
| public virtual SetSmoothActivity( | const | iSmooth) |
-
Sets information whether sweeping operation is smoothed or not.
- Parameters:
-
- iSmooth
- TRUE or FALSE.
o SetSmoothAngleThreshold
| public virtual SetSmoothAngleThreshold( | const | iElem) |
-
Sets angular threshold under which discontinuities (moving frame,
tangency net on reference surface) will be smoothed when sweeping.
- Parameters:
-
- iElem
- Numerical value.
o SetSmoothAngleThreshold
| public virtual SetSmoothAngleThreshold( | const | iElem) |
-
Sets angular threshold under which discontinuities (moving frame,
tangency net on reference surface) will be smoothed when sweeping.
- Parameters:
-
- iElem
- Angular literal feature.
o SetSpine
| public virtual SetSpine( | const | iElem) |
-
Sets the spine.
- Parameters:
-
- iElem
- Spine feature.
o SetTangency
| public virtual SetTangency( | const | iElem, |
| const | iAngleLaw, |
| const | iI) |
-
Sets tangency surface or curve and its angle given the guide curve index.
- Parameters:
-
- iElem
- Tangency surface or curve feature.
- iAngleLaw
- Start tangency angle from surface or curve reference.
- iI
- Guide curve index : 1 to 5.
o SetTangency
| public virtual SetTangency( | const | iElem, |
| const | iAngleStart, |
| const | iAngleEnd, |
| const | iType, |
| const | iI) |
-
Sets tangency surface or curve and its angle given the guide curve index.
- Parameters:
-
- iElem
- Tangency surface or curve feature.
- iAngleStart
- Start tangency angle from surface or curve reference.
- iAngleEnd
- End tangency angle from surface or curve reference.
- iType
- Type of law used for tangency angle from surface or curve reference.
- iI
- Guide curve index : 1 to 5.
o SetTangencyAngleLawInversion
| public virtual SetTangencyAngleLawInversion( | const | iI, |
| const | iInversion) |
-
Sets information whether tangency angle law has to be inverted or not
for a specified guide curve.
- Parameters:
-
- iI
- Guide curve index : 1 to 5.
- iInversion
- TRUE or FALSE.
- See also:
-
This object is included in the file: CATIGSMUseSweepConic.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.