All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMModelInterfaces Interface CATICGMDistanceTool

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

interface CATICGMDistanceTool

Class defining the type of parallel computation and is to be used when you want to create a parallel curve onto a support.
This class does not create directly a curve onto a support. To do this, you must:

Specify the parameters of the offset distance by using CATICGMDistanceTool:
- the parallelism mode: euclidian or geodesic
- the side on which the wire is offset, it is computed from the support normal and the wire tangent: Side = Normal^Tangent
- the law which defines the distance evolution along the wire.
Specify the type of relimitation: sharp or round and the support on which the wire is offset. This is done by creating the CATICGMExtrapolParallelTool object.
Create and run the CATICGMTopParallel operator.

The CATICGMDistanceTool class is created by :

either that computes the parallel with an euclidian distance
or that computes the parallel with a geodesic distance.

This class is the base class for some supplied classes, but you must not derive it yourself.

Method Index

o GetCompositeLaw(): Returns the law used to compute the distance.
o GetSide(): Returns the side on which the parallel is computed.
o GetType(): Returns the type of parallelism.

Methods

o GetCompositeLaw

public virtual GetCompositeLaw(

)

Returns the law used to compute the distance.
Note that this operator converts the law provided to CATCGMCreateTopEuclidianDistanceTool and CATCGMCreateTopGeodesicDistanceTool into a CATCompositeLaw (if it is not already one).

Returns:: The pointer to the law.

o GetSide

public virtual GetSide(

)

Returns the side on which the parallel is computed.

Returns:

The side value defined when standing along the face direction and watching in the wire direction.

1 for the left side
-1 for the right side.

o GetType

public virtual GetType(

)

Returns the type of parallelism.

Returns:

1 = GeodesicDistanceToolType_Euclidian
or 2 = GeodesicDistanceToolType_Geodesic.

This object is included in the file: CATICGMDistanceTool.h
If needed, your Imakefile.mk should include the module: CATGMModelInterfaces