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.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectMecModInterfaces.HybridShapeHybridShapeHelixRepresents the hybrid shape helix feature object.Role: Allows to access data of the Helix feature. This dataincludes:axisa starting pointa pitcha height2 angle valuesSee also:HybridShapeFactory- property axis: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Axis() As ReferenceReads / Changes the Helix axis.Parameters:AxisHelix axis.Sub-element(s) supported (seeBoundary object): CATIARectlinearTriDimFeatEdge orRectilinearBiDimFeatEdge.
- Return type:
- property clockwise_revolution: bool¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property ClockwiseRevolution() As booleanReads / Modifies the sense of revolutions .Parameters:ClockwiseFALSE means that revolutions are counter-clockwise. TRUE means thatrevolutions are clockwise.
- Return type:
bool
- property height: Length¶
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:oHeightHeight.
- Return type:
- property invert_axis: bool¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property InvertAxis() As booleanReads / Modifies the orientation .Parameters:InvertFALSE means that there is no invertion (natural orientation). TRUEto invert this orientation.
- Return type:
bool
- property pitch: Length¶
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:oPitchPitch.
- Return type:
- property pitch2: Length¶
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:Pitch2Pitch2 for Helix.
- Return type:
- property pitch_law_type: int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property PitchLawType() As longReads / Changes the Helix pitch law type.Parameters:LawTypeLawType for Helix.
- Return type:
int
- property profile: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Profile() As ReferenceReads / Changes the Helix profile.Parameters:ProfileProfile for Helix.
- Return type:
- property revol_number: RealParam¶
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:oNbRevolRevolutions.
- Return type:
- 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:iHeightHeight.
- Parameters:
i_height (float) –
- 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:iPitchPitch.
- Parameters:
i_pitch (float) –
- 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:Pitch2Pitch2 for Helix.
- Parameters:
i_pitch2 (float) –
- 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:NbRevolNumber of revolutions for Helix.
- Parameters:
i_nb_revol (float) –
- 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:oTaperAngleStarting angle.
- Parameters:
i_starting_angle (float) –
- 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:iTaperAngleTaper angle.
- Parameters:
i_taper_angle (float) –
- Return type:
None
- property starting_angle: 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:oStartingAngleStarting angle.
- Return type:
- property starting_point: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property StartingPoint() As ReferenceReads / Changes the starting point of the Helix. The starting point mustnot be on the Helix axis.Parameters:StartingPointStarting point.Sub-element(s) supported (seeBoundary object): Vertex.
- Return type:
- property taper_angle: 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:oTaperAngleTaper angle.
- Return type:
- property taper_outward: bool¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property TaperOutward() As booleanReads / Modifies the taper angle sense of variation.Parameters:TaperOutwardFALSE means that helix radius decreases. TRUE means that helixradius increases.
- Return type:
bool