All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMModelInterfaces Interface CATICGMIntersectionCrvCrv

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

interface CATICGMIntersectionCrvCrv

Class defining the operator of the intersection of two curves.

The operator outputs the isolated solutions (points) and the overlapping solutions (curves).

The CATICGMIntersectionCrvCrv operator is created with the CATCGMCreateIntersection method and directly released with the Release method. It is is not streamable.
In case of BASIC mode, the operation is automatically performed at the operator creation. In case of ADVANCED mode, options can be precised with the SetXxx methods, before asking for the computation with the Run method. The advanced mode also allows you to run the same operator with different curves.
In both cases, the result is accessed with two specific interators, one for the solution points, the other for the solution curves.

Method Index

o BeginningCurve(): Initializes the iterator of the solution curves.
o BeginningPoint(): Initializes the iterator of the resulting points.
o GetCartesianPoint(): Creates the next solution point of this CATICGMIntersectionCrvCrv operator.
o GetCurveLimits(CATCurve*,CATCrvLimits&): Returns the domain of the next solution curve of this CATICGMIntersectionCrvCrv operator.
o GetCurveParam(CATCurve*,CATCrvParam&,CATLONG32): Retrieves the parameter of the next solution point of this CATICGMIntersectionCrvCrv operator.
o GetEdgeCurve(CATPointOnEdgeCurve*&,CATPointOnEdgeCurve*&): Creates the next solution curve of this CATICGMIntersectionCrvCrv operator as an edge curve.
o GetNumberOfCurves(): Returns the number of solution curves of this CATICGMIntersectionCrvCrv operator.
o GetNumberOfPoints(): Returns the number of isolated resulting points of this CATICGMIntersectionCrvCrv operator.
o GetPointOnCurve(CATCurve*,CATLONG32): Creates the next solution point on curve of this CATICGMIntersectionCrvCrv operator.
o NextCurve(): Skips to the next solution curve of this CATICGMIntersectionCrvCrv operator.
o NextPoint(): Skips to the next solution point of this CATICGMIntersectionCrvCrv operator.
o SetCurve(CATCurve*): Defines the intersection with another second curve (ADVANCED mode).
o UseLimits(CATCrvLimits*,CATCrvLimits*): Modifies the curve domain to take into account for this CATICGMIntersectionCrvCrv operator (ADVANCED mode).

Methods

o BeginningCurve

public virtual BeginningCurve(

)

Initializes the iterator of the solution curves.
By default, the initialization is performed once the operator runs, and this is therefore only used to read the solutions again.

o BeginningPoint

public virtual BeginningPoint(

)

Initializes the iterator of the resulting points.
By default, the initialization is performed once the operator runs, and this is therefore only used to read the solutions again.

o GetCartesianPoint

public virtual GetCartesianPoint(

)

Creates the next solution point of this CATICGMIntersectionCrvCrv operator.

Returns:: The pointer to the created point. A new point is created each time this method is called. If you do not want to keep the created point, use the method.

o GetCurveLimits

public virtual GetCurveLimits(		`iCurve`,
		`ioLimits`)

Returns the domain of the next solution curve of this CATICGMIntersectionCrvCrv operator.

Parameters:

iCurve: The first or the second operand of the operator, on which the domain is output.
ioLimits: The domain of the solution curve.

o GetCurveParam

public virtual GetCurveParam(		`iCurve`,
		`ioCrvParam`,
	const	`iIndex`	`= 0`)

Retrieves the parameter of the next solution point of this CATICGMIntersectionCrvCrv operator.

Parameters:

iCurve: The pointer to the first or second curve which are intersected.
ioCrvParam: The parameter.
iIndex: Internal use.

o GetEdgeCurve

public virtual GetEdgeCurve(		`oStart`,
		`oEnd`)

Creates the next solution curve of this CATICGMIntersectionCrvCrv operator as an edge curve.
The edge curve is composed of parts of each inital curve.

Parameters:

oStart: The pointer to the created point representing the first extremity of the solution curve. A new point is created each time this method is called. If you do not want to keep the created point, use the
oEnd: The pointer to the created point representing the last extremity of the solution curve. A new point is created each time this method is called. If you do not want to keep the created point, use the
Returns:: The pointer to the created edge curve, NULL if it cannot be created. A new curve is created each time this method is called. If you do not want to keep the created curve, use the method. and the POEC extremities oStart and oEnd on this edgecurve.

o GetNumberOfCurves

public virtual GetNumberOfCurves(

)

Returns the number of solution curves of this CATICGMIntersectionCrvCrv operator.

Returns:: The number of resulting curves.

o GetNumberOfPoints

public virtual GetNumberOfPoints(

)

Returns the number of isolated resulting points of this CATICGMIntersectionCrvCrv operator.

Returns:: The number of isolated points.

o GetPointOnCurve

public virtual GetPointOnCurve(		`iCurve`,
	const	`iIndex`	`= 0`)

Creates the next solution point on curve of this CATICGMIntersectionCrvCrv operator.

Parameters:

iCurve: The pointer to the first or second curve which are intersected.
iIndex: Internal use.

Returns:

The pointer to the created point on curve. A new point is created each time this method is called. If you do not want to keep the created point, use the method.

o NextCurve

public virtual NextCurve(

)

Skips to the next solution curve of this CATICGMIntersectionCrvCrv operator.
After BeginningCurve, it skips to the first curve.

Returns:

The existence of the next solution.
Legal values:

TRUE: if there is a solution curve
FALSE: no more solution curve.

o NextPoint

public virtual NextPoint(

)

Skips to the next solution point of this CATICGMIntersectionCrvCrv operator.
After BeginningPoint, it skips to the first point.

Returns:

The existence of the next solution.
Legal values:

TRUE: if there is a solution point
FALSE: no more solution point.

o SetCurve

public virtual SetCurve( iNewSecondCurve)

Defines the intersection with another second curve (ADVANCED mode).

Parameters:

iNewSecondCurve: The pointer to the new second curve.

o UseLimits

public virtual UseLimits(		`iLimitsForCurve1`,
		`iLimitsForCurve2`)

Modifies the curve domain to take into account for this CATICGMIntersectionCrvCrv operator (ADVANCED mode).
It does not change the current curve limitations.

Parameters:

iLimitsForCurve1: The pointer to the new domain of the first curve. If NULL, the current limitation of the first curve is used.
iLimitsForCurve2: The pointer to the new domain of the second curve. If NULL, the current limitation of the second curve is used.

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