All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMSweepConic

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIGSMSweepConic
 

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


interface CATIGSMSweepConic

Interace to conical sweep feature.
Role: Allows you to access data of the conical sweep.

See also:
CATIGSMFactory.CreateConicalSweep


Method Index


o GetCanonicalDetectionMode(CATGSMCanonicalSurfaceDetection&)
Gets information about detection of canonical surfaces of the output surface.
o GetGuide(CATISpecObject_var&,int)
Gets a guide curve given its index (default = 1).
o GetGuideDeviation(CATICkeParm_var&)
Gets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
o GetGuideDeviation(double&)
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(CATISpecObject_var&,CATBoolean&,CATISpecObject_var&,CATBoolean&)
Gets the elements relimiting the spine (or the default spine).
o GetNbGuide(int&)
Gets the number of guide curves.
o GetParameter(CATICkeParm_var&)
Gets the literal feature representing the conical parameter.
o GetParameter(double&)
Gets the conical parameter value.
o GetParameterLaw(CATICkeLaw_var&)
Gets conical parameter law feature.
o GetParameterLaw(CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType&)
Gets the literal features and the law type representing the conical parameter law.
o GetParameterLaw(double&,double&,enum CATGSMBasicLawType&)
Gets the values 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(CATICkeParm_var&)
Gets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
o GetSmoothAngleThreshold(double&)
Gets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
o GetSpine(CATISpecObject_var&)
Gets the spine.
o GetTangency(CATISpecObject_var&,CATICkeLaw_var&,int)
Gets tangency surface or curve and its angle given the guide curve index.
o GetTangency(CATISpecObject_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(CATISpecObject_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(CATISpecObject_var,int)
Sets a guide curve given its index (default = 1).
o SetGuideDeviation(CATICkeParm_var&)
Sets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
o SetGuideDeviation(double)
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(CATISpecObject_var&,CATBoolean,CATISpecObject_var&,CATBoolean)
Sets the elements relimiting the spine (or the default spine).
o SetParameter(CATICkeParm_var)
Sets the literal feature representing the conical parameter.
o SetParameter(double)
Sets the conical parameter value.
o SetParameterLaw(CATICkeLaw_var)
Sets conical parameter law feature.
o SetParameterLaw(CATICkeParm_var,CATICkeParm_var,enum CATGSMBasicLawType)
Sets the literal features and the law type representing the conical parameter law.
o SetParameterLaw(double,double,enum CATGSMBasicLawType)
Sets the values 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(CATICkeParm_var&)
Sets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
o SetSmoothAngleThreshold(double)
Sets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
o SetSpine(CATISpecObject_var)
Sets the spine.
o SetTangency(CATISpecObject_var,CATICkeLaw_var,int)
Sets tangency surface or curve and its angle given the guide curve index.
o SetTangency(CATISpecObject_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 HRESULT GetCanonicalDetectionMode(CATGSMCanonicalSurfaceDetection& oDetection) = 0
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:
CATGSMCanonicalSurfaceDetection
o GetGuide
public virtual HRESULT GetGuide(CATISpecObject_var& oElem,
const int iI= 1) = 0
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 HRESULT GetGuideDeviation(CATICkeParm_var& oElem) = 0
Gets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
Parameters:
oElem
Length literal feature.
o GetGuideDeviation
public virtual HRESULT GetGuideDeviation(double& oElem) = 0
Gets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
Parameters:
oElem
Numerical value.
o GetGuideDeviationActivity
public virtual HRESULT GetGuideDeviationActivity(CATBoolean& oActi) = 0
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 HRESULT GetLongitudinalRelimiters(CATISpecObject_var& oElem1,
CATBoolean& boInv1,
CATISpecObject_var& oElem2,
CATBoolean& boInv2) = 0
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 HRESULT GetNbGuide(int& oI) = 0
Gets the number of guide curves.
Parameters:
oI
Number of guide curves.
o GetParameter
public virtual HRESULT GetParameter(CATICkeParm_var& oElem) = 0
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:
CATICkeParm
o GetParameter
public virtual HRESULT GetParameter(double& oElem) = 0
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:
CATICkeParm
o GetParameterLaw
public virtual HRESULT GetParameterLaw(CATICkeLaw_var& oElem) = 0
Gets conical parameter law feature.
Parameters:
Elem
Conical parameter law feature
See also:
CATICkeParm
o GetParameterLaw
public virtual HRESULT GetParameterLaw(CATICkeParm_var& oParamStart,
CATICkeParm_var& oParamEnd,
enum CATGSMBasicLawType& oType) = 0
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:
CATICkeParm
o GetParameterLaw
public virtual HRESULT GetParameterLaw(double& oParamStart,
double& oParamEnd,
enum CATGSMBasicLawType& oType) = 0
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:
CATICkeParm
o GetParameterLawInversion
public virtual HRESULT GetParameterLawInversion(CATBoolean& oInversion) = 0
Gets information whether parameter law has to be inverted or not.
Parameters:
oInversion
TRUE or FALSE (FALSE if not specified).
See also:
CATGSMBasicLawType
o GetParameterLawType
public virtual HRESULT GetParameterLawType(enum CATGSMBasicLawType& eType) = 0
Gets parameter law type.
Parameters:
eType
Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
See also:
CATGSMBasicLawType
o GetSmoothActivity
public virtual HRESULT GetSmoothActivity(CATBoolean& oSmooth) = 0
Gets information whether sweeping operation is smoothed or not.
Parameters:
oSmooth
TRUE or FALSE (FALSE if not specified).
o GetSmoothAngleThreshold
public virtual HRESULT GetSmoothAngleThreshold(CATICkeParm_var& oElem) = 0
Gets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
Parameters:
oElem
Angular literal feature.
o GetSmoothAngleThreshold
public virtual HRESULT GetSmoothAngleThreshold(double& oElem) = 0
Gets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
Parameters:
oElem
Numerical value.
o GetSpine
public virtual HRESULT GetSpine(CATISpecObject_var& oElem) = 0
Gets the spine.
Parameters:
oElem
Spine feature.
o GetTangency
public virtual HRESULT GetTangency(CATISpecObject_var& oElem,
CATICkeLaw_var& oAngleLaw,
const int iI) = 0
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 HRESULT GetTangency(CATISpecObject_var& oElem,
CATICkeParm_var& oAngleStart,
CATICkeParm_var& oAngleEnd,
enum CATGSMBasicLawType& oType,
const int iI) = 0
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 HRESULT GetTangencyAngleLawInversion( const int iI,
CATBoolean& oInversion) = 0
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:
CATGSMBasicLawType
o InsertGuideAtPosition
public virtual HRESULT InsertGuideAtPosition( const CATISpecObject_var iElem,
const int iI) = 0
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 HRESULT RemoveGuide( const int iI= 1) = 0
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 HRESULT RemoveParameter()= 0
Removes conical sweep parameter, whether it is a single value or a law.
o RemoveTangency
public virtual HRESULT RemoveTangency( const int iI) = 0
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 HRESULT SetCanonicalDetectionMode(CATGSMCanonicalSurfaceDetection iDetection= CATGSMNoDetection) = 0
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:
CATGSMCanonicalSurfaceDetection
o SetGuide
public virtual HRESULT SetGuide( const CATISpecObject_var iElem,
const int iI= 1) = 0
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 HRESULT SetGuideDeviation( const CATICkeParm_var& iElem) = 0
Sets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
Parameters:
iElem
Length literal feature.
o SetGuideDeviation
public virtual HRESULT SetGuideDeviation( const double iElem) = 0
Sets deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
Parameters:
iElem
Numerical value.
o SetGuideDeviationActivity
public virtual HRESULT SetGuideDeviationActivity( const CATBoolean iActi) = 0
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 HRESULT SetLongitudinalRelimiters( const CATISpecObject_var& iElem1,
const CATBoolean biInv1,
const CATISpecObject_var& iElem2,
const CATBoolean biInv2) = 0
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 HRESULT SetParameter( const CATICkeParm_var iElem) = 0
Sets the literal feature representing the conical parameter.
Parameters:
iElem
Parameter literal feature.
See also:
CATICkeParm
o SetParameter
public virtual HRESULT SetParameter( const double iElem) = 0
Sets the conical parameter value.
Parameters:
iElem
Parameter value.
See also:
CATICkeParm
o SetParameterLaw
public virtual HRESULT SetParameterLaw( const CATICkeLaw_var iElem) = 0
Sets conical parameter law feature.
Parameters:
Elem
Conical parameter law feature
See also:
CATICkeParm
o SetParameterLaw
public virtual HRESULT SetParameterLaw( const CATICkeParm_var iParamStart,
const CATICkeParm_var iParamEnd,
const enum CATGSMBasicLawType iType) = 0
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:
CATICkeParm
o SetParameterLaw
public virtual HRESULT SetParameterLaw( const double iParamStart,
const double iParamEnd,
const enum CATGSMBasicLawType iType) = 0
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:
CATICkeParm
o SetParameterLawInversion
public virtual HRESULT SetParameterLawInversion( const CATBoolean iInversion) = 0
Sets information whether parameter law has to be inverted or not.
Parameters:
iInversion
TRUE or FALSE.
See also:
CATGSMBasicLawType
o SetParameterLawType
public virtual HRESULT SetParameterLawType( const enum CATGSMBasicLawType eType) = 0
Sets parameter law type.
Parameters:
eType
Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
See also:
CATGSMBasicLawType
o SetSmoothActivity
public virtual HRESULT SetSmoothActivity( const CATBoolean iSmooth) = 0
Sets information whether sweeping operation is smoothed or not.
Parameters:
iSmooth
TRUE or FALSE.
o SetSmoothAngleThreshold
public virtual HRESULT SetSmoothAngleThreshold( const CATICkeParm_var& iElem) = 0
Sets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
Parameters:
iElem
Angular literal feature.
o SetSmoothAngleThreshold
public virtual HRESULT SetSmoothAngleThreshold( const double iElem) = 0
Sets angular threshold under which discontinuities (moving frame, tangency net on reference surface) will be smoothed when sweeping.
Parameters:
iElem
Numerical value.
o SetSpine
public virtual HRESULT SetSpine( const CATISpecObject_var iElem) = 0
Sets the spine.
Parameters:
iElem
Spine feature.
o SetTangency
public virtual HRESULT SetTangency( const CATISpecObject_var iElem,
const CATICkeLaw_var iAngleLaw,
const int iI) = 0
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 HRESULT SetTangency( const CATISpecObject_var iElem,
const CATICkeParm_var iAngleStart,
const CATICkeParm_var iAngleEnd,
const enum CATGSMBasicLawType& iType,
const int iI) = 0
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 HRESULT SetTangencyAngleLawInversion( const int iI,
const CATBoolean iInversion) = 0
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:
CATGSMBasicLawType

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

Copyright © 2003, Dassault Systèmes. All rights reserved.