All Frameworks Class Hierarchy This Framework Previous Next Indexes
GSMInterfaces Interface CATIGSMSweepSegment
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIGSMSweepSegment
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMSweepSegment
Interface to linear sweep feature.
Role: Allows you to access (query and modifications) data
of the linear sweep.
- See also:
- CATIGSMFactory.CreateLinearSweep
Method Index
- o
AddDraftAngleDefinitionLocation(CATISpecObject_var&,CATICkeParm_var&)
- Adds a geometrical element and a value necessary for draft angle definition.
- o
DelAngle()
- Removes all angles.
- o
DelGuideCrv()
- Removes all guide curves.
- o
DelGuideSurf()
- Removes all guide surfaces.
- o
DelLength()
- Removes all lengths.
- o
GetAngle(CATICkeParm_var&,int)
- Gets the literal feature representing an angle given its index.
- o
GetAngle(double&,int)
- Gets the value of an angle given its index.
- o
GetAngularLaw(CATICkeLaw_var&)
- Gets angular law feature.
- o
GetAngularLaw(CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType&)
- Gets information about angular law.
- o
GetAngularLawInversion(CATBoolean&)
- Gets information whether angular law has to be inverted or not.
- o
GetAngularLawType(enum CATGSMBasicLawType&)
- Gets angular law type.
- o
GetCanonicalDetectionMode(CATGSMCanonicalSurfaceDetection&)
- Gets information about detection of canonical surfaces of the output surface.
- o
GetChoiceNo(int&,int&,int&)
- Gets a sequence which identifies a solution amongst all possibilities
of a line-profile swept surface, case CATGSMLinearSweep_GuideAndTangencySurface.
- o
GetChoiceNoSurfaces(int&,int&,int&,int&,int&)
- Gets a sequence which identifies a solution amongst all possibilities
of a line-profile swept surface, case CATGSMLinearSweep_TwoTangencySurfaces.
- o
GetContext(CATGSMFeatureContextType&)
- Gets the context of the Sweep.
- o
GetDraftAngleDefinitionLocations(CATListValCATISpecObject_var&,CATListValCATBaseUnknown_var&)
- Gets geometrical elements and values necessary for draft angle definition.
- o
GetDraftComputationMode(enum CATGSMLinearDraftSweepComp&)
- Gets linear swept surface with draft direction computation mode:
CATGSMLinearDraftSweepComp_Square for square,
CATGSMLinearDraftSweepComp_ConeEnvelop for cone envelop.
- o
GetDraftDirection(CATIGSMDirection_var&)
- Gets draft direction.
- o
GetFirstLengthDefinitionType(enum CATGSMLinearSweepLengthType&,CATISpecObject_var&)
- Gets first length definition for linear swept surfaces (for draft surfaces
only, so far).
- o
GetGuideCrv(CATISpecObject_var&)
- Gets first guide curve.
- o
GetGuideCrv(CATISpecObject_var&,int)
- Gets a guide curve given its index.
- 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
GetGuideSurf(CATISpecObject_var&)
- Gets first guide surface.
- o
GetGuideSurf(CATISpecObject_var&,int)
- Gets a guide surface given its index.
- o
GetLength(CATICkeParm_var&,int)
- Gets the literal feature representing an length given its index.
- o
GetLength(double&,int)
- Gets the value of a length given its index.
- o
GetLengthLawInversions(CATBoolean&,CATBoolean&)
- Gets information whether length laws have to be inverted or not.
- o
GetLengthLawTypes(enum CATGSMBasicLawType&,enum CATGSMBasicLawType&)
- Gets length law types.
- o
GetLengthLaws(CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType&,CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType&)
- Gets information about both length laws.
- o
GetLengthLaws(CATISpecObject_var&,CATISpecObject_var&,enum CATGSMBasicLawType&,CATISpecObject_var&,CATISpecObject_var&,enum CATGSMBasicLawType&)
- Gets information about both length laws (including advanced law features).
- o
GetLongitudinalRelimiters(CATISpecObject_var&,CATBoolean&,CATISpecObject_var&,CATBoolean&)
- Gets the elements relimiting the spine (or the default spine).
- o
GetMode(enum CATGSMLinearSweepCase&)
- Gets linear sweep case number (also called mode).
- o
GetNbAngle(int&)
- Gets the number of angles.
- o
GetNbGuideCrv(int&)
- Gets the number of guide curves.
- o
GetNbGuideSurf(int&)
- Gets the number of guide surfaces.
- o
GetNbLength(int&)
- Gets the number of lengths.
- o
GetSecondLengthDefinitionType(enum CATGSMLinearSweepLengthType&,CATISpecObject_var&)
- Gets second length definition for linear swept surfaces (for draft surfaces
only, so far).
- 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
GetSolutionNo(int&)
- Gets the current solution number of the four possible solutions.
- o
GetSpine(CATISpecObject_var&)
- Gets the spine.
- o
GetTrimOption(enum CATGSMSweepTrimMode&)
- Gets trim option status for the first (or only) tangency surface.
- o
GetTrimOptions(enum CATGSMSweepTrimMode&,enum CATGSMSweepTrimMode&)
- Gets trim option statuses for both tangency surfaces.
- o
InsertDraftAngleDefinitionLocationAfterPos(CATISpecObject_var&,CATICkeParm_var&,int)
- Inserts a geometrical element and a value necessary for draft angle definition
after a given position in the lists.
- o
InsertDraftAngleDefinitionLocationBeforePos(CATISpecObject_var&,CATICkeParm_var&,int)
- Inserts a geometrical element and a value necessary for draft angle definition
before a given position in the lists.
- o
RemoveAllDraftAngleDefinitionLocations()
- Removes all geometrical elements and values necessary for draft angle definition.
- o
RemoveDraftAngleDefinitionLocationPosition(int)
- Removes a geometrical element and a value necessary for draft angle definition
at a given position in the lists.
- o
SetAngle(CATICkeParm_var,int)
- Sets the literal feature representing an angle given its index.
- o
SetAngle(double,int)
- Sets the value of an angle given its index.
- o
SetAngularLaw(CATICkeLaw_var&)
- Sets angular law feature.
- o
SetAngularLaw(CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType)
- Sets information about angular law.
- o
SetAngularLawInversion(CATBoolean)
- Sets information whether angular law has to be inverted or not.
- o
SetAngularLawType(enum CATGSMBasicLawType)
- Sets angular law type.
- o
SetCanonicalDetectionMode(CATGSMCanonicalSurfaceDetection)
- Sets information about detection of canonical surfaces of the output surface.
- o
SetChoiceNo(int,int,int)
- Sets a sequence which identifies a solution (see above), case CATGSMLinearSweep_GuideAndTangencySurface.
- o
SetChoiceNoSurfaces(int,int,int,int,int)
- Sets a sequence which identifies a solution (see above), case CATGSMLinearSweep_TwoTangencySurfaces.
- o
SetContext(CATGSMFeatureContextType)
- Sets the context of the Sweep.
- o
SetDraftComputationMode(enum CATGSMLinearDraftSweepComp)
- Sets linear swept surface with draft direction computation mode:
CATGSMLinearDraftSweepComp_Square for square,
CATGSMLinearDraftSweepComp_ConeEnvelop for cone envelop.
- o
SetDraftDirection(CATIGSMDirection_var&)
- Sets draft direction.
- o
SetFirstLengthDefinitionType(enum CATGSMLinearSweepLengthType,CATISpecObject_var&)
- Sets first length definition for linear swept surfaces (for draft surfaces
only, so far).
- o
SetGuideCrv(CATISpecObject_var)
- Modify first guide curve.
- o
SetGuideCrv(CATISpecObject_var,int)
- Sets a guide curve given its index.
- 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
SetGuideSurf(CATISpecObject_var)
- Sets first guide surface.
- o
SetGuideSurf(CATISpecObject_var,int)
- Sets a guide surface given its index.
- o
SetLength(CATICkeParm_var,int)
- Sets the literal feature representing an length given its index.
- o
SetLength(double,int)
- Sets the value of a length given its index.
- o
SetLengthLawInversions(CATBoolean,CATBoolean)
- Sets information whether length laws have to be inverted or not.
- o
SetLengthLawTypes(enum CATGSMBasicLawType,enum CATGSMBasicLawType)
- Sets length law types.
- o
SetLengthLaws(CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType,CATICkeParm_var&,CATICkeParm_var&,enum CATGSMBasicLawType)
- Sets information about both length laws.
- o
SetLengthLaws(CATISpecObject_var&,CATISpecObject_var&,enum CATGSMBasicLawType,CATISpecObject_var&,CATISpecObject_var&,enum CATGSMBasicLawType)
- Sets information about both length laws (including advanced law features).
- o
SetLongitudinalRelimiters(CATISpecObject_var&,CATBoolean,CATISpecObject_var&,CATBoolean)
- Sets the elements relimiting the spine (or the default spine).
- o
SetMode(enum CATGSMLinearSweepCase)
- Sets linear sweep case number.
- o
SetSecondLengthDefinitionType(enum CATGSMLinearSweepLengthType,CATISpecObject_var&)
- Sets second length definition for linear swept surfaces (for draft surfaces
only, so far).
- 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
SetSolutionNo(int)
- Sets the current solution number of the four possible solutions.
- o
SetSpine(CATISpecObject_var)
- Sets the spine.
- o
SetTrimOption(enum CATGSMSweepTrimMode)
- Sets trim option status for the first (or only) tangency surface.
- o
SetTrimOptions(enum CATGSMSweepTrimMode,enum CATGSMSweepTrimMode)
- Sets trim option statuses for both tangency surfaces.
Methods
o AddDraftAngleDefinitionLocation
public virtual HRESULT AddDraftAngleDefinitionLocation( | const CATISpecObject_var& | iLoc, |
| const CATICkeParm_var& | iVal) = 0 |
-
Adds a geometrical element and a value necessary for draft angle definition.
- Parameters:
-
- iLoc
- Geometrical element
- iVal
- Angular parameter
o DelAngle
public virtual HRESULT DelAngle( | )= 0 |
-
Removes all angles.
o DelGuideCrv
public virtual HRESULT DelGuideCrv( | )= 0 |
-
Removes all guide curves.
o DelGuideSurf
public virtual HRESULT DelGuideSurf( | )= 0 |
-
Removes all guide surfaces.
o DelLength
public virtual HRESULT DelLength( | )= 0 |
-
Removes all lengths.
o GetAngle
public virtual HRESULT GetAngle( | CATICkeParm_var& | oElem, |
| const int | iI) = 0 |
-
Gets the literal feature representing an angle given its index.
- Parameters:
-
- oElem
- Angle literal feature
- iI
- Index of the angle (starting from one)
- See also:
- CATICkeParm
o GetAngle
public virtual HRESULT GetAngle( | double& | oElem, |
| const int | iI) = 0 |
-
Gets the value of an angle given its index.
- Parameters:
-
- oElem
- Angle value
- iI
- Index of the angle (starting from one)
o GetAngularLaw
public virtual HRESULT GetAngularLaw( | CATICkeLaw_var& | Elem) = 0 |
-
Gets angular law feature.
- Parameters:
-
- Elem
- Angular law feature
- See also:
- CATICkeParm
o GetAngularLaw
public virtual HRESULT GetAngularLaw( | CATICkeParm_var& | ParamStart, |
| CATICkeParm_var& | ParamEnd, |
| enum CATGSMBasicLawType& | eType) = 0 |
-
Gets information about angular law.
- Parameters:
-
- ParamStart
- Start angle literal feature
- ParamEnd
- End angle literal feature
- eType
- Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
- See also:
- CATICkeParm, CATGSMBasicLawType
o GetAngularLawInversion
-
Gets information whether angular law has to be inverted or not.
- Parameters:
-
- oInversion
- TRUE or FALSE (FALSE if not specified).
- See also:
- CATGSMBasicLawType
o GetAngularLawType
public virtual HRESULT GetAngularLawType( | enum CATGSMBasicLawType& | eType) = 0 |
-
Gets angular law type.
- Parameters:
-
- eType
- Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
- See also:
- CATGSMBasicLawType
o GetCanonicalDetectionMode
-
Gets information about detection of canonical surfaces of the output surface.
- Parameters:
-
- oDetection
- If canonical surfaces are detected.
Possible values are CATGSMNoDetection and CATGSMCanonicalDetection.
- See also:
- CATGSMCanonicalSurfaceDetection
o GetChoiceNo
public virtual HRESULT GetChoiceNo( | int& | oSurfOri, |
| int& | oCrvOri, |
| int& | oNo) = 0 |
-
Gets a sequence which identifies a solution amongst all possibilities
of a line-profile swept surface, case CATGSMLinearSweep_GuideAndTangencySurface.
- Parameters:
-
- oSurfOri
- This orientation determines the location of the results with regard to
the surface. Possible values are:
* +1 : the result is in the semi-space defined by the normal to the surface,
* -1 : the result is in the semi-space defined by the opposite to the normal to the surface,
* 0 : no orientation is specified, all the results are output,
* 2 : the result changes of semi-space along the spine.
- oCrvOri
- This orientation determines the location of the results with regard to
the guide curve (CATGSMLinearSweep_GuideAndTangencySurface);
let's define a trihedron with the guide curve, the normal to the surface
and the tangent to the linear profile, then possible values are:
* +1 : the result is such that the triedron is counter clockwise,
* -1 : the result is such that the triedron is clockwise,
* 0 : no orientation is specified, all the results are output,
* 2 : the orientation of the trihedron changes along the spine.
- oNo
- Given the previous orientations, solution number in a distance ordered list.
o GetChoiceNoSurfaces
public virtual HRESULT GetChoiceNoSurfaces( | int& | oSurfOri1, |
| int& | oSurfOri2, |
| int& | oSurfCouplOri1, |
| int& | oSurfCouplOri2, |
| int& | oNo) = 0 |
-
Gets a sequence which identifies a solution amongst all possibilities
of a line-profile swept surface, case CATGSMLinearSweep_TwoTangencySurfaces.
- Parameters:
-
- oSurfOri1
- This orientation determines the location of the results with regard to
the first surface. Possible values are:
* +1 : the result is in the semi-space defined by the normal to the surface,
* -1 : the result is in the semi-space defined by the opposite to the normal to the ,
* 0 : no orientation is specified, all the results are output,
* 2 : the result changes of semi-space along the spine.
- oSurfOri2
- This orientation determines the location of the results with regard to
the second surface.
- oSurfCouplOri1
- This orientation determines the location of the results with regard to
the triedron defined by the the spine, the normal to the first surface and
the tangent to the linear profile. Possible values are:
* +1 : the output results are such that the triedron is counter clockwise,
* -1 : the output results are such that the triedron is clockwise,
* 0 : no orientation is specified, all the results are output,
* 2 : the orientation of the trihedron changes along the spine.
- oSurfCouplOri2
- This orientation determines the location of the results with regard to
the triedron defined by the the spine, the normal to the second surface and
the tangent to the linear profile.
- oNo
- Given the previous orientations, solution number in a distance ordered list.
o GetContext
-
Gets the context of the Sweep.
- Parameters:
-
- oContextType
- CATGSMSurfaceCtxt if the result is surface, CATGSMVolumeCtxt if it is volume
- See also:
- CATGSMFeatureContextType
o GetDraftAngleDefinitionLocations
public virtual HRESULT GetDraftAngleDefinitionLocations( | CATListValCATISpecObject_var& | oListLoc, |
| CATListValCATBaseUnknown_var& | oListVal) = 0 |
-
Gets geometrical elements and values necessary for draft angle definition.
There can be three possibilities: 1) a list of curves and a list of
angular parameters (case: constant angles by G1 section), 2) a list
of points and a list of angular parameters (case: variable angle
with given values at given points), 3) no geometry and only one
angular parameter for the whole sweeping operation.
- Parameters:
-
- oListLoc
- List of geometrical elements
- oListVal
- List of angular parameters
o GetDraftComputationMode
public virtual HRESULT GetDraftComputationMode( | enum CATGSMLinearDraftSweepComp& | oElem) = 0 |
-
Gets linear swept surface with draft direction computation mode:
CATGSMLinearDraftSweepComp_Square for square,
CATGSMLinearDraftSweepComp_ConeEnvelop for cone envelop.
- Parameters:
-
- oElem
- Computation mode
o GetDraftDirection
public virtual HRESULT GetDraftDirection( | CATIGSMDirection_var& | oElem) = 0 |
-
Gets draft direction.
- Parameters:
-
- oElem
- Direction feature
o GetFirstLengthDefinitionType
public virtual HRESULT GetFirstLengthDefinitionType( | enum CATGSMLinearSweepLengthType& | oType, |
| CATISpecObject_var& | oElem) = 0 |
-
Gets first length definition for linear swept surfaces (for draft surfaces
only, so far).
- Parameters:
-
- oElem
- CATGSMLinearSweepLengthType_None: undefined length type,
CATGSMLinearSweepLengthType_Standard: length of the swept line in
the sweeping plane from guide curve,
CATGSMLinearSweepLengthType_FromCurve: no numerical value is required,
equivalent to standard length at zero,
CATGSMLinearSweepLengthType_Reference: up to or from a geometrical
reference (a surface),
CATGSMLinearSweepLengthType_FromExtremum: only for draft surfaces,
length computed in the draft direction from an extremum point on
the guide curve (available from V5R8SP3),
CATGSMLinearSweepLengthType_AlongSurface: only for draft surfaces,
length will be used in a way similar to euclidean parallel curve
distance on the swept surface (available from V5R11)
o GetGuideCrv
public virtual HRESULT GetGuideCrv( | CATISpecObject_var& | oElem) = 0 |
-
Gets first guide curve.
- Parameters:
-
- oElem
- First guide curve feature.
o GetGuideCrv
public virtual HRESULT GetGuideCrv( | CATISpecObject_var& | oElem, |
| const int | iI) = 0 |
-
Gets a guide curve given its index.
- Parameters:
-
- oElem
- Guide curve feature.
- iI
- Guide curve index : 1 or 2
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
-
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 GetGuideSurf
public virtual HRESULT GetGuideSurf( | CATISpecObject_var& | oElem) = 0 |
-
Gets first guide surface.
- Parameters:
-
- oElem
- First guide surface feature.
o GetGuideSurf
public virtual HRESULT GetGuideSurf( | CATISpecObject_var& | oElem, |
| const int | iI) = 0 |
-
Gets a guide surface given its index.
- Parameters:
-
- oElem
- Guide surface feature.
- iI
- Guide surface index : 1 or 2
o GetLength
public virtual HRESULT GetLength( | CATICkeParm_var& | oElem, |
| const int | iI) = 0 |
-
Gets the literal feature representing an length given its index.
- Parameters:
-
- oElem
- Length literal feature
- iI
- Index of the length (starting from one)
- See also:
- CATICkeParm
o GetLength
public virtual HRESULT GetLength( | double& | oElem, |
| const int | iI) = 0 |
-
Gets the value of a length given its index.
- Parameters:
-
- oElem
- Length value
- iI
- Index of the length (starting from one)
o GetLengthLawInversions
-
Gets information whether length laws have to be inverted or not.
- Parameters:
-
- oInversion1
- TRUE or FALSE (FALSE if not specified) for first length law.
- oInversion2
- TRUE or FALSE (FALSE if not specified) for second length law.
- See also:
- CATGSMBasicLawType
o GetLengthLawTypes
public virtual HRESULT GetLengthLawTypes( | enum CATGSMBasicLawType& | eFirstType, |
| enum CATGSMBasicLawType& | eSecondType) = 0 |
-
Gets length law types.
- Parameters:
-
- eFirstType
- First type of law (from CATGSMBasicLawType enumeration).
- eSecondType
- Second type of law (from CATGSMBasicLawType enumeration).
- See also:
- CATGSMBasicLawType
o GetLengthLaws
public virtual HRESULT GetLengthLaws( | CATICkeParm_var& | FirstParamStart, |
| CATICkeParm_var& | FirstParamEnd, |
| enum CATGSMBasicLawType& | eFirstType, |
| CATICkeParm_var& | SecondParamStart, |
| CATICkeParm_var& | SecondParamEnd, |
| enum CATGSMBasicLawType& | eSecondType) = 0 |
-
Gets information about both length laws. PREFER PREVIOUS METHOD WHICH
INCLUDES ADVANCED LAW FEATURES.
- Parameters:
-
- FirstParamStart
- Start first angle literal feature
- FirstParamEnd
- End first angle literal feature
- eFirstType
- First type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
- SecondParamStart
- Start second angle literal feature
- SecondParamEnd
- End second angle literal feature
- eSecondType
- Second type of law (from CATGSMBasicLawType enumeration).
- See also:
- CATICkeParm, CATGSMBasicLawType
o GetLengthLaws
public virtual HRESULT GetLengthLaws( | CATISpecObject_var& | FirstParamStart, |
| CATISpecObject_var& | FirstParamEnd, |
| enum CATGSMBasicLawType& | eFirstType, |
| CATISpecObject_var& | SecondParamStart, |
| CATISpecObject_var& | SecondParamEnd, |
| enum CATGSMBasicLawType& | eSecondType) = 0 |
-
Gets information about both length laws (including advanced law features).
- Parameters:
-
- FirstParamStart
- Start first angle literal feature, or law feature if advanced
- FirstParamEnd
- End first angle literal feature, or NULL_var if advanced
- eFirstType
- First type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
- SecondParamStart
- Start second angle literal feature, or law feature if advanced
- SecondParamEnd
- End second angle literal feature, or NULL_var if advanced
- eSecondType
- Second type of law (from CATGSMBasicLawType enumeration).
- See also:
- CATICkeParm, CATGSMBasicLawType
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 GetMode
public virtual HRESULT GetMode( | enum CATGSMLinearSweepCase& | oElem) = 0 |
-
Gets linear sweep case number (also called mode).
Possible cases are:
- CATGSMLinearSweep_None: unidentified mode
- CATGSMLinearSweep_TwoGuides: two guide curves and two possible
length values
- CATGSMLinearSweep_GuideAndAngleCurve: one guide curve, one reference
angle curve, one angle value and two length values
- CATGSMLinearSweep_GuideAndMiddle: two guide curves with one given as
middle curve
- CATGSMLinearSweep_GuideAndRefSurfaceAngle: one guide curve lying on
a reference surface, an angle value and two length values
- CATGSMLinearSweep_GuideAndTangencySurface: one guide curve
and one tangency surface
- CATGSMLinearSweep_GuideAndDraftDirection: one guide curve
and a draft direction
- CATGSMLinearSweep_TwoTangencySurfaces: one spine (or guide curve)
and two tangency surfaces
- Parameters:
-
- oElem
- Case number
- See also:
- CATGSMLinearSweepCase
o GetNbAngle
public virtual HRESULT GetNbAngle( | int& | oI) = 0 |
-
Gets the number of angles.
- Parameters:
-
- oI
- Number of angles
o GetNbGuideCrv
public virtual HRESULT GetNbGuideCrv( | int& | oI) = 0 |
-
Gets the number of guide curves.
- Parameters:
-
- oI
- Number of guide curves
o GetNbGuideSurf
public virtual HRESULT GetNbGuideSurf( | int& | oI) = 0 |
-
Gets the number of guide surfaces.
- Parameters:
-
- oI
- Number of guide surfaces
o GetNbLength
public virtual HRESULT GetNbLength( | int& | oI) = 0 |
-
Gets the number of lengths.
- Parameters:
-
- oI
- Number of lengths
o GetSecondLengthDefinitionType
public virtual HRESULT GetSecondLengthDefinitionType( | enum CATGSMLinearSweepLengthType& | oType, |
| CATISpecObject_var& | oElem) = 0 |
-
Gets second length definition for linear swept surfaces (for draft surfaces
only, so far).
- Parameters:
-
- oElem
- Length type
o GetSmoothActivity
-
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 GetSolutionNo
public virtual HRESULT GetSolutionNo( | int& | oSolNo)=0 |
-
Gets the current solution number of the four possible solutions.
- Parameters:
-
- oSolNo
- is the solution number.
o GetSpine
public virtual HRESULT GetSpine( | CATISpecObject_var& | oElem) = 0 |
-
Gets the spine.
- Parameters:
-
- oElem
- Spine feature
o GetTrimOption
public virtual HRESULT GetTrimOption( | enum CATGSMSweepTrimMode& | oOption) = 0 |
-
Gets trim option status for the first (or only) tangency surface.
Possible cases are :
- CATGSMSweepTrimMode_None: no trim computed or undefined,
- CATGSMSweepTrimMode_On: trim computed.
- Parameters:
-
- oOption
- Trim option value
- See also:
- CATGSMSweepTrimMode
o GetTrimOptions
public virtual HRESULT GetTrimOptions( | enum CATGSMSweepTrimMode& | oOption1, |
| enum CATGSMSweepTrimMode& | oOption2) = 0 |
-
Gets trim option statuses for both tangency surfaces.
Possible cases are :
- CATGSMSweepTrimMode_None: no trim computed or undefined,
- CATGSMSweepTrimMode_On: trim computed.
- Parameters:
-
- oOption1
- Trim option value for the first tangency surface
- oOption2
- Trim option value for the second tangency surface
- See also:
- CATGSMSweepTrimMode
o InsertDraftAngleDefinitionLocationAfterPos
public virtual HRESULT InsertDraftAngleDefinitionLocationAfterPos( | const CATISpecObject_var& | iLoc, |
| const CATICkeParm_var& | iVal, |
| const int | iPos) = 0 |
-
Inserts a geometrical element and a value necessary for draft angle definition
after a given position in the lists.
- Parameters:
-
- iLoc
- Geometrical element
- iVal
- Angular parameter
- iPos
- Position in lists
o InsertDraftAngleDefinitionLocationBeforePos
public virtual HRESULT InsertDraftAngleDefinitionLocationBeforePos( | const CATISpecObject_var& | iLoc, |
| const CATICkeParm_var& | iVal, |
| const int | iPos) = 0 |
-
Inserts a geometrical element and a value necessary for draft angle definition
before a given position in the lists.
- Parameters:
-
- iLoc
- Geometrical element
- iVal
- Angular parameter
- iPos
- Position in lists
o RemoveAllDraftAngleDefinitionLocations
public virtual HRESULT RemoveAllDraftAngleDefinitionLocations( | )= 0 |
-
Removes all geometrical elements and values necessary for draft angle definition.
o RemoveDraftAngleDefinitionLocationPosition
public virtual HRESULT RemoveDraftAngleDefinitionLocationPosition( | const int | iPos) = 0 |
-
Removes a geometrical element and a value necessary for draft angle definition
at a given position in the lists.
- Parameters:
-
- iPos
- Position in lists
o SetAngle
-
Sets the literal feature representing an angle given its index.
- Parameters:
-
- iElem
- Angle literal feature
- iI
- Index of the angle (starting from one)
- See also:
- CATICkeParm
o SetAngle
public virtual HRESULT SetAngle( | const double | iElem, |
| const int | iI) = 0 |
-
Sets the value of an angle given its index.
- Parameters:
-
- iElem
- Angle value
- iI
- Index of the angle (starting from one)
o SetAngularLaw
public virtual HRESULT SetAngularLaw( | const CATICkeLaw_var& | Elem) = 0 |
-
Sets angular law feature.
- Parameters:
-
- Elem
- Angular law feature
- See also:
- CATICkeParm
o SetAngularLaw
public virtual HRESULT SetAngularLaw( | const CATICkeParm_var& | ParamStart, |
| const CATICkeParm_var& | ParamEnd, |
| const enum CATGSMBasicLawType | eType) = 0 |
-
Sets information about angular law.
- Parameters:
-
- ParamStart
- Start angle literal feature
- ParamEnd
- End angle literal feature
- eType
- Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
- See also:
- CATICkeParm, CATGSMBasicLawType
o SetAngularLawInversion
-
Sets information whether angular law has to be inverted or not.
- Parameters:
-
- iInversion
- TRUE or FALSE.
- See also:
- CATGSMBasicLawType
o SetAngularLawType
public virtual HRESULT SetAngularLawType( | const enum CATGSMBasicLawType | eType) = 0 |
-
Sets angular law type.
- Parameters:
-
- eType
- Type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
- See also:
- CATGSMBasicLawType
o SetCanonicalDetectionMode
-
Sets information about detection of canonical surfaces of the output surface.
- Parameters:
-
- iDetection
- If canonical surfaces are detected.
Possible values are CATGSMNoDetection and CATGSMCanonicalDetection.
- See also:
- CATGSMCanonicalSurfaceDetection
o SetChoiceNo
public virtual HRESULT SetChoiceNo( | const int | iSurfOri, |
| const int | iCrvOri, |
| const int | iNo) = 0 |
-
Sets a sequence which identifies a solution (see above), case CATGSMLinearSweep_GuideAndTangencySurface.
- Parameters:
-
- iNo
-
- iSurfOri
-
- iCrvOri
o SetChoiceNoSurfaces
public virtual HRESULT SetChoiceNoSurfaces( | const int | iSurfOri1, |
| const int | iSurfOri2, |
| const int | iSurfCouplOri1, |
| const int | iSurfCouplOri2, |
| const int | iNo) = 0 |
-
Sets a sequence which identifies a solution (see above), case CATGSMLinearSweep_TwoTangencySurfaces.
- Parameters:
-
- iNo
-
- iFirstOri
-
- iSecondOri
o SetContext
-
Sets the context of the Sweep.
- Parameters:
-
- iContextType
- CATGSMSurfaceCtxt to generate a surface, CATGSMVolumeCtxt (requires GSO License) to generate a volume
- See also:
- CATGSMFeatureContextType
o SetDraftComputationMode
public virtual HRESULT SetDraftComputationMode( | const enum CATGSMLinearDraftSweepComp | iElem) = 0 |
-
Sets linear swept surface with draft direction computation mode:
CATGSMLinearDraftSweepComp_Square for square,
CATGSMLinearDraftSweepComp_ConeEnvelop for cone envelop.
- Parameters:
-
- iElem
- Computation mode
o SetDraftDirection
public virtual HRESULT SetDraftDirection( | const CATIGSMDirection_var& | iElem) = 0 |
-
Sets draft direction.
- Parameters:
-
- iElem
- Direction feature
o SetFirstLengthDefinitionType
public virtual HRESULT SetFirstLengthDefinitionType( | const enum CATGSMLinearSweepLengthType | iType, |
| const CATISpecObject_var& | iElem | = NULL_var) = 0 |
-
Sets first length definition for linear swept surfaces (for draft surfaces
only, so far).
- Parameters:
-
- iElem
- Length type
o SetGuideCrv
-
Modify first guide curve.
- Parameters:
-
- iElem
- First guide curve feature.
o SetGuideCrv
-
Sets a guide curve given its index.
- Parameters:
-
- iElem
- Guide curve feature.
- iI
- Guide curve index : 1 or 2
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
-
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 SetGuideSurf
-
Sets first guide surface.
- Parameters:
-
- iElem
- First guide surface feature.
o SetGuideSurf
-
Sets a guide surface given its index.
- Parameters:
-
- iElem
- Guide surface feature.
- iI
- Guide surface index : 1 or 2
o SetLength
-
Sets the literal feature representing an length given its index.
- Parameters:
-
- iElem
- Length literal feature
- iI
- Index of the length (starting from one)
- See also:
- CATICkeParm
o SetLength
public virtual HRESULT SetLength( | const double | iElem, |
| const int | iI) = 0 |
-
Sets the value of a length given its index.
- Parameters:
-
- iElem
- Length value
- iI
- Index of the length (starting from one)
o SetLengthLawInversions
-
Sets information whether length laws have to be inverted or not.
- Parameters:
-
- iInversion1
- TRUE or FALSE for first length law.
- iInversion2
- TRUE or FALSE for second length law.
- See also:
- CATGSMBasicLawType
o SetLengthLawTypes
public virtual HRESULT SetLengthLawTypes( | const enum CATGSMBasicLawType | eFirstType, |
| const enum CATGSMBasicLawType | eSecondType) = 0 |
-
Sets length law types.
- Parameters:
-
- eFirstType
- First type of law (from CATGSMBasicLawType enumeration).
- eSecondType
- Second type of law (from CATGSMBasicLawType enumeration).
- See also:
- CATGSMBasicLawType
o SetLengthLaws
public virtual HRESULT SetLengthLaws( | const CATICkeParm_var& | FirstParamStart, |
| const CATICkeParm_var& | FirstParamEnd, |
| const enum CATGSMBasicLawType | eFirstType, |
| const CATICkeParm_var& | SecondParamStart, |
| const CATICkeParm_var& | SecondParamEnd, |
| const enum CATGSMBasicLawType | eSecondType) = 0 |
-
Sets information about both length laws. PREFER PREVIOUS METHOD WHICH
INCLUDES ADVANCED LAW FEATURES.
- Parameters:
-
- FirstParamStart
- Start first angle literal feature
- FirstParamEnd
- End first angle literal feature
- eFirstType
- First type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType.
- SecondParamStart
- Start second angle literal feature
- SecondParamEnd
- End second angle literal feature
- eSecondType
- Second type of law (from CATGSMBasicLawType enumeration except
CATGSMBasicLawType_Advanced).
- See also:
- CATICkeParm, CATGSMBasicLawType
o SetLengthLaws
public virtual HRESULT SetLengthLaws( | const CATISpecObject_var& | FirstParamStart, |
| const CATISpecObject_var& | FirstParamEnd, |
| const enum CATGSMBasicLawType | eFirstType, |
| const CATISpecObject_var& | SecondParamStart, |
| const CATISpecObject_var& | SecondParamEnd, |
| const enum CATGSMBasicLawType | eSecondType) = 0 |
-
Sets information about both length laws (including advanced law features).
- Parameters:
-
- FirstParamStart
- Start first angle literal feature, or law feature if advanced
- FirstParamEnd
- End first angle literal feature, or NULL_var if advanced
- eFirstType
- First type of law (from CATGSMBasicLawType enumeration):
- CATGSMBasicLawType_None,
- CATGSMBasicLawType_Constant,
- CATGSMBasicLawType_Linear,
- CATGSMBasicLawType_SType,
- CATGSMBasicLawType_Advanced.
- SecondParamStart
- Start second angle literal feature, or law feature if advanced
- SecondParamEnd
- End second angle literal feature, or NULL_var if advanced
- eSecondType
- Second type of law (from CATGSMBasicLawType enumeration).
- See also:
- CATICkeParm, CATGSMBasicLawType
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 SetMode
public virtual HRESULT SetMode( | const enum CATGSMLinearSweepCase | iElem) = 0 |
-
Sets linear sweep case number.
- Parameters:
-
- iElem
- Case number
- See also:
- CATGSMLinearSweepCase
o SetSecondLengthDefinitionType
public virtual HRESULT SetSecondLengthDefinitionType( | const enum CATGSMLinearSweepLengthType | iType, |
| const CATISpecObject_var& | iElem | = NULL_var) = 0 |
-
Sets second length definition for linear swept surfaces (for draft surfaces
only, so far).
- Parameters:
-
- iElem
- Length type
o SetSmoothActivity
-
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 SetSolutionNo
public virtual HRESULT SetSolutionNo( | int | iSolNo)=0 |
-
Sets the current solution number of the four possible solutions.
- Parameters:
-
- iSolNo
- is the solution number.
o SetSpine
-
Sets the spine.
- Parameters:
-
- iElem
- Spine feature
o SetTrimOption
public virtual HRESULT SetTrimOption( | const enum CATGSMSweepTrimMode | iOption) = 0 |
-
Sets trim option status for the first (or only) tangency surface.
- Parameters:
-
- iOption
- Trim option value
- See also:
- CATGSMSweepTrimMode
o SetTrimOptions
public virtual HRESULT SetTrimOptions( | const enum CATGSMSweepTrimMode | iOption1, |
| const enum CATGSMSweepTrimMode | iOption2) = 0 |
-
Sets trim option statuses for both tangency surfaces.
- Parameters:
-
- iOption1
- Trim option value for the first tangency surface
- iOption2
- Trim option value for the second tangency surface
- See also:
- CATGSMSweepTrimMode
This object is included in the file: CATIGSMSweepSegment.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces