pycatia.hybrid_shape_interfaces.hybrid_shape_sweep_circle

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_circle.HybridShapeSweepCircle(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

HybridShapeSweepCircle

Represents the hybrid shape sweep circle feature object.

Role: To access the data of the hybrid shape sweep circle feature

object.

LICENSING INFORMATION: Creation of volume result requires GSO

License

if GSO License is not granted , setting of Volume context has not

effect

See also:

HybridShapeFactory

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 choice_no: int

Note

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

o Property ChoiceNo() As long

Returns or sets the choice number, which corresponds to each solution of a

given circular sweep case.

For example: a circular sweep with two guide curves and a radius leads to

four possible solutions.

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 first_angle_law: Reference

Note

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

o Property FirstAngleLaw() As Reference

Returns or sets the first angle law useful in some circular sweep types.

Return type:

Reference

property first_angle_law_inversion: int

Note

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

o Property FirstAngleLawInversion() As long

Returns or sets the first angle law inversion information.

Return type:

int

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

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 circular sweep

types.

Parameters:

iI

The angle value index

Returns:

The angle value

Parameters:

i_i (int) –

Return type:

Angle

get_angle_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 GetAngleLawTypes(long oFirstType,

long oSecondType)

Retrieves angle law types.

Parameters:

oFirstType

The first type of law (from CATGSMBasicLawType

enumeration).

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)

oSecondType

The second type of law (from CATGSMBasicLawType

enumeration).

Same legal values as oFirstType

Parameters:

• o_first_type (int) –

• o_second_type (int) –

Return type:

None

get_first_angle_law(o_elem1: Angle, o_elem2: Angle, ol_law_type: int) → None

Note

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

o Sub GetFirstAngleLaw(Angle oElem1,

Angle oElem2,

long olLawType)

Retrieves the first angle law useful in some circular sweep

types.

Parameters:

oElem1

The angle law start value

oElem2

The angle law end value

olLawType

The angle law type

Parameters:

• o_elem1 (Angle) –

• o_elem2 (Angle) –

• ol_law_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 CATHybridShapeSweepCircle#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(o_num: int) → None

Note

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

o Sub GetNbGuide(long oNum)

Retrieves the number of guide curves.

Parameters:

oNum

The number of guide curves

Parameters:

o_num (int) –

Return type:

None

get_nb_radius(o_rad: int) → None

Note

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

o Sub GetNbRadius(long oRad)

Retrieves the number of radii.

Parameters:

oRad

The number of radii

Parameters:

o_rad (int) –

Return type:

None

get_radius(i_i: int) → Length

Note

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

o Func GetRadius(long iI) As Length

Returns the radius value useful in some circular sweep

types.

Parameters:

iI

The radius value index (1: start value, 2: end value)

Returns:

The radius value

Parameters:

i_i (int) –

Return type:

Length

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_angle_law(o_elem1: Angle, o_elem2: Angle, ol_law_type: int) → None

Note

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

o Sub GetSecondAngleLaw(Angle oElem1,

Angle oElem2,

long olLawType)

Retrieves the second angle law useful in some circular sweep

types.

Parameters:

oElem1

The angle law start value

oElem2

The angle law end value

olLawType

The angle law type

Parameters:

• o_elem1 (Angle) –

• o_elem2 (Angle) –

• ol_law_type (int) –

Return type:

None

get_tangency_choice_no(o_no: int, o_shell_ori: int, o_guide_ori: int) → None

Note

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

o Sub GetTangencyChoiceNo(long oNo,

long oShellOri,

long oGuideOri)

Retrieves a sequence which identifies a solution among all possibilities of

a circular profile sweep tangent to a surface. (case

CATGSMCircularSweep_GuideAndTangencyAndRadius).

Parameters:

oNo

Given the orientations, solution number in a distance ordered list.

oShellOri

This orientation allows to compute just the results that are

tangent to a specific side of the shell. It can take three

values:

+1 The result is on the normal side of the shell

-1 The result is on the side of the shell opposite to the

normal

0 No orientation is specified

oGuideOri

This orientation allows to compute just the results that are on the

“left” or the “right” side of the shell, when looking in the guide direction.

It can take three values:

+1 The result is on the “left” side

-1 The result is on the “right” side

0 No orientation is specified

Parameters:

• o_no (int) –

• o_shell_ori (int) –

• o_guide_ori (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 information whether a deviation from guide curves is

allowed or not.

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

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 circular sweep mode.

Legal mode values are:

0 Undefined circular profile swept surface

(CATGSMCircularSweep_None)

2 Circular profile swept surface defined by three guide curves (4

solutions) (CATGSMCircularSweep_ThreeGuides)

3 Circular profile swept surface defined by a center curve and a reference

curve (for angles and radius)

(CATGSMCircularSweep_TwoGuidesAndRadius)

5 Circular profile swept surface defined by a center curve and a reference

curve (for angles and radius)

(CATGSMCircularSweep_CenterAndAngleCurve)

6 Circular profile swept surface defined by a center curve and a radius

(CATGSMCircularSweep_CenterAndRadius)

7 Circular profile swept surface defined by two guide curves with a

tangency condition on the second one (with reference surface)

(CATGSMCircularSweep_TwoGuidesAndTangency)

8 Circular profile swept surface defined by a guide curve, a radius and a

tangency surface

(CATGSMCircularSweep_GuideAndTangencyAndRadius)

Return type:

int

property radius_law: Reference

Note

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

o Property RadiusLaw() As Reference

Returns or sets the radius law feature.

Return type:

Reference

property radius_law_inversion: int

Note

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

o Property RadiusLawInversion() As long

Returns or sets the radius law inversion information.

Return type:

int

property radius_law_type: int

Note

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

o Property RadiusLawType() As long

Returns or sets the radius law type.

Return type:

int

property reference: Reference

Note

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

o Property Reference() As Reference

Returns or sets the reference (functional curve or guide surface).

Return type:

Reference

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_guide() → None

Note

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

o Sub RemoveGuide()

Removes a guide curve.

Return type:

None

remove_radius() → None

Note

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

o Sub RemoveRadius()

Removes a radius.

Return type:

None

property second_angle_law: Reference

Note

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

o Property SecondAngleLaw() As Reference

Returns or sets the second angle law useful in some circular sweep types.

Return type:

Reference

property second_angle_law_inversion: int

Note

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

o Property SecondAngleLawInversion() As long

Returns or sets the second angle law inversion information.

Return type:

int

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

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 circular sweep types.

Parameters:

iI

The angle value index

iElem

The angle value

Parameters:

• i_i (int) –

• i_elem (float) –

Return type:

None

set_angle_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 SetAngleLawTypes(long iFirstType,

long iSecondType)

Sets angle law types.

Parameters:

iFirstType

The first type of law (from CATGSMBasicLawType

enumeration).

Legal values:

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)

iSecondType

The second type of law (from CATGSMBasicLawType

enumeration).

Same legal values as iFirstType

Parameters:

• i_first_type (int) –

• i_second_type (int) –

Return type:

None

set_first_angle_law(i_elem1: float, i_elem2: float, il_law_type: int) → None

Note

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

o Sub SetFirstAngleLaw(double iElem1,

double iElem2,

long ilLawType)

Sets the first angle law useful in some circular sweep

types.

Parameters:

iElem1

The angle law start value

iElem2

The angle law end value

ilLawType

The angle law type

Parameters:

• i_elem1 (float) –

• i_elem2 (float) –

• il_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_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 CATHybridShapeSweepCircle#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_radius(i_i: int, i_radius: float) → None

Note

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

o Sub SetRadius(long iI,

double iRadius)

Sets the radius value useful in some circular sweep types.

Parameters:

iI

The radius value index (1: start value, 2: end value)

iRadius

The radius value

Parameters:

• i_i (int) –

• i_radius (float) –

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_angle_law(i_elem1: float, i_elem2: float, il_law_type: int) → None

Note

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

o Sub SetSecondAngleLaw(double iElem1,

double iElem2,

long ilLawType)

Sets the second angle law useful in some circular sweep

types.

Parameters:

iElem1

The angle law start value

iElem2

The angle law end value

ilLawType

Tha angle law type

Parameters:

• i_elem1 (float) –

• i_elem2 (float) –

• il_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 angular threshold

Parameters:

i_angle (float) –

Return type:

None

set_tangency_choice_no(i_shell_ori: int, i_guide_ori: int, i_no: int) → None

Note

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

o Sub SetTangencyChoiceNo(long iShellOri,

long iGuideOri,

long iNo)

Sets a sequence which identifies a solutionamong all possibilities of a

circular profile sweep tangent to a surface.

Parameters:

iNo

Given the orientations, solution number in a distance ordered list.

iShellOri

This orientation allows to compute just the results that are

tangent to a specific side of the shell. It can take three

values:

+1 The result is on the normal side of the shell

-1 The result is on the side of the shell opposite to the

normal

0 No orientation is specified

iGuideOri

This orientation allows to compute just the results that are on the

“left” or the “right” side of the shell, when looking in the guide direction.

It can take three values:

+1 The result is on the “left” side

-1 The result is on the “right” side

0 No orientation is specified

Parameters:

• i_shell_ori (int) –

• i_guide_ori (int) –

• i_no (int) –

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 or sets information whether a sweeping operation is smoothed or

not.

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 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 third_guide_crv: Reference

Note

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

o Property ThirdGuideCrv() As Reference

Returns or sets the sweep operation third guide curve.

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

The trim option status legal values are:

0 No trim computed or undefined

(CATGSMSweepTrimMode_None)

1 Trim computed (CATGSMSweepTrimMode_On)

Return type:

int