pycatia.hybrid_shape_interfaces.hybrid_shape_point_on_curve¶
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_point_on_curve.HybridShapePointOnCurve(com_object)¶
Note
CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
System.IUnknownSystem.IDispatchSystem.CATBaseUnknownSystem.CATBaseDispatchSystem.AnyObjectMecModInterfaces.HybridShapeCATGSMIDLItf.PointHybridShapePointOnCurveRepresents the hybrid shape point on a curve.Role: To access the data of the point object created on a curve. This dataincludes:The curve onto which the point is createdThe reference point from which the point is createdThe curvilinear distance from the reference pointThe ratio of distance with respect to the curve lengthThe distance stored value type, either distance or ratioThe curve orientationThe distance type, either geodesic or euclidean.The direction along which point is created with specifieddistance.Use the HybridShapeFactory to create a HybridShapePointOnCurveobject.- 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 onto which the point is or should becreated.Sub-element(s) supported (see Boundary object): TriDimFeatEdge orBiDimFeatEdge.Example:This example retrieves in oCurve the supporting curveforthe pointOnCurve hybrid shape point.Dim oCurve As CATIAReferenceSet oCurve = pointOnCurve.Curve
- Return type:
- property direction: HybridShapeDirection¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Direction() As HybridShapeDirectionReturns or sets the direction along which the point is or should becreated.ExampleThis example retrieves in Dir the direction for the PointOnCurve hybridshape feature.Dim Dir As CATIAHybridShapeDirectionSet Dir=pointOnCurve.Direction
- Return type:
- property distance_type: int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property DistanceType() As longReturns or sets the distance type.Legal values: 1 for geodesic, -1 for euclidean.Default is geodesic.Geodesic means that the distance is measured with a curvilinearabscissaEuclidean means that the point is created as the intersection betweenthe reference curve and a circle whose radius is the length definedabove.Example:This example retrieves in oDistanceType the distance computation typeusedfor the pointOnCurve hybrid shape object.Dim oDistanceType As longSet oDistanceType = pointOnCurve.DistanceType
- Return type:
int
- property offset: Length¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Offset() As Length (Read Only)Returns the distance to the reference point.This distance is a distance in a length unit, The distance can be null.Inthis case, the reference point is the curve end point defined using theOrientation parameter.Example:This example retrieves in oOffset the distance from the referencepointon the supporting curve for the pointOnCurve hybrid shapeobject.Dim oOffset As CATIALengthSet oOffset = pointOnCurve.Offset
- Return type:
- property on_curve_type: int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property OnCurveType() As longReturns or sets the OnCurve type for created point oncurve.Legal values: 0 = Distance on curve 1 = Distance along direction 2 = Ratio of Curve length
- Return type:
int
- property orientation: int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Orientation() As longReturns or sets the curve orientation.Legal values: -1 means that the distance (length or ratio) ismeasured:in the other orientation of the curve, when a reference point has beensetin the other orientation of the curve and from the other extremity,when no reference point has been set.Example:This example retrieves in oOrientation curve Orientation usefor the pointOnCurve hybrid shape feature.Dim oOrientation As longSet oOrientation = pointOnCurve.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 reference point.If the point does not lie on the curve, the point on the curve with thesmallest distance to this point is taken.The reference point may not exist. In this case, the extremity of the curveis taken as reference point.Sub-element(s) supported (see Boundary object): Vertex.Example:This example retrieves in oRefPoint the referencepointon the supporting curve for the pointOnCurve hybrid shapeobject.Dim oRefPoint As CATIAReferenceSet oRefPoint = pointOnCurve.Point
- Return type:
- property ratio: RealParam¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Ratio() As RealParam (Read Only)Returns the distance ratio to the reference point.This is a real parameter which corresponds to the ratio of the distancefrom the reference point with respect to the length of the supporting curve.The ratio can be null. In this case, the reference point is the curve end pointdefined using the Orientation parameter.Example:This example retrieves in oRatio the distance ratio from thereference pointon the supporting curve for the pointOnCurve hybrid shapeobject.Dim oRatio As CATIALengthSet oRatio = PointOnCurve.Ratio
- Return type:
- property type: int¶
Note
- CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)
- o Property Type() As long (Read Only)Returns the distance stored value type.Legal values:1 when the type of measure is the length-1 when the type of measure is the distance ratioExample:This example retrieves in oType the distance type computationfor the pointOnCurve hybrid shape object.Dim oType As longSet oType = pointOnCurve.Type
- Return type:
int