All Frameworks Class Hierarchy This Framework Indexes Previous Next

GMModelInterfaces Interface CATFace

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

interface CATFace

Interface representing a topological face.

A face is a topological cell which geometry is a surface. A face is bounded by edges (these edges are put together in loops) and immersed vertices (a vertex immersed in a face must be put in a CATVertexInFace domain). A CATFace is oriented with regards to its underlying geometry:

CATOrientationNegative: the cell orientation is reversed with regards to the standard orientation.
CATOrientationPositive: the cell orientation is the standard orientation.
CATOrientationUnknown: the cell orientation is not defined.

A CATFace is created with the or methods and deleted with the method.

Method Index

o CalcArea()
o EstimateCenterParam(CATSurParam&): Retrieves a point belonging to this CATFace.
o EvalNormal(CATSurParam&,CATMathVector&,CATBoolean): Computes the normal vector on this CATFace at a given point.
o Get2DBoundingBox(): Returns the 2D bounding box of this CATFace on its surface.
o Get3DBoundingBox(): Returns the 3D bounding box of this CATFace.
o GetSurface(CATOrientation*): Returns the geometric surface of this CATFace.
o SetSurface(CATSurface*,CATOrientation): Sets the geometric surface of this CATFace.

Methods

o CalcArea

public virtual CalcArea(

)

Deprecated:: V5R14

o EstimateCenterParam

public virtual EstimateCenterParam( oCenterParam)

Retrieves a point belonging to this CATFace.

Parameters:

oCenterParam: The estimated center of this CATFace.

o EvalNormal

public virtual EvalNormal(	`iSurParam`,
	`ioNormal`,
	`iNormalization`	`=TRUE`)

Computes the normal vector on this CATFace at a given point.
This takes into account the face orientation versus its surface.

Parameters:

iSurParam

The point where to compute the normal. This does not check if iSurParam is inside the face.

ioNormal

The computed normal

iNormalization

The mode of normalization.
Legal values:

TRUE: if ioNormal must be normalized.
FALSE: otherwise.

Returns:

The diagnosis of the evaluation.
Legal values:

TRUE: if ioNormal is not null
FALSE: otherwise.

o Get2DBoundingBox

public virtual Get2DBoundingBox(

)

Returns the 2D bounding box of this CATFace on its surface.

Returns:: The 2D bounding box.

o Get3DBoundingBox

public virtual Get3DBoundingBox(

)

Returns the 3D bounding box of this CATFace.

Returns:: The 3D bounding box.

o GetSurface

public virtual GetSurface( ioOrientation =NULL)

Returns the geometric surface of this CATFace.

Parameters:

ioOrientation: The relative orientation of this with regards to its geometry. If NULL, this argument is not filled out.

Returns:

The pointer to the geometry of this CATFace.

o SetSurface

public virtual SetSurface(		`iSurface`,
		`iOrientation`	`=CATOrientationPositive`)

Sets the geometric surface of this CATFace.

Parameters:

iSurface: The pointer to the geometry of the face.
iOrientation: The relative orientation of this with regards to its geometry.

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