An abstract base class for a BaseEntity providing shared functionality for handling positions, rotations, and selections. More...

Inheritance diagram for VehicleViewController:

Public Member Functions

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
Material	selectionMaterial

Protected Member Functions
abstract void	RegisterEntity ()
	Registers the entity with the main controller.

Protected Attributes
SpriteRenderer	sprite

bool	placed = false

Vector2	difference = Vector2.zero

Vector2	lastClickPos = Vector2.zero

SnapController	snapController

MainController	mainController

bool	ignoreWaypoints

Detailed Description

An abstract base class for a BaseEntity providing shared functionality for handling positions, rotations, and selections.

Member Function Documentation

◆ Deselect()

virtual void VehicleViewController.Deselect ( )

inlinevirtual

Deselects the entity and changes its position and material.

Implements IBaseController.

Reimplemented in AdversaryViewController, and EgoViewController.

◆ Destroy()

abstract void VehicleViewController.Destroy ( )

pure virtual

Destroys the entity.

Implements IBaseController.

Implemented in AdversaryViewController, and EgoViewController.

◆ GetEntity()

abstract BaseEntity VehicleViewController.GetEntity ( )

pure virtual

Gets the BaseEntity instance of the entity.

Returns: The BaseEntity instance of the entity.

Implements IBaseEntityController.

Implemented in AdversaryViewController, and EgoViewController.

◆ GetLocation()

Location VehicleViewController.GetLocation ( )

inline

Gets the location of the vehicle.

Returns: A Location object representing the vehicle's location.

Implements IBaseController.

◆ GetPosition()

Vector2 VehicleViewController.GetPosition ( )

inline

Gets the position of the entity.

Returns: The position of the entity.

◆ GetSprite()

abstract Sprite VehicleViewController.GetSprite ( )

pure virtual

Returns the Sprite associated with the vehicle.

Returns: The Sprite associated with the vehicle.

Implemented in AdversaryViewController, and EgoViewController.

◆ Init()

abstract void VehicleViewController.Init	(	AdversaryCategory	cat,
		Color	color
	)

pure virtual

Initializes the vehicle view controller with the specified category and color.

Parameters

cat	The AdversaryCategory to initialize the vehicle with.
color	The Color to initialize the vehicle with.

Implemented in AdversaryViewController, and EgoViewController.

◆ IsIgnoringWaypoints()

bool VehicleViewController.IsIgnoringWaypoints ( )

inline

Returns whether the entity should ignore waypoints.

Returns: True if the entity should ignore waypoints, false otherwise.

Implements IBaseController.

◆ OnChangeCategory()

virtual void VehicleViewController.OnChangeCategory ( AdversaryCategory cat )

inlinevirtual

Changes the category of the entity to the given category.

Parameters

cat	The new AdversaryCategory of the entity.

Implements IBaseEntityView.

Reimplemented in AdversaryViewController, and EgoViewController.

◆ OnChangeColor()

abstract void VehicleViewController.OnChangeColor ( Color c )

pure virtual

Changes the color of the entity.

Parameters

c	The new color of the entity.

Implements IBaseView.

Implemented in AdversaryViewController, and EgoViewController.

◆ OnChangeID()

void VehicleViewController.OnChangeID ( string id )

inline

Changes the ID of the entity to the given ID.

Parameters

id	The new ID of the entity.

Implements IBaseEntityView.

◆ OnChangeModel()

void VehicleViewController.OnChangeModel ( EntityModel model )

inline

Changes the model of the entity to the given model.

Parameters

model The new EntityModel of the entity.

Implements IBaseEntityView.

◆ OnChangePosition()

virtual void VehicleViewController.OnChangePosition	(	float	x,
		float	y
	)

inlinevirtual

Changes the position of the entity to the given coordinates.

Parameters

x	The X coordinate of the new position.
y	The Y coordinate of the new position.

Implements IBaseView.

Reimplemented in AdversaryViewController.

◆ OnChangeRotation()

virtual void VehicleViewController.OnChangeRotation ( float angle )

inlinevirtual

Changes the rotation of the entity to the given angle.

Parameters

angle The new angle in degrees.

Implements IBaseView.

◆ OpenEditDialog()

abstract void VehicleViewController.OpenEditDialog ( )

pure virtual

Opens the edit dialog for the entity.

Implements IBaseController.

Implemented in AdversaryViewController, and EgoViewController.

◆ RegisterEntity()

abstract void VehicleViewController.RegisterEntity ( )

protectedpure virtual

Registers the entity with the main controller.

Implemented in AdversaryViewController, and EgoViewController.

◆ Select()

virtual void VehicleViewController.Select ( )

inlinevirtual

Selects the entity and changes its position and material.

Implements IBaseController.

Reimplemented in AdversaryViewController, and EgoViewController.

◆ ShouldIgnoreWaypoints()

virtual void VehicleViewController.ShouldIgnoreWaypoints ( bool b )

inlinevirtual

Sets whether the entity should ignore waypoints.

Parameters

b	True to ignore waypoints, false otherwise.

Implements IBaseController.

Reimplemented in AdversaryViewController.

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

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ Deselect()

◆ Destroy()

◆ GetEntity()

◆ GetLocation()

◆ GetPosition()

◆ GetSprite()

◆ Init()

◆ IsIgnoringWaypoints()

◆ OnChangeCategory()

◆ OnChangeColor()

◆ OnChangeID()

◆ OnChangeModel()

◆ OnChangePosition()

◆ OnChangeRotation()

◆ OpenEditDialog()

◆ RegisterEntity()

◆ Select()

◆ ShouldIgnoreWaypoints()