All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMOperatorsInterfaces Interface CATICGMTopClashOperator

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

interface CATICGMTopClashOperator

Class representing the operator that tests the clash between two bodies, and eventually computes their intersection.

To use the CATICGMTopClashOperator:

Create it the CATCGMCreateTopClashOperator global function.
If you want only the diagnostic(TRUE or FALSE), avoiding computation of the intersection body, use SetOnlyDiagnosticRequired(TRUE) method.
Run the operator
Retrieve the diagnostic with the GetDiagnostic method.
Retrieve the eventual intersection body with the GetResult method.
Release with the usual C++ Release method after use.

Method Index

o GetDiagnostic(): Returns the clash diagnosis.
o GetResult(): Returns the body resulting from the clash operation.
o SetOnlyDiagnosticRequired(CATBoolean): Specifies whether only the clash diagnosis is to be issued.
o SetTestVolumeInclusion(CATBoolean): For the case where only the diagnostic is required.

Methods

o GetDiagnostic

public virtual GetDiagnostic(

)

Returns the clash diagnosis.

Returns:: TRUE if the two bodies clash.

o GetResult

public virtual GetResult(

)

Returns the body resulting from the clash operation. This body can be of any dimension.

Returns:: The created body.

o SetOnlyDiagnosticRequired

public virtual SetOnlyDiagnosticRequired( iOnlyDiagnostic)

Specifies whether only the clash diagnosis is to be issued. By default, the complete intersection body is computed.

Parameters:

iOnlyDiagnostic: If TRUE, only the diagnosis is computed. The algorithm interrupts as soon as an intersection between the two bodies is detected. NO RESULT is generated (the resulting body is NULL). By default the clash result, if any, is generated.

o SetTestVolumeInclusion

public virtual SetTestVolumeInclusion( iTestVolumeInclusion)

For the case where only the diagnostic is required. It specifies if the inclusion of a domain of one body inside a volume of the other should be tested. By default, the test is done.

Parameters:

iTestVolmeInclusion: If TRUE, the operator will test the inclusion of a domain of one body inside a volume of the other. If FALSE, and a domain of one body is inside a volume of the other, without touching the faces, GetDiagnostic will return FALSE. By default the test of inclusion is done.

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