All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

GSMInterfaces Interface CATIGSMPointOnCurve

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIGSMPointOnCurve
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIGSMPointOnCurve

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:
CATIGSMFactory.CreatePoint


Method Index


o GetDistanceType(DistanceType&)
Gets the distance type : geodesic or euclidean.
o GetLength(CATICkeParm_var&)
Gets the distance.
o GetOrientation(CATGSMOrientation&)
Gets the orientation.
o GetReferencePoint(CATISpecObject_var&)
Gets the reference point.
o GetSupport(CATISpecObject_var&)
Gets the curve.
o InvertOrientation()
Inverts the orientation.
o SetDistanceType(DistanceType)
Sets the distance type : geodesic or euclidean.
o SetLength(CATICkeParm_var)
Sets the distance.
o SetOrientation(CATGSMOrientation)
Sets the orientation.
o SetReferencePoint(CATISpecObject_var)
Sets the reference point.
o SetSupport(CATISpecObject_var)
Sets the curve.

Enumerated Type Index


o DistanceType
Different kinds of distance types.

Methods


o GetDistanceType
public virtual HRESULT GetDistanceType(DistanceType& oType) = 0
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 HRESULT GetLength(CATICkeParm_var& oDistance) = 0
Gets the distance.
o GetOrientation
public virtual HRESULT GetOrientation(CATGSMOrientation& oOrientation) = 0
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 HRESULT GetReferencePoint(CATISpecObject_var& oRefPoint) = 0
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 HRESULT GetSupport(CATISpecObject_var& oSupport) = 0
Gets the curve.
Parameters:
oSupport
reference curve
o InvertOrientation
public virtual HRESULT InvertOrientation()= 0
Inverts the orientation.
o SetDistanceType
public virtual HRESULT SetDistanceType( const DistanceType iType) = 0
Sets the distance type : geodesic or euclidean.
Parameters:
iType
distance type: enum {Geodesic, Euclidean}
o SetLength
public virtual HRESULT SetLength( const CATICkeParm_var iDistance) = 0
Sets the distance.
o SetOrientation
public virtual HRESULT SetOrientation( const CATGSMOrientation iOrientation) = 0
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 HRESULT SetReferencePoint( const CATISpecObject_var iRefPoint) = 0
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 HRESULT SetSupport( const CATISpecObject_var iSupport) = 0
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: CATIGSMPointOnCurve.h
If needed, your Imakefile.mk should include the module: CATGitInterfaces

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