All Frameworks Class Hierarchy This Framework Indexes Previous Next

GeometricObjects Interface CATPointOnEdgeCurve

GeometricObjects.CATPointOnCurve

CATPointOnEdgeCurve

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

interface CATPointOnEdgeCurve

Interface defining a point lying on a CATEdgeCurve.

Role: A CATPointOnEdgeCurve knows how to map its parameter into the parameter on each curve of the edge curve, even if these parameters have not been already specified.
A CATPointOnEdgeCurve is defined with an underlying CATEdgeCurve and a list of parameters on the CATCurves of the CATEdgeCurve. The parameters can be not specified for some curves. They remain implicit and are evaluated through the GetEquivalentPoint method of the CATEdgeCurve interface.
A CATPointOnEdgeCurve is created through the CreatePointOnEdgeCurve method of the CATGeoFactory interface and deleted with the Remove method.

Method Index

o GetParamOn(CATCurve*,CATCrvParam&): Retrieves the parameter of this CATPointOnEdgeCurve related to a given curve inside the CATEdgeCurve.
o GetSpec(CATLONG32,CATCurve*&,CATCrvParam&): Retrieves the specified parameter and its associated CATCurve of this CATPointOnEdgeCurve.
o GetSpecsCount(): Returns the number of specified parameters in this CATPointOnEdgeCurve.
o Set(CATLONG32,CATCurve*[],CATCrvParam[],CATEdgeCurve*): Replaces all the characteristics of this CATPointOnEdgeCurve.
o SetParamOn(CATCurve*,CATCrvParam&): Adds a parameter specification on a CATCurve of a CATEdgeCurve.

Methods

o GetParamOn

public virtual CATBoolean GetParamOn(	const CATCurve*	`iCurveInsideEdgeCurve`,
	CATCrvParam&	`ioParamOnCurve`)const = 0

Retrieves the parameter of this CATPointOnEdgeCurve related to a given curve inside the CATEdgeCurve.
If the parameter was not specified on this CATCurve, the method computes the equivalent parameter.

Parameters:

iCurveInsideEdgeCurve: A pointer to a curve of the CATEdgeCurve.
ioParamOnCurve: The corresponding parameter.

Returns:

The computation type of the parameter
Legal values: 1 if the parameter was already specified, 0 otherwise (use of CATCurve.GetEquivalentParam ).

o GetSpec

public virtual void GetSpec(	CATLONG32	`iSpecIndex`,
	const CATCurve*&	`ioSpecCurves`,
	CATCrvParam&	`ioSpecParams`)const = 0

Retrieves the specified parameter and its associated CATCurve of this CATPointOnEdgeCurve.

Parameters:

iSpecIndex: The index (beginning at 0) of a specified parameter on this CATPointOnEdgeCurve.
ioSpecCurves: A pointer to the corresponding curve.
ioSpecParam: The corresponding parameter.

o GetSpecsCount

public virtual CATLONG32 GetSpecsCount(

)const = 0

Returns the number of specified parameters in this CATPointOnEdgeCurve.

Returns:: The number of parameters.

o Set

public virtual void Set(	const CATLONG32	`iNbOfSpecs`,
	const CATCurve*[]	`iSpecCurves`,
	const CATCrvParam[]	`iSpecParams`,
	const CATEdgeCurve*	`iSupport`)= 0

Replaces all the characteristics of this CATPointOnEdgeCurve.

Parameters:

iNbOfSpecs: The number of parameters to specify.
iSpecCurves[]: The array of the pointers to curves of iSupport.
iSpecParams[]: The array of the corresponding parameters.
iSupport: The underlying CATEdgeCurve.

o SetParamOn

public virtual void SetParamOn(	const CATCurve*	`iCurveInsideEdgeCurve`,
	const CATCrvParam&	`iNewParam`)= 0

Adds a parameter specification on a CATCurve of a CATEdgeCurve.
This method replaces the parameter if it was already defined on this CATCurve.

Parameters:

iCurveInsideEdgeCurve: A pointer to a curve of the CATEdgeCurve.
iNewParam: The new parameter on iCurveInsideEdgeCurve.

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