EgoViewController Class Reference

Controller for the Adversary entity in the scene. More...

Inheritance diagram for EgoViewController:

Public Member Functions
override void	Awake ()
override Sprite	GetSprite ()
	Gets the corresponding Sprite for the Ego Vehicle.
override void	Select ()
	Selects the current object and the Destination. Signals the SnapController to ignore clicks.
override void	Deselect ()
	Deselects the current object and the Destination. Signals the SnapController not to ignore clicks.
void	SubmitDestination (Location destination)
	Set the Destination of the Ego vehicle.
override void	Destroy ()
	Destroys the Ego GameObject and the Destination.
override void	OnChangeColor (Color color)
	Changes the color of the current the Ego GameObject and its associated destination.
override void	Init (AdversaryCategory cat, Color color)
	Initializes the controller with the given AdversaryCategory and color.
void	Init (Ego ego)
	Initializes the controller with the given Ego instance.
override void	OnChangeCategory (AdversaryCategory cat)
	Changes the sprite according to the new category.
override BaseEntity	GetEntity ()
	Returns the BaseEntity representing the current Ego vehicle.
override void	OpenEditDialog ()
	Opens the edit dialog for the current object.
Public Member Functions inherited from VehicleViewController
virtual void	Awake ()
abstract Sprite	GetSprite ()
	Returns the Sprite associated with the vehicle.
Location	GetLocation ()
	Gets the location of the vehicle.
abstract void	Init (AdversaryCategory cat, Color color)
	Initializes the vehicle view controller with the specified category and color.
virtual void	OnChangePosition (float x, float y)
	Changes the position of the entity to the given coordinates.
virtual void	OnChangeRotation (float angle)
	Changes the rotation of the entity to the given angle.
virtual void	OnChangeCategory (AdversaryCategory cat)
	Changes the category of the entity to the given category.
void	OnChangeModel (EntityModel model)
	Changes the model of the entity to the given model.
void	OnChangeID (string id)
	Changes the ID of the entity to the given ID.
virtual void	Select ()
	Selects the entity and changes its position and material.
virtual void	Deselect ()
	Deselects the entity and changes its position and material.
abstract void	Destroy ()
	Destroys the entity.
Vector2	GetPosition ()
	Gets the position of the entity.
void	Update ()
	Updates the entity's position and rotation.
void	OnMouseDrag ()
	Handles the OnMouseDrag event to move the entity.
void	OnMouseDown ()
	Handles the OnMouseDown event to select and place the entity.
bool	IsIgnoringWaypoints ()
	Returns whether the entity should ignore waypoints.
virtual void	ShouldIgnoreWaypoints (bool b)
	Sets whether the entity should ignore waypoints.
abstract BaseEntity	GetEntity ()
	Gets the BaseEntity instance of the entity.
abstract void	OpenEditDialog ()
	Opens the edit dialog for the entity.
abstract void	OnChangeColor (Color c)
	Changes the color of the entity.
BaseEntity	GetEntity ()
	Returns the entity associated with the controller. This can be Ego or Adversary.
void	Select ()
	Selects the controller.
void	Deselect ()
	Deselects the controller.
void	Destroy ()
	Destroys the controller.
void	OpenEditDialog ()
	Opens the edit dialog for the controller.
bool	IsIgnoringWaypoints ()
	Returns a boolean indicating whether or not the controller ignores waypoints.
void	ShouldIgnoreWaypoints (bool b)
	Sets the value indicating whether or not the controller should ignore waypoints.
Location	GetLocation ()
	Returns the location of the object that the controller belongs to.
void	OnChangeCategory (AdversaryCategory cat)
	Called when the category of the entity changes. </summary Parameters cat The new category of the entity.
void	OnChangeModel (EntityModel model)
	Called when the model of the entity changes.
void	OnChangeID (string id)
	Called when the ID of the entity changes.
void	OnChangePosition (float x, float y)
	Called when the position of the corresponding object changes.
void	OnChangeRotation (float angle)
	Called when the rotation of the corresponding object changes.
void	OnChangeColor (Color color)
	Called when the color of the corresponding object changes.

Public Attributes
GameObject	DestinationPrefab
Public Attributes inherited from VehicleViewController
Material	selectionMaterial

Protected Member Functions
override void	RegisterEntity ()
	Registers the current object as the Ego in the main controller.
abstract void	RegisterEntity ()
	Registers the entity with the main controller.

Additional Inherited Members
Protected Attributes inherited from VehicleViewController
SpriteRenderer	sprite
bool	placed = false
Vector2	difference = Vector2.zero
Vector2	lastClickPos = Vector2.zero
SnapController	snapController
MainController	mainController
bool	ignoreWaypoints

Detailed Description

Controller for the Adversary entity in the scene.

Member Function Documentation

Awake()

override void EgoViewController.Awake ( )

inlinevirtual

Reimplemented from VehicleViewController.

Deselect()

override void EgoViewController.Deselect ( )

inlinevirtual

Deselects the current object and the Destination. Signals the SnapController not to ignore clicks.

Reimplemented from VehicleViewController.

Destroy()

override void EgoViewController.Destroy ( )

inlinevirtual

Destroys the Ego GameObject and the Destination.

Implements VehicleViewController.

GetEntity()

override BaseEntity EgoViewController.GetEntity ( )

inlinevirtual

Returns the BaseEntity representing the current Ego vehicle.

Returns

The BaseEntity instance of the current object.

Implements VehicleViewController.

GetSprite()

override Sprite EgoViewController.GetSprite ( )

inlinevirtual

Gets the corresponding Sprite for the Ego Vehicle.

Returns

Sprite of the Ego

Implements VehicleViewController.

Init() [1/2]

override void EgoViewController.Init ( AdversaryCategory  cat, Color  color  )

inlinevirtual

Initializes the controller with the given AdversaryCategory and color.

Parameters

cat	The AdversaryCategory to assign to the Ego object.
color	The color to assign to the Ego object.

Implements VehicleViewController.

Init() [2/2]

void EgoViewController.Init ( Ego  ego )

inline

Initializes the controller with the given Ego instance.

Parameters

ego	The Ego instance to initialize the object with.

OnChangeCategory()

override void EgoViewController.OnChangeCategory ( AdversaryCategory  cat )

inlinevirtual

Changes the sprite according to the new category.

Parameters

cat	The new category of the Ego vehicle.

Reimplemented from VehicleViewController.

OnChangeColor()

override void EgoViewController.OnChangeColor ( Color  color )

inlinevirtual

Changes the color of the current the Ego GameObject and its associated destination.

Parameters

color

The color to change to.

Implements VehicleViewController.

OpenEditDialog()

override void EgoViewController.OpenEditDialog ( )

inlinevirtual

Opens the edit dialog for the current object.

Implements VehicleViewController.

RegisterEntity()

override void EgoViewController.RegisterEntity ( )

inlineprotectedvirtual

Registers the current object as the Ego in the main controller.

Implements VehicleViewController.

Select()

override void EgoViewController.Select ( )

inlinevirtual

Selects the current object and the Destination. Signals the SnapController to ignore clicks.

Reimplemented from VehicleViewController.

SubmitDestination()

void EgoViewController.SubmitDestination ( Location  destination )

inline

Set the Destination of the Ego vehicle.

Parameters

destination

The destination location to submit.

---

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

• C:/Users/stefa/source/repos/AI_Testing_Simulator/Unity/Assets/Scripts/ViewControllers/EgoViewController.cs