All Frameworks Class Hierarchy This Framework Previous Next Indexes
ApplicationFrame Class CATISO
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATEventSubscriber
|
+---System.CATCallbackManager
|
+---CATISO
Usage: you must use this class as is. You should never derive it.
public class CATISO
Class for visualizing temporary objects in given viewers.
Role: Usually you put into the Interactive Set Objects (ISO), objects that are related
to the current command. Thus it allows you to give temporaries information to the end-user.
The object, to set into the ISO, are components which implement either CATI3DGeoVisu either
CATI2DGeoVisu, two default interfaces of the Visualization Framework.
To avoid to create a new component, you can use a
CATModelForRep2D or or a
CATModelForRep3D. These 2 components already implement the visualization interfaces.
There are three default CATISO in every editor:
- a normal CATISO
- a furtive CATISO
- a background CATISO
- See also:
- CATDisplayType
Constructor and Destructor Index
- o
~CATISO()
-
Method Index
- o
AddElement(CATBaseUnknown*)
- Adds an object to the Interactive Set Of Objects.
- o
AddViewer(CAT2DViewer*)
- Adds a 2D viewer to the Interactive Set Of Objects.
- o
AddViewer(CAT3DViewer*)
- Adds a 3D viewer to the Interactive Set Of Objects.
- o
Clean()
-
- o
Empty()
- Empties the Interactive Set Of Objects.
- o
GetNextElement()
- Returns the next object of the the Interactive Set Of Objects.
- o
InitElementList()
- Sets the cursor at the begining of the Interactive Set Of Objects.
- o
IsMember(CATBaseUnknown*)
- Checks if an object is in the Interactive Set Of Objects.
- o
RemoveElement(CATBaseUnknown*,int)
- Removes an object from the Interactive Set Of Objects.
- o
RemoveViewer(CAT2DViewer*)
- Removes a 2D viewer from the Interactive Set Of Objects.
- o
RemoveViewer(CAT3DViewer*)
- Removes a 3D viewer from the Interactive Set Of Objects.
- o
UpdateElement(CATBaseUnknown*,CAT4x4Matrix*)
- Modifies a given object hold in the Interactive Set Of Objects.
Constructor and Destructor
o ~CATISO
-
Methods
o AddElement
-
Adds an object to the Interactive Set Of Objects.
- Parameters:
-
- iObject
- The object to add.
This object must NOT be a graphical representation.
A CATCreate is sent to build the representation of iObject.
Lifecycle rules deviation: An AddRef is done on iObject.
o AddViewer
-
Adds a 2D viewer to the Interactive Set Of Objects.
- Parameters:
-
- iViewer
- the 2D viewer to add.
- See also:
- CAT2DViewer
o AddViewer
-
Adds a 3D viewer to the Interactive Set Of Objects.
- Parameters:
-
- iViewer
- the 3D viewer to add.
- See also:
- CAT3DViewer
o Clean
-
- Deprecated:
- V5R14 Empty
Cleans the Interactive Set Of Objects.
Role: Empties every object put into it from any viewer and detaches all the viewers.
The result is that all the
graphical representations of the objects added into it are destroyed, that it empties the
list of viewer as well as the list of objects referenced into the current set.
o Empty
-
Empties the Interactive Set Of Objects.
Role: Empties every object put into it from any viewer.
The result is that all the
graphical representations of the objects added into it are destroyed, and each object referenced in the current set
is released.
o GetNextElement
-
Returns the next object of the the Interactive Set Of Objects.
Role:
It is useful when you want to go through all the objects that are hold in the set.
Notice that the internal cursor is updated to the new position. When this method returns
NULL, it means that you are at the end of the list.
- Returns:
- a CATBaseUnknown value
o InitElementList
public void InitElementList( | ) |
-
Sets the cursor at the begining of the Interactive Set Of Objects.
Role:
In order to get the first object of the set, you need call the InitElementList()
method then call the
GetNextElement() method.
o IsMember
-
Checks if an object is in the Interactive Set Of Objects.
- Parameters:
-
- iObject
- the object.
- Returns:
- an integer value
- 1 if the given object is already there
- 0 otherwise
o RemoveElement
public virtual void RemoveElement( | CATBaseUnknown* | iObject, |
| int | NoDestroying | =0 ) |
-
Removes an object from the Interactive Set Of Objects.
- Parameters:
-
- iObject
- The object to remove.
- NoDestroying
- if NoDestroying=0, default behaviour, the representation associated to
iObject is destroyed by sending a CATDelete.
if NoDestroying=1, then the representation associated to
iObject is not destroyed. It is simply removed from the
BagRep of CATISO.
Lifecycle rules deviation: A Release is done on iObject.
o RemoveViewer
-
Removes a 2D viewer from the Interactive Set Of Objects.
- Parameters:
-
- iViewer
- the 2D viewer to remove.
- See also:
- CAT2DViewer
o RemoveViewer
-
Removes a 3D viewer from the Interactive Set Of Objects.
- Parameters:
-
- iViewer
- the 3D viewer to remove.
- See also:
- CAT3DViewer
o UpdateElement
-
Modifies a given object hold in the Interactive Set Of Objects.
- Parameters:
-
- iObject
- The object to modifie
- iMat
- This matrix represents the tranformation to perform onto the object.If NULL
(the default value), the object is not modified.
- See also:
- CAT4x4Matrix
This object is included in the file: CATISO.h
If needed, your Imakefile.mk should include the module: CATApplicationFrame