HybridShapeSweepLine (Object)

Represents the sweep line object.

Properties


Property AngleLaw() As
Returns or sets the angular law.
Property AngleLawInversion() As
Returns or sets whether the angular law has to be inverted.
Legal angular law inversion values are:
0 The angular law has NOT to be inverted
1 The angular law has to be inverted
Property AngleLawType() As
Returns or sets the angular law type.
Legal angular law type values are:
0 Undefined law type (CATGSMBasicLawType_None)
1 Constant law type (CATGSMBasicLawType_Constant)
2 Linear law type (CATGSMBasicLawType_Linear)
3 S law type (CATGSMBasicLawType_SType)
4 Law specified by a GSD law feature (CATGSMBasicLawType_Advanced)
Property CanonicalDetection() As
Returns or sets whether canonical surfaces of the swept surface are detected.
Legal values:
0 No detection of canonical surface is performed.
2 Detection of canonical surfaces is performed.
Property Context() As
Returns or sets the context on Sweep feature.
  • 0 This option creates Swept surface.
  • 1 This option creates Swept volume.

Note: Setting volume result requires GSO License.
Example:
This example retrieves in oContext the context for the Sweep hybrid shape feature. 
 Dim oContext
 Set oContext = Sweep.Context
Property DraftComputationMode() As
Returns or sets the draft computation mode.
Property DraftDirection() As
Returns or sets the draft direction.
Example
:
This example retrieves in oDirection the direction of the LinearSweep feature. 
 Dim oDirection As CATIAHybridShapeDirection
 Set oDirection = LinearSweep.DraftDirection
Property FirstGuideCrv() As
Returns or sets the sweep operation first guide curve.
Property FirstGuideSurf() As
Returns or sets the sweep operation first guide surface.
Property FirstLengthLaw() As
Returns or sets the first length law useful in some linear sweep types.
Property FirstLengthLawInversion() As
Returns or sets whether the first length law has to be inverted.
Legal length law inversion values are:
0 The length law has NOT to be inverted
1 The length law has to be inverted
Property GuideDeviation() As (Read Only)
Returns the deviation value (length) from guide curves allowed during a sweeping operation in order to smooth it.
Property GuideDeviationActivity() As
Returns or sets whether a deviation from guide curves is allowed.
This property gives the information on performing smoothing during sweeping operation.
TRUE if a deviation from guide curves is allowed, or FALSE otherwise (FALSE if not specified).
Property Mode() As
Returns or sets the linear sweep mode.
Legal mode values are:
0 Undefined linear profile swept surface (CATGSMLinearSweep_None)
1 Linear profile swept surface defined by two guide curves (CATGSMLinearSweep_TwoGuides)
2 Linear profile swept surface defined by a guide curve and an angle (CATGSMLinearSweep_GuideAndAngleCurve)
3 Linear profile swept surface defined by a guide curve and a middle curve (CATGSMLinearSweep_GuideAndMiddle)
4 Linear profile swept surface defined by a guide curve and an angle from a reference surface (CATGSMLinearSweep_GuideAndRefSurfaceAngle)
5 Linear profile swept surface defined by a guide curve and a tangency surface (CATGSMLinearSweep_GuideAndTangencySurface)
6 Linear profile swept surface defined by a guide curve and a draft directio (CATGSMLinearSweep_GuideAndDraftDirection)
7 Linear profile swept surface defined by two tangency surfaces (CATGSMLinearSweep_TwoTangencySurfaces)
Property SecondGuideCrv() As
Returns or sets the sweep operation second guide curve.
Property SecondGuideSurf() As
Returns or sets the sweep operation second guide surface.
Property SecondLengthLaw() As
Returns or sets second length law useful in some linear sweep types.
Property SecondLengthLawInversion() As
Returns or sets whether the second length law has to be inverted.
Legal length law inversion values are:
0 The length law has NOT to be inverted
1 The length law has to be inverted
Property SecondTrimOption() As
Returns or sets the trim option for the second tangency surface.

Legal trim option values are:
0 No trim computed or trim undefined (CATGSMSweepTrimMode_None)
1 Trim computed (CATGSMSweepTrimMode_On)
Property SmoothActivity() As
Returns whether the sweeping operation is smoothed.
TRUE if the sweeping operation is smoothed, or FALSE otherwise (FALSE if not specified).
Property SmoothAngleThreshold() As (Read Only)
Returns the angular threshold.
Property SolutionNo() As
Returns or sets the choice number, which corresponds to each solution of a given linear sweep case.
For example: a linear sweep with reference surface leads to four possible solutions.
Property Spine() As
Returns or sets the sweep operation spine (optional).
Property TrimOption() As
Returns or sets the trim option.

Legal trim option values are:
0 No trim computed or trim undefined (CATGSMSweepTrimMode_None)
1 Trim computed (CATGSMSweepTrimMode_On)

Methods


Sub AddDraftAngleDefinitionLocation( ipIALocElem, iAng)
Adds a draft angle location.
Parameters:
ipIALocElem
The geometric element where the draft angle applies
iAng
The draft angle
Func GetAngle( iI) As
Returns the angle values useful in some linear sweep types.
Parameters:
iI
The angle value index
Returns:
The angle value
Sub GetAngularLaw( opStartAng, opEndAng, oLawType)
Retrieves the angular law useful in some linear sweep types.
Parameters:
opStartAng
The angular law start value
opEndAng
The angular law end value
oLawType
The angular law type
Legal angular law type values are:
0 Undefined law type (CATGSMBasicLawType_None)
1 Constant law type (CATGSMBasicLawType_Constant)
2 Linear law type (CATGSMBasicLawType_Linear)
3 S law type (CATGSMBasicLawType_SType)
4 Law specified by a GSD law feature (CATGSMBasicLawType_Advanced)
Sub GetChoiceNbSurfaces( oSurfOri1, oSurfOri2, oSurfCouplOri1, oSurfCouplOri2, oNo)
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 surface,
* 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. Possible values are as for oSurfOri1.
oSurfCouplOri1
This orientation determines the location of the results with regard to the trihedron 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 trihedron defined by the the spine, the normal to the second surface and the tangent to the linear profile. Possible values are as for oSurfCouplOri1.
oNo
Given the previous orientations, solution number in a distance ordered list.
Sub GetChoiceNo( oVal1, oVal2, oVal3)
Retrieves the choice number associated with each solution of a given linear sweep case.
Example: a linear sweep with one guide curve and a tangency surface may lead to several possible solutions.
Parameters:
oVal1
The solution number (from 1 to n)
oVal2
In the example, the shell orientation : -1, +1 or 0 (both +1 and -1)
val3
In the example, the wire orientation : -1, +1 or 0 (both +1 and -1)
Sub GetDraftAngleDefinitionLocation( iLoc, opIAElement, oAngle)
Retrieves the draft angle location element.
Parameters:
iLoc
The draft angle location position in the list
opIAElement
The geometric element at that location and where the draft angle applies
oAngle
The draft angle
Sub GetDraftAngleDefinitionLocationsNb( oCount)
Retrieves the draft angle location list size.
Parameters:
oCount
The draft angle location list size
Sub GetFirstLengthDefinitionType( oFirstType, opIAElem)
Retrieves the first length definition type.
Parameters:
oFirstType
The first length definition type
Legal length definition types are:
0 Undefined length type (CATGSMLinearSweepLengthType_None)
1 Length of the swept line in the sweeping plane from the guide curve (CATGSMLinearSweepLengthType_Standard)
2 No numerical value is required, equivalent to standard length at zero (CATGSMLinearSweepLengthType_FromCurve)
3 Up to or from a geometrical reference (a surface) (CATGSMLinearSweepLengthType_Reference)
4 Only for draft surfaces, the length is computed in the draft direction from an extremum point on the guide curve (CATGSMLinearSweepLengthType_FromExtremum)
5 Only for draft surfaces, the length will be used in a way similar to euclidean parallel curve distance on the swept surface (CATGSMLinearSweepLengthType_AlongSurface)
opIAElem
The geometric element where the first length definition type applies
Sub GetFirstLengthLaw( oLength1, oLength2, oLawType)
Retrieves the first length law useful in some linear sweep types.
Parameters:
oLength1
The length law start value
oLength2
The length law end value
oLawType
The length law type
Legal length law type values are:
0 Undefined law type (CATGSMBasicLawType_None)
1 Constant law type (CATGSMBasicLawType_Constant)
2 Linear law type (CATGSMBasicLawType_Linear)
3 S law type (CATGSMBasicLawType_SType)
4 Law specified by a GSD law feature (CATGSMBasicLawType_Advanced)
Func GetLength( iI) As
Returns the length values useful in some linear sweep types.
Parameters:
iI
The length value index
Returns:
The length value
Sub GetLengthLawTypes( oFirstType, oSecondType)
Gets length law types.
Parameters:
oFirstType
First type of law.
oSecondType
Second type of law. oFirstType and oSecondType = 0 : Undefined law type = 1 : Constant law type = 2 : Linear law type = 3 : S law type = 4 : Law specified by a GSD law feature = 5 : Law specified by a set of points and parameters
Sub GetLongitudinalRelimiters( opIAElem1, opIAElem2)
Deprecated:
V5R16 CATHybridShapeSweepLine#GetRelimiters Retrieves the elements relimiting the spine (or the default spine).
Parameters:
opIAElem1
The first relimiting feature (plane or point)
opIAElem2
The second relimiting feature (plane or point)
Sub GetNbAngle( oAng)
Retrieves the number of angles.
Parameters:
oAng
The number of angles
Sub GetNbGuideCrv( oNum)
Retrieves the number of guides curves.
Parameters:
oNum
The number of guide curves
Sub GetNbGuideSur( oNum)
Retrieves the number of guide surfaces.
Parameters:
oNum
The number of guides surfaces
Sub GetNbLength( oLen)
Retrieves the number of lengths.
Parameters:
oLen
The number of lengths
Sub GetRelimiters( opIAElem1, opOrient1, opIAElem2, opOrient2)
Retrieves the elements relimiting the spine (or the default spine).
Parameters:
opIAElem1
The first relimiting feature (plane or point)
opOrient1
Split direction for the first relimitation
0 means that the beginning of the spine (considering its orientation) is removed, 1 means that the end of the spine is removed
opIAElem2
The second relimiting feature (plane or point)
opOrient2
Split direction for the second relimitation
Sub GetSecondLengthDefinitionType( oSecondType, opIAElem)
Retrieves the second length definition type.
Parameters:
oSecondType
The second length definition type
Legal length definition types are:
0 Undefined length type (CATGSMLinearSweepLengthType_None)
1 Length of the swept line in the sweeping plane from the guide curve (CATGSMLinearSweepLengthType_Standard)
2 No numerical value is required, equivalent to standard length at zero (CATGSMLinearSweepLengthType_FromCurve)
3 Up to or from a geometrical reference (a surface) (CATGSMLinearSweepLengthType_Reference)
4 Only for draft surfaces, the length is computed in the draft direction from an extremum point on the guide curve (CATGSMLinearSweepLengthType_FromExtremum)
5 Only for draft surfaces, the length will be used in a way similar to euclidean parallel curve distance on the swept surface (CATGSMLinearSweepLengthType_AlongSurface)
opIAElem
The geometric element where the second length definition type applies
Sub GetSecondLengthLaw( oLength1, oLength2, oLawType)
Retrieves the second length law useful in some linear sweep types.
Parameters:
oLength1
The length law start value
oLength2
The length law end value
oLawType
The length law type
Legal length law type values are:
0 Undefined law type (CATGSMBasicLawType_None)
1 Constant law type (CATGSMBasicLawType_Constant)
2 Linear law type (CATGSMBasicLawType_Linear)
3 S law type (CATGSMBasicLawType_SType)
4 Law specified by a GSD law feature (CATGSMBasicLawType_Advanced)
Sub InsertDraftAngleDefinitionLocation( iElem, iAngle, iPos)
Inserts a geometrical element and a value necessary for draft angle definition after a given position in the lists.
Parameters:
iElem
Geometrical element
iAngle
Angular parameter
iPos
Position in lists. To insert in the beginning of the list put iPos = 0.
Sub RemoveAllDraftAngleDefinitionLocations()
Removes all geometrical elements and values necessary for draft angle definition.
Sub RemoveAngle()
Removes an angle.
Sub RemoveDraftAngleDefinitionLocationPosition( iPos)
Removes a draft angle location.
Parameters:
iPos
The position in the list of the draft angle location to remove
Sub RemoveGuideCrv()
Removes a guide curve.
Sub RemoveGuideSur()
Removes a guide surface.
Sub RemoveLength()
Removes a length.
Sub SetAngle( iI, iElem)
Sets the angle values useful in some linear sweep types.
Parameters:
iI
The angle value index
iElem
The angle value
Sub SetAngularLaw( iStartAng, iEndAng, iLawType)
Sets the angular law useful in some linear sweep types.
Parameters:
iStartAng
The angular law start value
iEndAng
The angular law end value
iLawType
The angular law type
Legal angular law type values are:
0 Undefined law type (CATGSMBasicLawType_None)
1 Constant law type (CATGSMBasicLawType_Constant)
2 Linear law type (CATGSMBasicLawType_Linear)
3 S law type (CATGSMBasicLawType_SType)
4 Law specified by a GSD law feature (CATGSMBasicLawType_Advanced)
Sub SetChoiceNbSurfaces( iSurfOri1, iSurfOri2, iSurfCouplOri1, iSurfCouplOri2, iNo)
Sets a sequence which identifies a solution amongst all possibilities of a line-profile swept surface, case CATGSMLinearSweep_TwoTangencySurfaces.
Parameters:
iSurfOri1
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.
iSurfOri2
This orientation determines the location of the results with regard to the second surface. Possible values are as for iSurfOri1.
iSurfCouplOri1
This orientation determines the location of the results with regard to the trihedron 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.
iSurfCouplOri2
This orientation determines the location of the results with regard to the trihedron defined by the the spine, the normal to the second surface and the tangent to the linear profile. Possible values are as for iSurfCouplOri2.
iNo
Given the previous orientations, solution number in a distance ordered list.
Sub SetChoiceNo( iVal1, iVal2, iVal3)
Sets the choice number associated with each solution of a given linear sweep case.
Example: a linear sweep with one guide curve and a tangency surface may lead to several possible solutions.
Parameters:
iVal1
The solution number (from 1 to n)
iVal2
In the example, the shell orientation : -1, +1 or 0 (both +1 and -1)
iVal3
In the example, the wire orientation : -1, +1 or 0 (both +1 and -1)
Sub SetFirstLengthDefinitionType( iFirstType, ipIAElem)
Sets the first length definition type.
Parameters:
iFirstType
The first length definition type
Legal length definition types are:
0 Undefined length type (CATGSMLinearSweepLengthType_None)
1 Length of the swept line in the sweeping plane from the guide curve (CATGSMLinearSweepLengthType_Standard)
2 No numerical value is required, equivalent to standard length at zero (CATGSMLinearSweepLengthType_FromCurve)
3 Up to or from a geometrical reference (a surface) (CATGSMLinearSweepLengthType_Reference)
4 Only for draft surfaces, the length is computed in the draft direction from an extremum point on the guide curve (CATGSMLinearSweepLengthType_FromExtremum)
5 Only for draft surfaces, the length will be used in a way similar to euclidean parallel curve distance on the swept surface (CATGSMLinearSweepLengthType_AlongSurface)
ipIAElem
The geometric element where the first length definition type applies
Sub SetFirstLengthLaw( iLength1, iLength2, iLawType)
Sets the first length law useful in some linear sweep types.
Parameters:
iLength1
The length law start value
iLength2
The length law end value
iLawType
The length law type
Legal length law type values are:
0 Undefined law type (CATGSMBasicLawType_None)
1 Constant law type (CATGSMBasicLawType_Constant)
2 Linear law type (CATGSMBasicLawType_Linear)
3 S law type (CATGSMBasicLawType_SType)
4 Law specified by a GSD law feature (CATGSMBasicLawType_Advanced)
Sub SetGuideDeviation( iLength)
Sets the deviation value (length) from guide curves allowed during sweeping operation in order to smooth it.
Parameters:
iLength
The deviation value
Sub SetLength( iI, iElem)
Sets the linear values useful in some linear sweep types.
Parameters:
iI
The linear value index
iElem
The linear value
Sub SetLengthLawTypes( iFirstType, iSecondType)
Sets length law types.
Parameters:
iFirstType
First type of law.
iSecondType
Second type of law. iFirstType and iSecondType = 0 : Undefined law type = 1 : Constant law type = 2 : Linear law type = 3 : S law type = 4 : Law specified by a GSD law feature = 5 : Law specified by a set of points and parameters
Sub SetLongitudinalRelimiters( ipIAElem1, ipIAElem2)
Deprecated:
V5R16 CATHybridShapeSweepLine#SetRelimiters Sets the elements relimiting the spine (or the default spine).
Parameters:
ipIAElem1
The first relimiting feature (plane or point)
ipIAElem2
The second relimiting feature (plane or point)
Sub SetRelimiters( ipIAElem1, ipOrient1, ipIAElem2, ipOrient2)
Sets the elements relimiting the spine (or the default spine).
Parameters:
ipIAElem1
The first relimiting feature (plane or point)
ipOrient1
Split direction for the first relimitation
0 means that the beginning of the spine (considering its orientation) is removed, 1 means that the end of the spine is removed
ipIAElem2
The second relimiting feature (plane or point)
ipOrient2
Split direction for the second relimitation
Sub SetSecondLengthDefinitionType( iSecondType, ipIAElem)
Sets the second length definition type.
Parameters:
iSecondType
The second length definition type
Legal length definition types are:
0 Undefined length type (CATGSMLinearSweepLengthType_None)
1 Length of the swept line in the sweeping plane from the guide curve (CATGSMLinearSweepLengthType_Standard)
2 No numerical value is required, equivalent to standard length at zero (CATGSMLinearSweepLengthType_FromCurve)
3 Up to or from a geometrical reference (a surface) (CATGSMLinearSweepLengthType_Reference)
4 Only for draft surfaces, the length is computed in the draft direction from an extremum point on the guide curve (CATGSMLinearSweepLengthType_FromExtremum)
5 Only for draft surfaces, the length will be used in a way similar to euclidean parallel curve distance on the swept surface (CATGSMLinearSweepLengthType_AlongSurface)
ipIAElem
The geometric element where the second length definition type applies
Sub SetSecondLengthLaw( iLength1, iLength2, iLawType)
Sets the second length law useful in some linear sweep types.
Parameters:
iLength1
The length law start value
iLength2
The length law end value
iLawType
The length law type
Legal length law type values are:
0 Undefined law type (CATGSMBasicLawType_None)
1 Constant law type (CATGSMBasicLawType_Constant)
2 Linear law type (CATGSMBasicLawType_Linear)
3 S law type (CATGSMBasicLawType_SType)
4 Law specified by a GSD law feature (CATGSMBasicLawType_Advanced)
Sub SetSmoothAngleThreshold( iAngle)
Sets the angular threshold.
Parameters:
iAngle
The angle numerical value