All Frameworks Class Hierarchy This Framework Next Indexes
CATIAApplicationFrame Class CATCafCenterGraph
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATCafCenterGraph
Usage: you must use this class as is. You should never derive it.
public class CATCafCenterGraph
Class to visually center a graph on some element.
Role: Instanciate this class to center a graph. It
can be centered on:
- the selection (see CATCSO ). If the selection contains more than one element, the result is not specified.
- the highlighted object (see
CATHSO ). If the current HSO contains more than one element, the result is not specified.
- the object under mouse when contextual menu is displayed.
For example, to center a graph on the current selection use
the following code:
CATCafCenterGraph MyObj;
MyObj->CenterGraph("OnCSO",MyNavigBox);
Constructor and Destructor Index
- o
CATCafCenterGraph()
- Constructs an instance of CATCafCenterGraph class.
- o
~CATCafCenterGraph()
-
Method Index
- o
CenterGraph(CATString&,CATNavigBox*)
- Centers a graph.
Constructor and Destructor
o CATCafCenterGraph
public CATCafCenterGraph( | ) |
-
Constructs an instance of CATCafCenterGraph class.
o ~CATCafCenterGraph
public virtual ~CATCafCenterGraph( | ) |
-
Methods
o CenterGraph
-
Centers a graph.
- Parameters:
-
- iType
- A string to specify on which element to center the graph.
Legal values
- "OnCSO" to center the graph on selection.
- "OnHSO" to center the graph on highlighted object.
- "OnCtxMenu" to center the graph on the object under mouse when contextual menu is displayed.
- iNavigBox
- A pointer to the instance of
CATNavigBox class that owns the graph to center.
- Returns:
- Always returns S_OK.
This object is included in the file: CATCafCenterGraph.h
If needed, your Imakefile.mk should include the module: CATIAApplicationFrame