All Frameworks Class Hierarchy This Framework Indexes Previous Next

VisualizationInterfaces Interface CATIModelEvents

Usage: you can reimplement this interface by deriving the supplied CATExtIModelEvents adapter class.

interface CATIModelEvents

Interface that makes components communicate with their visualization, that is their graphical representations.

Role: As the model world and the visualization world are independent, every action (ie that a geometry modification) performed by one object or by any command should trigger a visualization update (when necessary). The way to warn the visualization world is based onto visualization events and a send/receive mechanism. And the management of the visualization events is done by this interface: how one object can be connected to (or disconnected from) another object, how sending a visualization event?

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.

See also:: ,

Method Index

o ConnectTo(CATBaseUnknown*): Connects itself with a given object.
o DeconnectFrom(CATBaseUnknown*): Disconnects itself from a given object.
o Dispatch(CATNotification&): Sends a visualization event.
o GetDispatcher(): Returns the component which allows the events' sending.
o Receive(CATNotification&): Receive a visualization event.

Methods

o ConnectTo

public virtual ConnectTo( iChild)

Connects itself with a given object.
Role: Connection with a given object means that when this object sends a visualization event (a notification) thru the method the current object is "awakened" with the method. Finally the current object should send the received event thru the method. And all objects that are connected to the current object will be awakened also. This mechanism makes one event to go up to the last connected object. Usually the last connected object is the which has the ability to process the visualization event . Notice that this kind of connection is a parent-like relation between the current object(parent) and the given object(child to which it is connected).

Parameters:

iChild: the given object.

o DeconnectFrom

public virtual DeconnectFrom( iChild)

Disconnects itself from a given object.
Role: Disconnection with a given object means that the connection is broken: not any events sent by the given object will awaken the current object.

Parameters:

iChild: the given object.

o Dispatch

public virtual Dispatch( iInfo)

Sends a visualization event.

Parameters:

iInfo: the notification.

o GetDispatcher

public virtual GetDispatcher(

)

Returns the component which allows the events' sending.

o Receive

public virtual Receive( info)

Receive a visualization event.
Role: this method should be called when the current object is awaken by one of its children. It should then forward the event (thru the method) after any possible processing.

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