pycatia.hybrid_shape_interfaces.hybrid_shape_sweep_line

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-07-06 14:02:20.222384

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.hybrid_shape_interfaces.hybrid_shape_sweep_line.HybridShapeSweepLine(com_object)

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

MecModInterfaces.HybridShape

CATGSMIDLItf.HybridShapeSweep

HybridShapeSweepLine

Represents the sweep line object.

add_draft_angle_definition_location(ip_ia_loc_elem: Reference, i_ang: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub AddDraftAngleDefinitionLocation(Reference ipIALocElem,

double iAng)

Adds a draft angle location.

Parameters:

ipIALocElem

The geometric element where the draft angle applies

iAng

The draft angle

Parameters:

• ip_ia_loc_elem (Reference) –

• i_ang (float) –

Return type:

None

property angle_law: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property AngleLaw() As Reference

Returns or sets the angular law.

Return type:

Reference

property angle_law_inversion: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property AngleLawInversion() As long

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

Return type:

int

property angle_law_type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property AngleLawType() As long

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)

Return type:

int

property canonical_detection: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property CanonicalDetection() As long

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.

Return type:

int

property context: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Context() As long

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

Return type:

int

property draft_computation_mode: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property DraftComputationMode() As long

Returns or sets the draft computation mode.

Return type:

int

property draft_direction: HybridShapeDirection

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property DraftDirection() As HybridShapeDirection

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

Return type:

HybridShapeDirection

property first_guide_crv: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property FirstGuideCrv() As Reference

Returns or sets the sweep operation first guide curve.

Return type:

Reference

property first_guide_surf: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property FirstGuideSurf() As Reference

Returns or sets the sweep operation first guide surface.

Return type:

Reference

property first_length_law: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property FirstLengthLaw() As Reference

Returns or sets the first length law useful in some linear sweep types.

Return type:

Reference

property first_length_law_inversion: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property FirstLengthLawInversion() As long

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

Return type:

int

get_angle(i_i: int) → Angle

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetAngle(long iI) As Angle

Returns the angle values useful in some linear sweep

types.

Parameters:

iI

The angle value index

Returns:

The angle value

Parameters:

i_i (int) –

Return type:

Angle

get_angular_law(op_start_ang: Angle, op_end_ang: Angle, o_law_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetAngularLaw(Angle opStartAng,

Angle opEndAng,

long 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)

Parameters:

• op_start_ang (Angle) –

• op_end_ang (Angle) –

• o_law_type (int) –

Return type:

None

get_choice_nb_surfaces(o_surf_ori1: int, o_surf_ori2: int, o_surf_coupl_ori1: int, o_surf_coupl_ori2: int, o_no: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetChoiceNbSurfaces(long oSurfOri1,

long oSurfOri2,

long oSurfCouplOri1,

long oSurfCouplOri2,

long 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.

Parameters:

• o_surf_ori1 (int) –

• o_surf_ori2 (int) –

• o_surf_coupl_ori1 (int) –

• o_surf_coupl_ori2 (int) –

• o_no (int) –

Return type:

None

get_choice_no(o_val1: int, o_val2: int, o_val3: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetChoiceNo(long oVal1,

long oVal2,

long 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)

Parameters:

• o_val1 (int) –

• o_val2 (int) –

• o_val3 (int) –

Return type:

None

get_draft_angle_definition_location(i_loc: int, op_ia_element: Reference, o_angle: Angle) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetDraftAngleDefinitionLocation(long iLoc,

Reference opIAElement,

Angle 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

Parameters:

• i_loc (int) –

• op_ia_element (Reference) –

• o_angle (Angle) –

Return type:

None

get_draft_angle_definition_locations_nb(o_count: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetDraftAngleDefinitionLocationsNb(long oCount)

Retrieves the draft angle location list size.

Parameters:

oCount

The draft angle location list size

Parameters:

o_count (int) –

Return type:

None

get_first_length_definition_type(o_first_type: int, op_ia_elem: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetFirstLengthDefinitionType(long oFirstType,

Reference 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

Parameters:

• o_first_type (int) –

• op_ia_elem (Reference) –

Return type:

None

get_first_length_law(o_length1: Length, o_length2: Length, o_law_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetFirstLengthLaw(Length oLength1,

Length oLength2,

long 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)

Parameters:

• o_length1 (Length) –

• o_length2 (Length) –

• o_law_type (int) –

Return type:

None

get_length(i_i: int) → Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Func GetLength(long iI) As Length

Returns the length values useful in some linear sweep

types.

Parameters:

iI

The length value index

Returns:

The length value

Parameters:

i_i (int) –

Return type:

Length

get_length_law_types(o_first_type: int, o_second_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetLengthLawTypes(long oFirstType,

long 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

Parameters:

• o_first_type (int) –

• o_second_type (int) –

Return type:

None

get_longitudinal_relimiters(op_ia_elem1: Reference, op_ia_elem2: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetLongitudinalRelimiters(Reference opIAElem1,

Reference 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)

Parameters:

• op_ia_elem1 (Reference) –

• op_ia_elem2 (Reference) –

Return type:

None

get_nb_angle(o_ang: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetNbAngle(long oAng)

Retrieves the number of angles.

Parameters:

oAng

The number of angles

Parameters:

o_ang (int) –

Return type:

None

get_nb_guide_crv(o_num: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetNbGuideCrv(long oNum)

Retrieves the number of guides curves.

Parameters:

oNum

The number of guide curves

Parameters:

o_num (int) –

Return type:

None

get_nb_guide_sur(o_num: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetNbGuideSur(long oNum)

Retrieves the number of guide surfaces.

Parameters:

oNum

The number of guides surfaces

Parameters:

o_num (int) –

Return type:

None

get_nb_length(o_len: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetNbLength(long oLen)

Retrieves the number of lengths.

Parameters:

oLen

The number of lengths

Parameters:

o_len (int) –

Return type:

None

get_relimiters(op_ia_elem1: Reference, op_orient1: int, op_ia_elem2: Reference, op_orient2: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetRelimiters(Reference opIAElem1,

long opOrient1,

Reference opIAElem2,

long 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

Parameters:

• op_ia_elem1 (Reference) –

• op_orient1 (int) –

• op_ia_elem2 (Reference) –

• op_orient2 (int) –

Return type:

None

get_second_length_definition_type(o_second_type: int, op_ia_elem: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetSecondLengthDefinitionType(long oSecondType,

Reference 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

Parameters:

• o_second_type (int) –

• op_ia_elem (Reference) –

Return type:

None

get_second_length_law(o_length1: Length, o_length2: Length, o_law_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetSecondLengthLaw(Length oLength1,

Length oLength2,

long 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)

Parameters:

• o_length1 (Length) –

• o_length2 (Length) –

• o_law_type (int) –

Return type:

None

property guide_deviation: Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property GuideDeviation() As Length (Read Only)

Returns the deviation value (length) from guide curves allowed during a

sweeping operation in order to smooth it.

Return type:

Length

property guide_deviation_activity: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property GuideDeviationActivity() As boolean

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).

Return type:

bool

insert_draft_angle_definition_location(i_elem: Reference, i_angle: Angle, i_pos: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub InsertDraftAngleDefinitionLocation(Reference iElem,

Angle iAngle,

long 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.

Parameters:

• i_elem (Reference) –

• i_angle (Angle) –

• i_pos (int) –

Return type:

None

property mode: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Mode() As long

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)

Return type:

int

remove_all_draft_angle_definition_locations() → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub RemoveAllDraftAngleDefinitionLocations()

Removes all geometrical elements and values necessary for draft angle

definition.

Return type:

None

remove_angle() → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub RemoveAngle()

Removes an angle.

Return type:

None

remove_draft_angle_definition_location_position(i_pos: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub RemoveDraftAngleDefinitionLocationPosition(long iPos)

Removes a draft angle location.

Parameters:

iPos

The position in the list of the draft angle location to

remove

Parameters:

i_pos (int) –

Return type:

None

remove_guide_crv() → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub RemoveGuideCrv()

Removes a guide curve.

Return type:

None

remove_guide_sur() → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub RemoveGuideSur()

Removes a guide surface.

Return type:

None

remove_length() → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub RemoveLength()

Removes a length.

Return type:

None

property second_guide_crv: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property SecondGuideCrv() As Reference

Returns or sets the sweep operation second guide curve.

Return type:

Reference

property second_guide_surf: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property SecondGuideSurf() As Reference

Returns or sets the sweep operation second guide surface.

Return type:

Reference

property second_length_law: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property SecondLengthLaw() As Reference

Returns or sets second length law useful in some linear sweep types.

Return type:

Reference

property second_length_law_inversion: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property SecondLengthLawInversion() As long

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

Return type:

int

property second_trim_option: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property SecondTrimOption() As long

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)

Return type:

int

set_angle(i_i: int, i_elem: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetAngle(long iI,

double iElem)

Sets the angle values useful in some linear sweep types.

Parameters:

iI

The angle value index

iElem

The angle value

Parameters:

• i_i (int) –

• i_elem (float) –

Return type:

None

set_angular_law(i_start_ang: float, i_end_ang: float, i_law_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetAngularLaw(double iStartAng,

double iEndAng,

long 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)

Parameters:

• i_start_ang (float) –

• i_end_ang (float) –

• i_law_type (int) –

Return type:

None

set_choice_nb_surfaces(i_surf_ori1: int, i_surf_ori2: int, i_surf_coupl_ori1: int, i_surf_coupl_ori2: int, i_no: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetChoiceNbSurfaces(long iSurfOri1,

long iSurfOri2,

long iSurfCouplOri1,

long iSurfCouplOri2,

long 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.

Parameters:

• i_surf_ori1 (int) –

• i_surf_ori2 (int) –

• i_surf_coupl_ori1 (int) –

• i_surf_coupl_ori2 (int) –

• i_no (int) –

Return type:

None

set_choice_no(i_val1: int, i_val2: int, i_val3: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetChoiceNo(long iVal1,

long iVal2,

long 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)

Parameters:

• i_val1 (int) –

• i_val2 (int) –

• i_val3 (int) –

Return type:

None

set_first_length_definition_type(i_first_type: int, ip_ia_elem: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetFirstLengthDefinitionType(long iFirstType,

Reference 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

Parameters:

• i_first_type (int) –

• ip_ia_elem (Reference) –

Return type:

None

set_first_length_law(i_length1: float, i_length2: float, i_law_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetFirstLengthLaw(double iLength1,

double iLength2,

long 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)

Parameters:

• i_length1 (float) –

• i_length2 (float) –

• i_law_type (int) –

Return type:

None

set_guide_deviation(i_length: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetGuideDeviation(double iLength)

Sets the deviation value (length) from guide curves allowed during sweeping

operation in order to smooth it.

Parameters:

iLength

The deviation value

Parameters:

i_length (float) –

Return type:

None

set_length(i_i: int, i_elem: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetLength(long iI,

double iElem)

Sets the linear values useful in some linear sweep types.

Parameters:

iI

The linear value index

iElem

The linear value

Parameters:

• i_i (int) –

• i_elem (float) –

Return type:

None

set_length_law_types(i_first_type: int, i_second_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetLengthLawTypes(long iFirstType,

long 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

Parameters:

• i_first_type (int) –

• i_second_type (int) –

Return type:

None

set_longitudinal_relimiters(ip_ia_elem1: Reference, ip_ia_elem2: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetLongitudinalRelimiters(Reference ipIAElem1,

Reference 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)

Parameters:

• ip_ia_elem1 (Reference) –

• ip_ia_elem2 (Reference) –

Return type:

None

set_relimiters(ip_ia_elem1: Reference, ip_orient1: int, ip_ia_elem2: Reference, ip_orient2: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetRelimiters(Reference ipIAElem1,

long ipOrient1,

Reference ipIAElem2,

long 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

Parameters:

• ip_ia_elem1 (Reference) –

• ip_orient1 (int) –

• ip_ia_elem2 (Reference) –

• ip_orient2 (int) –

Return type:

None

set_second_length_definition_type(i_second_type: int, ip_ia_elem: Reference) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetSecondLengthDefinitionType(long iSecondType,

Reference 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

Parameters:

• i_second_type (int) –

• ip_ia_elem (Reference) –

Return type:

None

set_second_length_law(i_length1: float, i_length2: float, i_law_type: int) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetSecondLengthLaw(double iLength1,

double iLength2,

long 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)

Parameters:

• i_length1 (float) –

• i_length2 (float) –

• i_law_type (int) –

Return type:

None

set_smooth_angle_threshold(i_angle: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub SetSmoothAngleThreshold(double iAngle)

Sets the angular threshold.

Parameters:

iAngle

The angle numerical value

Parameters:

i_angle (float) –

Return type:

None

property smooth_activity: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property SmoothActivity() As boolean

Returns whether the sweeping operation is smoothed.

TRUE if the sweeping operation is smoothed, or FALSE otherwise (FALSE if

not specified).

Return type:

bool

property smooth_angle_threshold: Angle

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property SmoothAngleThreshold() As Angle (Read Only)

Returns the angular threshold.

Return type:

Angle

property solution_no: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property SolutionNo() As long

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.

Return type:

int

property spine: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Spine() As Reference

Returns or sets the sweep operation spine (optional).

Return type:

Reference

property trim_option: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property TrimOption() As long

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)

Return type:

int