All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMecModUseItf Interface CATIOrientationFlag

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

interface CATIOrientationFlag

Interface to manage the orientation status of an element.
Role: Use by interactive commands to retrieve the user orientation of an element, and if this element is inverted, to retrieve the inverse feature.

Method Index

o GetInverse(CATBaseUnknown_var&): Gets the inverse element.
o IsInversed(): Gets the inverse status of the element.
o SetInverse(int): Sets an inverse status on the element.

Methods

o GetInverse

public virtual GetInverse( oInverse)

Gets the inverse element.
Role: Use this method to retrieve the inverse element created by some applications when the initial element is marked as inverted.

Parameters:

oInverse: The inverse feature of the element

Returns:

S_OK: if an inverse element has been found or calculated successfully.
E_FAIL: if there is no inverse for this kind of element.

o IsInversed

public virtual IsInversed(

)

Gets the inverse status of the element.

Returns:: The inverse status.
Legal values: 0:not inverted, 1:inverted, -1:no meaning

o SetInverse

public virtual SetInverse( const iInverse)

Sets an inverse status on the element.
Role: Use this method to notify that the default orientation of the geometrical element is not the one desired by the user.
In some applications, this will lead to the creation of an inverse element, and in other applications, this will just be used to invert the orientation of material.

Parameters:

iInverse: The inverse status.
Legal values: 0:not inverted, 1:inverted

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