All Frameworks  Object Hierarchy  This Framework  Indexes   

HybridShapePointOnCurve (Object)

Represents the hybrid shape point on a curve.
Role: To access the data of the point object created on a curve. This data includes:

Use the HybridShapeFactory to create a HybridShapePointOnCurve object.


Property Index

Curve
Returns or sets the curve onto which the point is or should be created.
Direction
Returns or sets the direction along which the point is or should be created.
DistanceType
Returns or sets the distance type.
Offset
Returns the distance to the reference point.
OnCurveType
Returns or sets the OnCurve type for created point on curve.
Orientation
Returns or sets the curve orientation.
Point
Returns or sets the reference point.
Ratio
Returns the distance ratio to the reference point.
Type
Returns the distance stored value type.

Properties


o Property Curve() As
Returns or sets the curve onto which the point is or should be created.
Sub-element(s) supported (see
Boundary object): TriDimFeatEdge or BiDimFeatEdge.
Example:
This example retrieves in oCurve the supporting curve for the pointOnCurve hybrid shape point.
 Dim oCurve As CATIAReference
 Set oCurve = pointOnCurve.Curve
 
o Property Direction() As
Returns or sets the direction along which the point is or should be created.
Example
This example retrieves in Dir the direction for the PointOnCurve hybrid shape feature.
 Dim Dir As CATIAHybridShapeDirection
 Set Dir=pointOnCurve.Direction
o Property DistanceType() As
Returns 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 curvilinear abscissa
  • Euclidean means that the point is created as the intersection between the reference curve and a circle whose radius is the length defined above.
Example:
This example retrieves in oDistanceType the distance computation type used for the pointOnCurve hybrid shape object.
 Dim oDistanceType As  long
 Set oDistanceType = pointOnCurve.DistanceType
 
o Property Offset() As (Read Only)
Returns the distance to the reference point.
This distance is a distance in a length unit, The distance can be null.In this case, the reference point is the curve end point defined using the Orientation parameter.
Example:
This example retrieves in oOffset the distance from the reference point on the supporting curve for the pointOnCurve hybrid shape object.
 Dim oOffset As  CATIALength  
 Set oOffset = pointOnCurve.Offset
 
o Property OnCurveType() As
Returns or sets the OnCurve type for created point on curve.
Legal values: 0 = Distance on curve 1 = Distance along direction 2 = Ratio of Curve length
o Property Orientation() As
Returns or sets the curve orientation.
Legal values: -1 means that the distance (length or ratio) is measured:
  • in the other orientation of the curve, when a reference point has been set
  • in 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 use for the pointOnCurve hybrid shape feature.
 Dim oOrientation As  long
 Set oOrientation = pointOnCurve.Orientation
 
o Property Point() As
Returns or sets the reference point.

If the point does not lie on the curve, the point on the curve with the smallest distance to this point is taken.

The reference point may not exist. In this case, the extremity of the curve is taken as reference point.



Sub-element(s) supported (see
Boundary object): Vertex.
Example:
This example retrieves in oRefPoint the reference point on the supporting curve for the pointOnCurve hybrid shape object.
 Dim oRefPoint As  CATIAReference
 Set oRefPoint = pointOnCurve.Point
 
o Property Ratio() As (Read Only)
Returns the distance ratio to the reference point.
This is a real parameter which corresponds to the ratio of the distance from 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 point defined using the Orientation parameter.
Example:
This example retrieves in oRatio the distance ratio from the reference point on the supporting curve for the pointOnCurve hybrid shape object.
 Dim oRatio As  CATIALength  
 Set oRatio = PointOnCurve.Ratio
 
o Property Type() As (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 ratio
Example:
This example retrieves in oType the distance type computation for the pointOnCurve hybrid shape object.
 Dim oType As long
 Set oType = pointOnCurve.Type
 

Copyright © 2003, Dassault Systèmes. All rights reserved.