All Frameworks Class Hierarchy This Framework Indexes Previous Next

CATMecModUseItf Interface CATIMechanicalVisu

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

interface CATIMechanicalVisu

Interface to set the visualization status of mechanical features.
Role: The visualization status is a mechanical status that is used on mechanical bodies to make them appear in the specification tree and in the geometry. This flag is internal to the mechanical modeler.

Method Index

o GetHideStatus(): Returns the visualization status.
o GetVisuStatus(): Returns the visualization status.
o Is3DVisible(): Returns the effective visibility in 3D view.
o SetHideStatus(int&): Sets the visualization status.
o SetVisuStatus(int&): Sets the visualization status.

Methods

o GetHideStatus

public virtual GetHideStatus(

)

Returns the visualization status.

Returns:: Legal values: 0 if visible, 1 otherwise

o GetVisuStatus

public virtual GetVisuStatus(

)

Returns the visualization status.

Returns:: Legal values: 1 if visible, 0 otherwise

o Is3DVisible

public virtual Is3DVisible(

)

Returns the effective visibility in 3D view.
Role:This method takes into account both the local show / no show status of the object, and the status of its hierarchy when needed.

Returns:: Legal values: S_OK if visible, S_FALSE if not, E_UNEXPECTED if determination fails, E_FAIL means excluded from graph and 3D visu in 3D Shape (for a Mechanical/GSM Tool, "VisuOnOff" attribute was set to 1, for a GeometricalElement3D, it is agregated by such a tool)

o SetHideStatus

public virtual SetHideStatus( const iStatus)

Sets the visualization status.

Parameters:

iStatus: The visualziation status.
Legal values: 0 if visible, 1 otherwise

o SetVisuStatus

public virtual SetVisuStatus( const iStatus)

Sets the visualization status.

Parameters:

iStatus: The visualization status.
Legal values: 1 if visible, 0 otherwise

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