pycatia.hybrid_shape_interfaces.hybrid_shape_line_pt_pt¶
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_line_pt_pt.HybridShapeLinePtPt(com_object)¶
Note
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectMecModInterfaces.HybridShapeCATGSMIDLItf.LineHybridShapeLinePtPtRepresents the hybrid shape line between two points featureobject.Role: To access the data of the line feature created between twopoints.Use the CATIAHybridShapeFactory to create a HybridShapeLinePtPtobject.See also:ReferenceSee also:LengthSee also:HybridShapeFactory- property begin_offset: Length¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property BeginOffset() As Length (Read Only)Returns the start length of the line.Start length : extension of the line, beginning at the starting pointExample:This example retrieves in oStart the beginning offset length for theLinePtPt hybrid shape feature.Dim oStart As CATIALengthSet oStart = LinePtPt.BeginOffset
- Return type:
- property end_offset: Length¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property EndOffset() As Length (Read Only)Returns the end length of the line.End length : extension of the line, beginning at the ending pointExample:This example retrieves in oEnd the starting length for the LinePtPthybrid shape feature.Dim oEnd As CATIALengthSet oEnd = LinePtPt.EndOffset
- Return type:
- get_length_type() int ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetLengthType() As longGets the length type Default is 0.Parameters:oTypeThe length type = 0 : length - the line is limited by its extremities =1 : infinite - the line is infinite = 2 : infinite start point - the line is infinite onthe side of the start point = 3 : infinite end point - the line is infinite on the side ofthe end point
- Return type:
int
- get_symmetrical_extension() bool ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Func GetSymmetricalExtension() As booleanGets whether the symmetrical extension of the line isactive.Parameters:oSymSymetry flag
- Return type:
bool
- property pt_extremity: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property PtExtremity() As ReferenceReturns or Sets the extremity point of the LinePtPt(SecondPoint).Sub-element(s) supported (see Boundary object): Vertex.Example:This example retrieves in oPtExtremity the ending point for theLinePtPt hybrid shape feature.Dim oPtExtremity As ReferenceSet oPtExtremity = LinePtPt.PtExtremity
- Return type:
- property pt_origin: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property PtOrigine() As ReferenceReturns or Sets the origin point of the LinePtPt(Firstpoint).Sub-element(s) supported (see Boundary object): Vertex.Example:This example retrieves in oPtOrigine the initial point for the LinePtPthybrid shape feature.Dim oPtOrigine As ReferenceSet oPtOrigine = LinePtPt.PtOrigine
- Return type:
- remove_support() None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub RemoveSupport()Removes the support surface.
- Return type:
None
- set_length_type(i_type: int) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetLengthType(long iType)Sets the length type Default is 0.Parameters:iTypeThe length type = 0 : length - the line is limited by its extremities =1 : infinite - the line is infinite = 2 : infinite start point - the line is infinite onthe side of the start point = 3 : infinite end point - the line is infinite on the sideof the end point
- Parameters:
i_type (int) –
- Return type:
None
- set_symmetrical_extension(i_sym: bool) None ¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))
- o Sub SetSymmetricalExtension(boolean iSym)Sets the symmetrical extension of the line (start = -end).Parameters:iSymSymetry flag
- Parameters:
i_sym (bool) –
- Return type:
None
- property support: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Support() As ReferenceReturns or Sets the supporting surface.Note: the support surface is not mandatory for LinePtPtSub-element(s) supported (see Boundary object): Face.Example:This example retrieves in oSurface the supporting surface (if it exist)for the LinePtPt hybrid shape feature.Dim oSurface As ReferenceSet oSurface = LinePtPt.Surface
- Return type: