CATFmtUIInterfaces Interface CATIFmtViewManager

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


interface CATIFmtViewManager

Interface to be used to manage Finite Element visualization.


Method Index


o AddViewChangeCallback(CATBaseUnknown*,CATSubscriberMethod)
Adds a callback for a given event subscriber when the Finite Element visualization mode is changed.
o GetViewMode()
Query for the currunt Finite Element visualization mode.
o IsGroupVisualisationActive()
Query if groups are visualized.
o RemoveViewChangeCallback(CATBaseUnknown*,CATCallback)
Removes a visualization mode change callback with a given identifier added for a given event subscriber.
o SendViewChangeNotification()
Send a notification informing that the visualization mode has changed (see AddViewChangeCallback).
o SetCustomVisualization(CATIFmtCustomVisualization*)
Sets and activates a custom Finite Element visualization mode.
o SetGroupVisualisation(CATBoolean)
Manage the visualisation of groups (currently limited to element's groups).
o SetPickMode(CATBoolean)
Set the sensitivity to picking of the entire mesh (nodes and elements).
o SetViewMode(CATFmtViewMode)
Sets and activates a given Finite Element visualization mode.

Methods


o AddViewChangeCallback
public virtual AddViewChangeCallback( iClient,
iMethod)
Adds a callback for a given event subscriber when the Finite Element visualization mode is changed.
Parameters:
iClient
The event subscriber, that is the object that features the iMethod method called whenever the visualization mode is changed.
iMethod
The subscriber's method to call whenever the visualization mode is changed.
Returns:
The identifier of the created callback.
o GetViewMode
public virtual GetViewMode()
Query for the currunt Finite Element visualization mode.
Returns:
The current visualization mode:
CATFmtViewNormal
Elements are displayed using their Mesh Part color.
CATFmtViewQuality3Color
Elements are displayed using three different colors based on results of quality checks (good, poor, bad).
CATFmtViewOrientation
Surface elements are displayed using two different colors for each side.
CATFmtViewCustom
Surface elements are displayed using custom colors.
o IsGroupVisualisationActive
public virtual IsGroupVisualisationActive()
Query if groups are visualized.
Returns:
the groups visualization status.
Legal values:
TRUE
Groups are visualized.
FALSE
Groups are not visualized.
o RemoveViewChangeCallback
public virtual RemoveViewChangeCallback( iClient,
iId)
Removes a visualization mode change callback with a given identifier added for a given event subscriber.
Parameters:
iClient
The event subscriber
iId
The identifier of the callback to remove.
Legal values: This identifier was returned by the
method.
o SendViewChangeNotification
public virtual SendViewChangeNotification()
Send a notification informing that the visualization mode has changed (see AddViewChangeCallback).
o SetCustomVisualization
public virtual SetCustomVisualization( iCustomVisu)
Sets and activates a custom Finite Element visualization mode.
Parameters:
iCustomVisu
Interface to be used to customize visualization.
Returns:
An HRESULT.
Legal values:
S_OK
The custom visualization have been succesfully activated.
E_FAIL
The operation failed.
o SetGroupVisualisation
public virtual SetGroupVisualisation( iActive)
Manage the visualisation of groups (currently limited to element's groups).
Parameters:
iActive
Groups visualization status.
Legal values:
TRUE
Activate groups visualization.
FALSE
Deactivate groups visualization.
o SetPickMode
public virtual SetPickMode( iPickable)
Set the sensitivity to picking of the entire mesh (nodes and elements).
Parameters:
iPickable
Picking sensitivity.
Legal values:
TRUE
Nodes and elements are not sensitive to picking.
FALSE
Nodes and elements can be picked.
o SetViewMode
public virtual SetViewMode( iViewMode)
Sets and activates a given Finite Element visualization mode.
Parameters:
iViewMode
Visualization mode to activate.
Legal values:
CATFmtViewNormal
Elements are displayed using their Mesh Part color.
CATFmtViewQuality3Color
Elements are displayed using three different colors based on results of quality checks (good, poor, bad).
CATFmtViewOrientation
Surface elements are displayed using two different colors for each side.
Returns:
An HRESULT.
Legal values:
S_OK
The visualization mode have been succesfully activated.
E_FAIL
The operation failed.

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.