AfrFoundation 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 either , two default interfaces of the Visualization Framework.
To avoid to create a new component, you can use a or or a . These 2 components already implement the visualization interfaces.

There are three default CATISO in every editor:

  1. a normal CATISO
  2. a furtive CATISO
  3. a background CATISO
See also:

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
public virtual ~CATISO()

Methods


o AddElement
public virtual AddElement( iObject)
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
public AddViewer( iViewer)
Adds a 2D viewer to the Interactive Set Of Objects.
Parameters:
iViewer
the 2D viewer to add.
See also:
o AddViewer
public AddViewer( iViewer)
Adds a 3D viewer to the Interactive Set Of Objects.
Parameters:
iViewer
the 3D viewer to add.
See also:
o Clean
public 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
public 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
public 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.
o InitElementList
public 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 method.
o IsMember
public IsMember( iObject)
Checks if an object is in the Interactive Set Of Objects.
Parameters:
iObject
the object.
Returns:
an integer value
  1. 1 if the given object is already there
  2. 0 otherwise
o RemoveElement
public virtual RemoveElement( iObject,
NoDestroying=0 )
Removes an object from the Interactive Set Of Objects.
Parameters:
iObject
The object to remove.
ToRemove
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
public RemoveViewer( iViewer)
Removes a 2D viewer from the Interactive Set Of Objects.
Parameters:
iViewer
the 2D viewer to remove.
See also:
o RemoveViewer
public RemoveViewer( iViewer)
Removes a 3D viewer from the Interactive Set Of Objects.
Parameters:
iViewer
the 3D viewer to remove.
See also:
o UpdateElement
public virtual UpdateElement( iObject,
iMat=NULL)
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:
This object is included in the file: CATISO.h
If needed, your Imakefile.mk should include the module: CATAfrFoundation

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