Interactor Class Reference

Class for representing an interactor. More...

Inheritance diagram for Interactor:

Public Member Functions
override bool	TryGetBehavior (Framework.BehaviorType behaviorType, out IBehavior behavior)
	Tries to resolve a behavior associated with this interactor using the behavior's type. More...
virtual void	AddBehavior (IBehavior behavior)
	Adds a behavior to the interactor. More...
virtual void	RemoveBehavior (Framework.BehaviorType behaviorType)
	Removes the behavior that is associated with the provided Framework.BehaviorType. More...
Public Member Functions inherited from InteractorBase
abstract Rectangle	GetBounds ()
	Gets the bounds of the interactor. More...

Properties
override IEnumerable< IBehavior >	Behaviors [get]
	Gets the behaviors associated with this interactor. More...
Properties inherited from InteractorBase
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/sets the IsEnabled flag of the interactor. More...
abstract 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 no bounds are supplied the same bounds as for the interactor will be assumed. More...
Properties inherited from IInteractor
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

Class for representing an interactor.

Member Function Documentation

TryGetBehavior()

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

inlinevirtual

Tries to resolve a behavior associated with this interactor using 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 behavior was found; otherwise, false.

Implements InteractorBase.

AddBehavior()

virtual void AddBehavior ( IBehavior  behavior )

inlinevirtual

Adds a behavior to the interactor.

Parameters

behavior

The behavior to add.

Exceptions

System.InvalidOperationException

Behavior type already exist.

Implements IMutableBehaviorsInteractor.

RemoveBehavior()

virtual void RemoveBehavior ( Framework.BehaviorType  behaviorType )

inlinevirtual

Removes the behavior that is associated with the provided Framework.BehaviorType.

Parameters

behaviorType

The behavior type used to identify the correct behavior.

Implements IMutableBehaviorsInteractor.

Property Documentation

Behaviors

override IEnumerable<IBehavior> Behaviors

get

Gets the behaviors associated with this interactor.

The behaviors associated with this interactor.

---

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

• Interactor.cs