IInteractor Interface Reference

Represents an interactor. More...

Inheritance diagram for IInteractor:

Public Member Functions
Rectangle	GetBounds ()
	Gets the bounds of the interactor. More...
bool	TryGetBehavior (Framework.BehaviorType behaviorType, out IBehavior behavior)
	Tries to resolve a behavior associated with this interactor by the behavior's type. More...
void	HandleEvent (InteractionEvent interactionEvent)
	Handles an Model.InteractionEvent. More...
Public Member Functions inherited from IChecksummable
int	GetChecksum ()
	Returns a checksum of the object. More...

Properties
string	Id [get]
	Gets the interactor identifier. More...
string	ParentId [get]
	Gets the interactor's parent identifier. More...
string	WindowId [get]
	Gets the window identifier that this interactor belong to. More...
double	Z [get]
	Gets the Z order of the interactor. More...
bool	IsDeleted [get]
	Gets the IsDeleted flag of the interactor. More...
bool	IsEnabled [get]
	Gets the IsEnabled flag of the interactor. More...
IEnumerable< IBehavior >	Behaviors [get]
	Gets the behaviors associated with this interactor. More...
IMask	Mask [get]
	Gets the IMask used to describe the geometry of the interactor in detail (if needed). Will be null when the interactor has no mask (the normal case). More...
Rectangle?	MaskBounds [get]
	Gets a rectangle describing the mask bounds. The mask bounds describe the geometry over which the mask applies. The X and Y coordinates are relative to the X and Y coordinates of the interactor bounds. If null, the same bounds as for the interactor will be assumed. More...

Detailed Description

Represents an interactor.

Member Function Documentation

GetBounds()

Rectangle GetBounds

(

)

Gets the bounds of the interactor.

Returns

The bounds of the interactor.

Implemented in InteractorBase, WpfInteractor, CachedBoundsInteractor, and DeletedInteractor.

TryGetBehavior()

bool TryGetBehavior	(	Framework.BehaviorType	behaviorType,
		out IBehavior	behavior
	)

Tries to resolve a behavior associated with this interactor by the behavior's type.

Parameters

behaviorType	The behavior type.
behavior	When this method returns, contains the behavior with a behavior type equivalent of the behavior type contained in behaviorType , if the operation succeeded, or null if the operation failed.

Returns

True if the operation succeeded, or false if the operation failed.

Implemented in InteractorBase, and Interactor.

HandleEvent()

void HandleEvent

(

InteractionEvent

interactionEvent

)

Handles an Model.InteractionEvent.

Parameters

interactionEvent

The interaction event to handle.

Property Documentation

Id

string Id

get

Gets the interactor identifier.

The identifier.

ParentId

string ParentId

get

Gets the interactor's parent identifier.

The interactor's parent identifier.

WindowId

string WindowId

get

Gets the window identifier that this interactor belong to.

The window identifier that this interactor belong to.

Z

double Z

get

Gets the Z order of the interactor.

The Z order of the interactor.

IsDeleted

bool IsDeleted

get

Gets the IsDeleted flag of the interactor.

The IsDeleted flag of the interactor.

IsEnabled

bool IsEnabled

get

Gets the IsEnabled flag of the interactor.

The IsEnabled flag of the interactor.

Behaviors

IEnumerable<IBehavior> Behaviors

get

Gets the behaviors associated with this interactor.

The behaviors associated with this interactor.

Mask

IMask Mask

get

Gets the IMask used to describe the geometry of the interactor in detail (if needed). Will be null when the interactor has no mask (the normal case).

MaskBounds

Rectangle? MaskBounds

get

Gets a rectangle describing the mask bounds. The mask bounds describe the geometry over which the mask applies. The X and Y coordinates are relative to the X and Y coordinates of the interactor bounds. If null, the same bounds as for the interactor will be assumed.

---

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

• IInteractor.cs