pycatia.hybrid_shape_interfaces.hybrid_shape_line_tangency¶
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_tangency.HybridShapeLineTangency(com_object)¶
Note
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectMecModInterfaces.HybridShapeCATGSMIDLItf.LineHybridShapeLineTangencyLine tangent to a curve.Role: To access data of the line feature created to be tangent to a curve at agiven point.Use the CATIAHybridShapeFactory to create a HybridShapeLineTangencyobject.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 theLineTangency hybrid shape feature.Dim oStart As CATIALengthSet oStart = LineTangency.BeginOffset
- Return type:
- property curve: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Curve() As ReferenceReturns or Sets the curve to which the line will betangent.Sub-element(s) supported (see Boundary object): TriDimFeatEdge orBiDimFeatEdge.Example:This example retrieves in oCurve the reference curve for theLineTangency hybrid shape feature.Dim oCurve As ReferenceSet oCurve = LineTangency.Curve
- 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 LineTangencyhybrid shape feature.Dim oEnd As CATIALengthSet oEnd = LineTangency.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 on the side of thestart point = 3 : infinite end point - the line is infinite on the side of the 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 orientation: int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Orientation() As longReturns or Sets the line orientation.Orientation allows to reverse the line direction from the referencepoint.For a line of L length, it is the same as creating this line with -L length :Orientation : can be 1 or -1Example:This example retrieves in oOrientation the starting length for theLineTangency hybrid shape feature.Dim oOrientation As longSet oOrientation = LineTangency.Orientation
- Return type:
int
- property point: Reference¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Point() As ReferenceReturns or Sets the starting point of the line.Sub-element(s) supported (see Boundary object): Vertex.Example:This example retrieves in oPoint the starting point for theLineTangency hybrid shape feature.Dim oPoint As ReferenceSet oPoint = LineTangency.Point
- 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 support surface.Note: Support surface is not mandatorySub-element(s) supported (see Boundary object): Face.Example:This example retrieves in oSurface the suupporting Surface (if exist)for the LineTangency hybrid shape feature.Dim oSurface As ReferenceSet oSurface = LineTangency.Surface
- Return type: