All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMOperatorsInterfaces Interface CATICGMHLROperator

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

interface CATICGMHLROperator

Class defining an operator that computes the edge visibility information of a model for the specified views.
A view is specified in terms of a CATMathPlane which defines the view direction and the projection support. It is possible to define multiple views and then run the operator once.

A CATICGMHLROperator operator is created with the CATCGMCreateHLROperator global functions.
It is the user's responsibility to release the operator after it has been used.

Method Index

o AddBody(CATBody*): Adds a CATBody to the input HLR scene.
o AddBodyInstance(CATBody*,CATMathTransformation const&): Adds an instance of a CATBody to the input HLR scene.
o EnableClashComputationMode(): Activates the computation of clashes between different bodies of the scene.
o GetResult(): Returns the current result of the HLR computation.
o SetProjectionPlane(CATMathPlane const&): Defines a mathematical plane for a new view to be used in the next computation.

Methods

o AddBody

public virtual AddBody( iBody)

Adds a CATBody to the input HLR scene. This body can be contained by another factory than the input one, but its scale has to be smaller or equal to the scale of the input factory.

Parameters:

iBody: The pointer to the CATBody to add to the scene.
iTransformation: The pointer to the CATMathTransformation to apply to the input body.

Returns:

The unique integer value as the "Identifier" of the current instance.

o AddBodyInstance

public virtual AddBodyInstance(		`iBody`,
		`iTransformation`)

Adds an instance of a CATBody to the input HLR scene. This body can be contained by another factory than the input one, but its scale has to be smaller or equal to the scale of the input factory.

Parameters:

iBody: The pointer to the CATBody to add to the scene.
iTransformation: The CATMathTransformation to apply on the input body.

Returns:

The unique integer value as the "Identifier" of the current instance (CATBody is associated with a specific position matrix).

o EnableClashComputationMode

public virtual EnableClashComputationMode(

)

Activates the computation of clashes between different bodies of the scene. The caller has to take into account the cost of this treatment and activate this mode only if the scene is known to contain overlapping bodies. By default, the ClashComputationMode is disabled.

o GetResult

public virtual GetResult(

)

Returns the current result of the HLR computation.

Returns:: A CATHLRResult pointer. The caller has to release the CATHLRResult object after use.

o SetProjectionPlane

public virtual SetProjectionPlane( iProjectionPlane)

Defines a mathematical plane for a new view to be used in the next computation.

Parameters:

iProjectionPlane: The reference to the CATMathPlane which defines both the view direction and the projection support.

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