All Frameworks Class Hierarchy This Framework Previous Next Indexes
Visualization Notification CATModify
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---System.CATNotification
|
+---Visualization.CATModelNotification
|
+---Visualization.CATModelEntityNotification
|
+---CATModify
Usage: you can derive this class.
public class CATModify
Class representing basic type of visualization event concerning any type of modification of one object.
Role: this event describes the object you want to modify and also the way you want it to processed thru
the IID of a given interface. When one object is modified and needs to regenerate its graphical representations, it just
has to send a CATModify event to warn all its visualized graphical representations. And the visualization architecture provides two ways to process any
CATModify event:
- A default one whose result is that all its graphical representations will be destroyed and then rebuilt thru
the
CATIVisu.BuildRep method of the visualization extensions of the object
- A customized one: before any processing of a CATModify event, each visualization extension of the object is first called thru the
CATExtIVisu.ModifyRep method. If no processing is done by this method, the default processing is performed. Then you can take hand within the
CATExtIVisu.ModifyRep method of your visualization extension to process the object the way you want and take advantage of the IID enclosed in the
CATModify event to distinguish your specific event from the other
CATModify events.
- See also:
- CATExtIVisu, CATIVisu
Constructor and Destructor Index
- o
CATModify(CATBaseUnknown*,IID&,int)
- Constructs the class from a pointer to one object and an IID.
- o
CATModify(void*,int)
- Constructs the class from a pointer.
- o
~CATModify()
-
Method Index
- o
Clone()
- Returns a pointer to a new CATModify event which is the clone of the current one.
- o
GetInterfaceIID()
- Returns the interface IID.
- o
IsRepWillDie()
- Returns an integer used to optimize the processing of this event
if no graphical representations are to be destroyed.
Data Member Index
- o
_interfaceIID
- interface IID.
- o
_repWillDie
- integer used to optimize the processing of this event if no graphical representations are to be destroyed.
Constructor and Destructor
o CATModify
public CATModify( | CATBaseUnknown* | iObject, |
| const IID& | iInterfaceName | =CATBaseUnknown::ClassId(), |
| int | iRepWillDie | = 1 ) |
-
Constructs the class from a pointer to one object and an IID.
- Parameters:
-
- iObject
- the pointer to one object.
- iInterfaceName
- the interface iid.
- iRepWillDie
- an integer using to optimize the processing of this event if no graphical representations are to be destroyed.
Default value is 1.
Legal Values :
- 0 : if no graphical representation will be destroyed
- 1 : if one or several graphical representations will be destroyed when the current event is processed
o CATModify
public CATModify( | void* | iModelId, |
| int | iRepWillDie | = 1 ) |
-
Constructs the class from a pointer.
- Parameters:
-
- iModelId
- the pointer.
- iRepWillDie
-
Legal Values :
- 0 : if no graphical representation will be destroyed
- 1 : if one or several graphical representations will be destroyed when the current event is processed
o ~CATModify
public virtual ~CATModify( | ) |
-
Methods
o Clone
-
Returns a pointer to a new CATModify event which is the clone of the current one.
o GetInterfaceIID
-
Returns the interface IID.
o IsRepWillDie
public int IsRepWillDie( | )const |
-
Returns an integer used to optimize the processing of this event
if no graphical representations are to be destroyed.
Legal Values :
- 0 : if no graphical representation will be destroyed
- 1 : if one or several graphical representations will be destroyed when the current event is processed
Data Members
o _interfaceIID
protected const IID &_interfaceIID
-
interface IID.
o _repWillDie
protected int _repWillDie
-
integer used to optimize the processing of this event if no graphical representations are to be destroyed.
This object is included in the file: CATModify.h
If needed, your Imakefile.mk should include the module: CATVisualization