pycatia.hybrid_shape_interfaces.hybrid_shape_helix

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_helix.HybridShapeHelix(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

HybridShapeHelix

Represents the hybrid shape helix feature object.

Role: Allows to access data of the Helix feature. This data

includes:

axis

a starting point

a pitch

a height

2 angle values

See also:

HybridShapeFactory

property axis

Note

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

o Property Axis() As Reference

Reads / Changes the Helix axis.

Parameters:

Axis

Helix axis.

Sub-element(s) supported (see

Boundary object): CATIARectlinearTriDimFeatEdge or

RectilinearBiDimFeatEdge.

Returns

Reference

Return type

Reference

property clockwise_revolution

Note

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

o Property ClockwiseRevolution() As boolean

Reads / Modifies the sense of revolutions .

Parameters:

Clockwise

FALSE means that revolutions are counter-clockwise. TRUE means that

revolutions are clockwise.

Returns

bool

Return type

bool

property height

Note

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

o Property Height() As Length (Read Only)

Reads the height of the Helix.

Parameters:

oHeight

Height.

Returns

Length

Return type

Length

property invert_axis

Note

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

o Property InvertAxis() As boolean

Reads / Modifies the orientation .

Parameters:

Invert

FALSE means that there is no invertion (natural orientation). TRUE

to invert this orientation.

Returns

bool

Return type

bool

property pitch

Note

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

o Property Pitch() As Length (Read Only)

Reads the pitch of the Helix.

Parameters:

oPitch

Pitch.

Returns

Length

Return type

Length

property pitch2

Note

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

o Property Pitch2() As Length (Read Only)

Reads the Helix pitch2.

Parameters:

Pitch2

Pitch2 for Helix.

Returns

Length

Return type

Length

property pitch_law_type

Note

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

o Property PitchLawType() As long

Reads / Changes the Helix pitch law type.

Parameters:

LawType

LawType for Helix.

Returns

int

Return type

int

property profile

Note

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

o Property Profile() As Reference

Reads / Changes the Helix profile.

Parameters:

Profile

Profile for Helix.

Returns

Reference

Return type

Reference

property revol_number

Note

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

o Property RevolNumber() As RealParam (Read Only)

Reads the revolution number of the Helix.

Parameters:

oNbRevol

Revolutions.

Returns

RealParam

Return type

RealParam

set_height(i_height: float) → None

Note

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

o Sub SetHeight(double iHeight)

Sets the helix height.

Parameters:

iHeight

Height.

Parameters

i_height (float) –

Returns

None

Return type

None

set_pitch(i_pitch: float) → None

Note

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

o Sub SetPitch(double iPitch)

Sets the helix pitch.

Parameters:

iPitch

Pitch.

Parameters

i_pitch (float) –

Returns

None

Return type

None

set_pitch2(i_pitch2: float) → None

Note

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

o Sub SetPitch2(double iPitch2)

Changes the Helix pitch2 .

Parameters:

Pitch2

Pitch2 for Helix.

Parameters

i_pitch2 (float) –

Returns

None

Return type

None

set_revolution_number(i_nb_revol: float) → None

Note

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

o Sub SetRevolutionNumber(double iNbRevol)

Changes the Revolution Numbers.

Parameters:

NbRevol

Number of revolutions for Helix.

Parameters

i_nb_revol (float) –

Returns

None

Return type

None

set_starting_angle(i_starting_angle: float) → None

Note

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

o Sub SetStartingAngle(double iStartingAngle)

Sets the helix starting angle.

Parameters:

oTaperAngle

Starting angle.

Parameters

i_starting_angle (float) –

Returns

None

Return type

None

set_taper_angle(i_taper_angle: float) → None

Note

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

o Sub SetTaperAngle(double iTaperAngle)

Sets the helix taper angle.

Parameters:

iTaperAngle

Taper angle.

Parameters

i_taper_angle (float) –

Returns

None

Return type

None

property starting_angle

Note

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

o Property StartingAngle() As Angle (Read Only)

Reads the helix starting angle.

Parameters:

oStartingAngle

Starting angle.

Returns

Angle

Return type

Angle

property starting_point

Note

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

o Property StartingPoint() As Reference

Reads / Changes the starting point of the Helix. The starting point must

not be on the Helix axis.

Parameters:

StartingPoint

Starting point.

Sub-element(s) supported (see

Boundary object): Vertex.

Returns

Reference

Return type

Reference

property taper_angle

Note

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

o Property TaperAngle() As Angle (Read Only)

Reads the helix taper angle.

Parameters:

oTaperAngle

Taper angle.

Returns

Angle

Return type

Angle

property taper_outward

Note

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

o Property TaperOutward() As boolean

Reads / Modifies the taper angle sense of variation.

Parameters:

TaperOutward

FALSE means that helix radius decreases. TRUE means that helix

radius increases.

Returns

bool

Return type

bool