CATGSMUseItf Interface CATIGSMUsePointOnCurve
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIGSMUsePointOnCurve
Interface to point on a curve feature.
Role: Allows you to access data of the point feature created with
a curvilinear distance to an existing point or an extremity on a curve.
- See also:
-
Method Index
- o
GetDirection(CATIGSMUseDirection_var&)
- Gets the direction from the reference point.
- o
GetDistanceType(DistanceType&)
- Gets the distance type : geodesic or euclidean.
- o
GetLength(CATICkeParm_var&)
- Gets the distance.
- o
GetOnCurveType(int&)
- Gets the type for point created on curve.
- o
GetOrientation(CATGSMOrientation&)
- Gets the orientation.
- o
GetReferencePoint(CATIMmiMechanicalFeature_var&)
- Gets the reference point.
- o
GetSupport(CATIMmiMechanicalFeature_var&)
- Gets the curve.
- o
InvertOrientation()
- Inverts the orientation.
- o
SetDirection(CATIGSMUseDirection_var&)
- Sets the direction from the reference point.
- o
SetDistanceType(DistanceType)
- Sets the distance type : geodesic or euclidean.
- o
SetLength(CATICkeParm_var)
- Sets the distance.
- o
SetOnCurveType(int&)
- Sets the type for point created on curve.
- o
SetOrientation(CATGSMOrientation)
- Sets the orientation.
- o
SetReferencePoint(CATIMmiMechanicalFeature_var)
- Sets the reference point.
- o
SetSupport(CATIMmiMechanicalFeature_var)
- Sets the curve.
Enumerated Type Index
- o
DistanceType
- Different kinds of distance types.
Methods
o GetDirection
| public virtual GetDirection( | | oDirection) |
-
Gets the direction from the reference point.
- See also:
-
o GetDistanceType
| public virtual GetDistanceType( | | oType) |
-
Gets the distance type : geodesic or euclidean.
Default is Geodesic.
Geodesic means that the distance is measured with a curvilinear abscissa
Euclidean means that the point is created by intersection between the reference curve and a circle
(whose radius is the length defined above).
- Parameters:
-
- oType
- distance type enum {Geodesic, Euclidean}
o GetLength
| public virtual GetLength( | | oDistance) |
-
Gets the distance.
o GetOnCurveType
| public virtual GetOnCurveType( | | oOnCurveType) |
-
Gets the type for point created on curve.
o GetOrientation
| public virtual GetOrientation( | | oOrientation) |
-
Gets the orientation.
Orientation = TRUE means that 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.
- Parameters:
-
- oOrientation
- orientation
o GetReferencePoint
| public virtual GetReferencePoint( | | oRefPoint) |
-
Gets 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.
o GetSupport
| public virtual GetSupport( | | oSupport) |
-
Gets the curve.
- Parameters:
-
- oSupport
- reference curve
o InvertOrientation
| public virtual InvertOrientation( | ) |
-
Inverts the orientation.
o SetDirection
| public virtual SetDirection( | const | iDirection) |
-
Sets the direction from the reference point.
- See also:
-
o SetDistanceType
| public virtual SetDistanceType( | const | iType) |
-
Sets the distance type : geodesic or euclidean.
- Parameters:
-
- iType
- distance type: enum {Geodesic, Euclidean}
o SetLength
| public virtual SetLength( | const | iDistance) |
-
Sets the distance.
o SetOnCurveType
| public virtual SetOnCurveType( | const | iOnCurveType) |
-
Sets the type for point created on curve.
o SetOrientation
| public virtual SetOrientation( | const | iOrientation) |
-
Sets the orientation.
Orientation = TRUE means that 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.
- Parameters:
-
- iOrientation
- orientation
o SetReferencePoint
| public virtual SetReferencePoint( | const | iRefPoint) |
-
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.
o SetSupport
| public virtual SetSupport( | const | iSupport) |
-
Sets the curve.
- Parameters:
-
- iSupport
- reference curve
Enumerated Types
o DistanceType
-
enum DistanceType {
Geodesic,
Euclidean
}
Different kinds of distance types.
- Parameters:
-
- Geodesic
- geodesic computation
- Euclidean
- Geodesic euclidean computation
This object is included in the file: CATIGSMUsePointOnCurve.h
If needed, your Imakefile.mk should include the module: CATGSMUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.