All Frameworks Class Hierarchy This Framework Indexes

GMOperatorsInterfaces Global Function CATCGMCreateTopHelixOperator

CATCGMCreateTopHelixOperator(		`iFactory`,
		`iTopData`,
		`iHelixAxis`,
		`iHelixAxisOrientation`,
		`iHelixOrigin`,
		`iStartAngle`,
		`iEndAngle`,
		`iPitch`,
		`iTrigoOrientation`)

Creates a topological operator that builds a helix body.

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.
iHelixAxis: The body containing a wire with a single linear edge.
iHelixAxisOrientation: The orientation of the helix with regards to the axis: iHelixAxisOrientation=1 if the helix and iHelixAxis have the same orientation, -1 otherwise.
iHelixOrigin: The pointer to the vertex body, origin of the helix.
iStartAngle: The first limitation of the helix from the origin point.
iEndAngle: The last limitation of the helix from the origin point. origin point.
iPitch: The heigth between two turns.
iTrigoOrientation: The orientation of the rotation about the axis oriented by iHelixAxisOrientation: 1 to turn counterclockwise, <-1> to turn clockwise.

Returns:

[out, IUnknown#Release] The pointer to the created operator. To be released with the Release method after use.

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