All Frameworks Class Hierarchy This Framework Indexes

GMOperatorsInterfaces Global Function CATCGMCreateTopPointOnWire

CATCGMCreateTopPointOnWire(		`iFactory`,
		`iTopData`,
		`iWire`,
	const	`iLength`,
		`iRefPoint`,
	const	`iLengthMode`	`= CatTopPointLValue`)

Creates a topological point body on a wire at a given distance from another point on the wire.
This basic mode corresponds to the settings SetSupport, SetLength, SetRefPoint, SetLengthMode of the advanced mode.

Parameters:

iFactory: The factory that creates the resulting body.
iTopData: The pointer to the data defining the software configuration and the journal. If the journal inside iTopData is NULL, it is not filled.
iWire: A pointer to the body on which the point is created.
iLength: The distance on the wire between the reference point and the point to create. In both distance modes, iLength can be positive or negative, and may lead to build a point outside the wire bounds. In such a case, the distance will be evaluated on the tangent to the wire at the reference point.
iRefPoint: The pointer to the point body from which the distance on the wire is computed. The point body must be a vertex of iWire
iLengthMode: The type of length computation.

Returns:

The pointer to the created point body. To remove with the method.

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