pycatia.hybrid_shape_interfaces.hybrid_shape_spiral

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_spiral.HybridShapeSpiral(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
HybridShapeSpiral

Represents the hybrid shape Spiral feature object.
Role: Allows to access data of the Spiral feature. This data
includes:

type
support
centre point
axis
starting radius
orientation
ending angle
ending radius
revolution
pitch

See also:
HybridShapeFactory
property axis: HybridShapeDirection

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Axis() As HybridShapeDirection

Reads / Changes the Spiral axis (Reference direction).
Return type:

HybridShapeDirection

property center_point: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property CenterPoint() As Reference

Reads / Changes the center point of the Spiral.
Return type:

Reference

property clockwise_revolution: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property ClockwiseRevolution() As boolean

Reads / Modifies the sense of revolutions .
FALSE means that revolutions are counter-clockwise.
TRUE means that revolutions are clockwise.
Return type:

bool

property ending_angle: Angle

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property EndingAngle() As Angle

Reads / Changes the Ending Angle of the Spiral.
Return type:

Angle

property ending_radius: Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property EndingRadius() As Length

Reads / Changes the ending radius of the Spiral.
Return type:

Length

property invert_axis: bool

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property InvertAxis() As boolean

Reads / Modifies the orientation .
FALSE means that there is no invertion (natural
orientation).
TRUE to 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

Reads / Changes the pitch of the Spiral.
Return type:

Length

property revol_number: RealParam

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property RevolNumber() As RealParam

Reads / Changes the revolution number of the Spiral.
Return type:

RealParam

set_angle_pitch_param(i_end_angle: float, i_revol_number: float, i_pitch: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetAnglePitchParam(double iEndAngle,
double iRevolNumber,
double iPitch)

Sets Angle pitch parameter.
Parameters:

  • i_end_angle (float) –

  • i_revol_number (float) –

  • i_pitch (float) –

Return type:

None

set_angle_radius_param(i_end_angle: float, i_revol_number: float, i_end_radius: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetAngleRadiusParam(double iEndAngle,
double iRevolNumber,
double iEndRadius)

Sets Angle radius parameters.
Parameters:

  • i_end_angle (float) –

  • i_revol_number (float) –

  • i_end_radius (float) –

Return type:

None

set_radius_pitch_param(i_end_radius: float, i_pitch: float) → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
o Sub SetRadiusPitchParam(double iEndRadius,
double iPitch)

Sets Radius pitch parameter.
Parameters:

  • i_end_radius (float) –

  • i_pitch (float) –

Return type:

None

property starting_radius: Length

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property StartingRadius() As Length

Reads / Changes the starting radius of the Spiral.
Return type:

Length

property support: Reference

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Support() As Reference

Reads / Changes the spiral plane support.
Return type:

Reference

property type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
o Property Type() As long

Reads / Changes the spiral type.
Return type:

int