GMModelInterfaces Interface CATICGMTopEdgePropagation

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

interface CATICGMTopEdgePropagation

Class representing the topological operator which performs an edge propagation on a body.

Create it with the CATCGMCreateTopEdgePropagation global function.
Tune it with appropriate options, using the Setxxx methods.
Run it ( only one time ).
Get the resulting body with the GetResult method. This body is made of a single wire which is the result of the propagation. If you do not want to keep this resulting body, use the method to remove it from the geometric factory, after the operator deletion.
Optionally get the two propagation diagnoses with the GetDiagnoses method.
Release the operator with the Release method.

Method Index

o GetDiagnoses(CATTopEdgePropagationDiagnosis[2],double*): Gets the propagation diagnoses at each extremity of the output wire.
o SetBoundaryMode(CATBoolean): Defines the boundary propagation mode on shell.
o SetContinuityMode(CATResolutionType): Defines the continuity propagation mode.
o SetReferenceFace(CATFace*,CATOrientation): Defines the face to be used as a reference for the orientation of the resulting wire.
o SetTolerance(CATResolutionType,double&): Defines the tolerance propagation value for a continuity level.

Methods

o GetDiagnoses

public virtual GetDiagnoses(		`oDiagnoses`,
		`oDiagnosesValue`	`= NULL`)

Gets the propagation diagnoses at each extremity of the output wire.

Parameters:

oDiagnoses

This array is filled with two diagnoses corresponding to the start and end of the output wire.

oDiagnosesValue

If not NULL , this array must be allocated for two values.
It is then filled with the two values corresponding to the limit reached at the start and end of the output wire.
In case of:

POINT_DISCONTINUITY: The value is the lowest point discontinuity found.
ANGULAR_DISCONTINUITY: The value is the lowest angular discontinuity found.
CURVATURE_DISCONTINUITY: The value is the lowest curvature discontinuity found.
for other value: It is filled with 0 ( meaning less ).

o SetBoundaryMode

public virtual SetBoundaryMode( const iIsBoundaryModeActive)

Defines the boundary propagation mode on shell.
by default this mode is off.

Parameters:

iIsBoundaryModeActive: Specifies whether the propagation is restricted to the boundary of the shell.
Legal values: TRUE or, FALSE.
In case this mode is on, the initial edge has to belong to the boundary of the shell.
This service is meaningless if the input body contains wires.

o SetContinuityMode

public virtual SetContinuityMode( const iContinuity)

Defines the continuity propagation mode.

Parameters:

iContinuity

Legal values:

CatC0: Point continuity.
CatC1: Point and tangency continuity.
CatC2: Point, tangency and curvature continuity.

In case of point continuity and when boundary mode is off, propagation occurs only around the reference face.
The continuity evaluation does not take into account the junction edge (continuity is evaluated on their neighbor).

o SetReferenceFace

public virtual SetReferenceFace(		`iReferenceFace`,
		`iReferenceOrientation`	`= CATOrientationPositive`)

Defines the face to be used as a reference for the orientation of the resulting wire.
This face must be bounded by the initial edge.

Parameters:

iReferenceFace

The reference face for the wire orientation.

In case the initial edge is a shell internal edge, this service is mandatory for the result orientation.
In case the initial edge is at the boundary of a single shell, this single shell is used as a reference face and this service is useless.
In case the initial edge is at the boundary of several shells (non manifold situation), this service is mandatory to define the result orientation and specify the shell on which the propagation is carried out.

This service is meaningless if the input body contains wires.

iReferenceOrientation

If CATOrientationPositive , the reference orientation is the orientation of the reference face in the shell.
If CATOrientationNegative , the reference orientation is the inverse of the orientation of the reference face in the shell.

o SetTolerance

public virtual SetTolerance(	const	`iContinuity`,
	const	`iTolerance`)

Defines the tolerance propagation value for a continuity level.

Parameters:

iContinuity

Defines the continuity level.

CatC0: Point tolerance in model unit.
Value is restricted to interval [ 0.001 , 0.1 ] with 0.001 as default.
CatC1: Tangency tolerance in radians.
Value is restricted to interval [ 0.00872665 radian , 0.0872665 ] with 0.00872665 as default.
Equivalent value in degree are [ 0.5 degree , 5. degree ].
CatC2: Curvature tolerance with no dimension.
Value is stricly positive , restricted to interval ] 0 , 1 ] with 0.98 as default..
Curvature value "c" is defined by : | R2 - R1 | / max ( |R1| , |R2| ) < ( 1 - c ) / c. ( where R1 and R2 are the curvatures on both side ).

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