pycatia.hybrid_shape_interfaces.hybrid_shape_sweep_conic

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_conic.HybridShapeSweepConic(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

HybridShapeSweepConic

Represents the hybrid shape conic sweep feature.

Role: To access the data of the conic sweep feature .

Use the HybridShapeFactory.AddNewSweepConic to create a HybridShapeConicSweep

object.

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

Note

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

o Property FifthGuideCrv() As Reference

Returns or sets the fifth guide curve.

Return type:

Reference

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 first guide curve.

Return type:

Reference

property fourth_guide_crv: Reference

Note

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

o Property FourthGuideCrv() As Reference

Returns or sets the fourth guide curve.

Return type:

Reference

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 CATHybridShapeSweepConic#GetRelimiters Gets the elements

relimiting the spine (or the default spine).

param : opIAElem1 First relimiting feature (plane or point)

param : opIAElem2 Second relimiting feature (plane or point)

Parameters:

• op_ia_elem1 (Reference) –

• op_ia_elem2 (Reference) –

Return type:

None

get_nb_guides(o_num: int) → None

Note

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

o Sub GetNbGuides(long oNum)

Gets the number of guides.

param : oNum Number of guides curve.

Parameters:

o_num (int) –

Return type:

None

get_parameter_law(o_param_start: float, o_param_end: float, o_law_type: int) → None

Note

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

o Sub GetParameterLaw(double oParamStart,

double oParamEnd,

long oLawType)

Gets the parameter law used in conic sweep operation.

param : oParamStart Parameter law start value.

param : oParamEnd Parameter law end value.

param : oLawType Parameter law type.

Parameters:

• o_param_start (float) –

• o_param_end (float) –

• o_law_type (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_tangency(op_ia_elem: Reference, op_ia_angle_start: Angle, op_ia_angle_end: Angle, o_law_type: int, i_index: int) → None

Note

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

o Sub GetTangency(Reference opIAElem,

Angle opIAAngleStart,

Angle opIAAngleEnd,

long oLawType,

long iIndex)

Gets tangency surface or curve and its angle given the guide curve

index.

param : opIAElem

param : opIAAngleStart Start tangency angle from surface or curve reference.

param : opIAAngleEnd End tangency angle from surface or curve reference.

param : oLawType Type of law used for tangency angle from surface or curve reference.

param : iIndex Guide curve index : 1 to 5.

Parameters:

• op_ia_elem (Reference) –

• op_ia_angle_start (Angle) –

• op_ia_angle_end (Angle) –

• o_law_type (int) –

• i_index (int) –

Return type:

None

get_tangency_angle_law_inversion(i_index: int, o_inversion: int) → None

Note

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

o Sub GetTangencyAngleLawInversion(long iIndex,

long oInversion)

Gets information whether tangency angle law has to be inverted or not for a

specified guide curve.

param : iIndex Guide curve index : 1 to 5

param : oInversion Non-Zero for TRUE and 0 for FALSE.

Parameters:

• i_index (int) –

• o_inversion (int) –

Return type:

None

get_tangency_law(op_ia_elem: Reference, op_ia_law: Reference, i_index: int) → None

Note

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

o Sub GetTangencyLaw(Reference opIAElem,

Reference opIALaw,

long iIndex)

Gets tangency surface or curve and its angle given the guide curve

index.

param : opIAElem Tangency surface or curve feature.

param : opIALaw Start tangency angle from surface or curve reference.

param : iIndex Guide curve index : 1 to 5.

Parameters:

• op_ia_elem (Reference) –

• op_ia_law (Reference) –

• i_index (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 deviation value (length) from guide curves allowed during 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 smoothinh during sweeping

operation.

TRUE or FALSE (FALSE if not specified).

Return type:

bool

property parameter: float

Note

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

o Property Parameter() As double

Returns or sets the parameter for conic sweep operation.

if the parameter is a law, the method returns FALSE see

HybridShapeLawDistProj

Return type:

float

property parameter_law: Reference

Note

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

o Property ParameterLaw() As Reference

Returns or sets the parameter law useful in conic sweep operation.

Return type:

Reference

property parameter_law_inversion: bool

Note

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

o Property ParameterLawInversion() As boolean

Returns or sets the parameter law inversion flag of conic sweep

operation.

TRUE if parameter law is inverted. Else it is FALSE. see

HybridShapeLawDistProj

Return type:

bool

property parameter_law_type: int

Note

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

o Property ParameterLawType() As long

Returns or sets the parameter law type in conic sweep operation.

Return type:

int

remove_guide(i_index: int) → None

Note

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

o Sub RemoveGuide(long iIndex)

Removes a guide curve given its index.

it removes also tangency element if specified.

param : iIndex Guide curve index : 1 to 5. If 0, all guides are removed.

Parameters:

i_index (int) –

Return type:

None

remove_parameter() → None

Note

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

o Sub RemoveParameter()

Removes conical sweep parameter, whether it is a single value or a law.

Return type:

None

remove_tangency(i_index: int) → None

Note

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

o Sub RemoveTangency(long iIndex)

removes tangency surface or curve and its angle given the guide curve

index.

param : iIndex Guide curve index : 1 to 5.

Parameters:

i_index (int) –

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 second guide curve.

Return type:

Reference

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 deviation value (length) from guide curves allowed during sweeping

operation in order to smooth it.

param : iLength Numerical 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 CATHybridShapeSweepConic#SetRelimiters Sets the elements

relimiting the spine (or the default spine).

param : ipIAElem1 First relimiting feature (plane or point)

param : ipIAElem2 Second relimiting feature (plane or point)

Parameters:

• ip_ia_elem1 (Reference) –

• ip_ia_elem2 (Reference) –

Return type:

None

set_parameter_law(i_param_start: float, i_param_end: float, i_law_type: int) → None

Note

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

o Sub SetParameterLaw(double iParamStart,

double iParamEnd,

long iLawType)

Sets the parameter law that will be used in conic sweep

operation.

param : iParamStart Parameter law start value.

param : iParamEnd Parameter law end value.

param : iLawType Parameter law type.

Parameters:

• i_param_start (float) –

• i_param_end (float) –

• i_law_type (int) –

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_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 angular threshold under which discontinuities.

note: moving frame,tangency net on reference surface will be smoothed when

sweeping.

param : iAngle Numerical value.

Parameters:

i_angle (float) –

Return type:

None

set_tangency(ip_ia_elem: Reference, i_angle_start: float, i_angle_end: float, ilaw_type: int, i_index: int) → None

Note

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

o Sub SetTangency(Reference ipIAElem,

double iAngleStart,

double iAngleEnd,

long ilawType,

long iIndex)

Sets tangency surface or curve and its angle given the guide curve

index.

param : ipIAElem Tangency surface or curve feature.

param : iAngleStart Start tangency angle from surface or curve reference.

param : iAngleEnd End tangency angle from surface or curve reference.

param : iAngleLawType Type of law used for tangency angle from surface or curve reference.

param : iIndex Guide curve index : 1 to 5.

Parameters:

• ip_ia_elem (Reference) –

• i_angle_start (float) –

• i_angle_end (float) –

• ilaw_type (int) –

• i_index (int) –

Return type:

None

set_tangency_angle_law_inversion(i_index: int, i_inversion: int) → None

Note

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

o Sub SetTangencyAngleLawInversion(long iIndex,

long iInversion)

Sets information whether tangency angle law has to be inverted or not for a

specified guide curve.

param : iIndex Guide curve index : 1 to 5

param : iInversion 1 for TRUE and 0 for FALSE.

Parameters:

• i_index (int) –

• i_inversion (int) –

Return type:

None

set_tangency_law(ip_ia_elem: Reference, ip_ia_law: Reference, i_index: int) → None

Note

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

o Sub SetTangencyLaw(Reference ipIAElem,

Reference ipIALaw,

long iIndex)

Sets tangency surface or curve and its angle given the guide curve

index.

param : ipIAElem Tangency surface or curve feature.

param : ipIALaw Start tangency angle from surface or curve reference.

param : iIndex Guide curve index : 1 to 5.

Parameters:

• ip_ia_elem (Reference) –

• ip_ia_law (Reference) –

• i_index (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 sweeping operation is smoothed or

not.

TRUE or FALSE (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 angular threshold under which discontinuities .

moving frame,tangency net on reference surface will be smoothed when

sweeping.

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 spine (optional) for sweep operation.

param : oElem Spine curve.

See also:

Reference

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 third guide curve.

Return type:

Reference