Public Member Functions | Properties | List of all members
InteractorAgent Class Referenceabstract

Base class for an interactor agent. More...

Inheritance diagram for InteractorAgent:
IInteractorAgent ProviderInteractorAgent< TProvider >

Public Member Functions

abstract Task< IEnumerable< IInteractor > > FindInteractorsAsync (Rectangle rect, CancellationToken cancellationToken)
 Finds the interactors affected by the provided Rectangle. This operation can be cancelled using the specified CancellationToken. More...
 
void Dispose ()
 Disposes the interactor agent. Should be called before removing the interactor agent from the Host. Will be called by the Host at shutdown. More...
 

Properties

bool IsDisposed [get]
 Gets a value indicating whether the agent is disposed. More...
 

Detailed Description

Base class for an interactor agent.

Member Function Documentation

◆ FindInteractorsAsync()

abstract Task<IEnumerable<IInteractor> > FindInteractorsAsync ( Rectangle  rect,
CancellationToken  cancellationToken 
)
pure virtual

Finds the interactors affected by the provided Rectangle. This operation can be cancelled using the specified CancellationToken.

Parameters
rectThe query.
cancellationTokenThe cancellation token.
Returns
A task that represents the asynchronous operation. The value of IEnumerable<IInteractorBase> contains the found interactors.

Implements IInteractorAgent.

Implemented in ProviderInteractorAgent< TProvider >.

◆ Dispose()

void Dispose ( )
inline

Disposes the interactor agent. Should be called before removing the interactor agent from the Host. Will be called by the Host at shutdown.

Property Documentation

◆ IsDisposed

bool IsDisposed
get

Gets a value indicating whether the agent is disposed.

true if this agent is disposed; otherwise, false.


The documentation for this class was generated from the following file: