Class CompassObjectViewModel

View model for a compass object.

Inheritance

System.Object

CompassObjectViewModel

Namespace: Phoenix.Controls.Compass

Assembly: Phoenix.Controls.Compass.dll

Syntax

public class CompassObjectViewModel : BindableBase

Constructors

View Source

CompassObjectViewModel(CompassGameObject, CompassSettings, CompassObjectType, String)

Initializes a new instance of the CompassObjectViewModel class.

Declaration

public CompassObjectViewModel(CompassGameObject compassObject, CompassSettings compassSettings, CompassObjectType objectType, string fullObjectTypeName = null)

Parameters

Type	Name	Description
CompassGameObject	compassObject	The compass object.
CompassSettings	compassSettings	The compass settings.
CompassObjectType	objectType	The object type associated with this view model.
System.String	fullObjectTypeName	The full name of the object type. To avoid duplicates with GST data, other sources append source name to object type name.

Fields

View Source

AbovePlaneY

The compass Y value for objects above the player.

Declaration

public const float AbovePlaneY = 45F

Field Value

Type	Description
System.Single

View Source

BelowPlaneY

The compass Y value for objects below the player.

Declaration

public const float BelowPlaneY = 105F

Field Value

Type	Description
System.Single

View Source

NearPlaneY

The compass Y value for objects near the player.

Declaration

public const float NearPlaneY = 75F

Field Value

Type	Description
System.Single

Properties

View Source

CompassObject

Gets or sets the compass object.

Declaration

public CompassGameObject CompassObject { get; set; }

Property Value

Type	Description
CompassGameObject

View Source

CompassX

Gets the compass x position.

Declaration

public float CompassX { get; }

Property Value

Type	Description
System.Single

View Source

CompassY

Gets the compass y position.

Declaration

public float CompassY { get; }

Property Value

Type	Description
System.Single

View Source

CurrentDistanceFromPlayer

Gets the current distance from the player.

Declaration

public float CurrentDistanceFromPlayer { get; }

Property Value

Type	Description
System.Single

View Source

CurrentRotationFromPlayer

Gets the current rotation from player.

Declaration

public double CurrentRotationFromPlayer { get; }

Property Value

Type	Description
System.Double

View Source

FullObjectTypeName

Gets the full name of the object type. To avoid duplicates with GST data, other sources append source name to object type name.

Declaration

public string FullObjectTypeName { get; }

Property Value

Type	Description
System.String

View Source

IndicatorMaxSize

Gets or sets the maximum size of the indicator.

Declaration

public int IndicatorMaxSize { get; set; }

Property Value

Type	Description
System.Int32

View Source

IndicatorMinSize

Gets or sets the minimum size of the indicator.

Declaration

public int IndicatorMinSize { get; set; }

Property Value

Type	Description
System.Int32

View Source

IndicatorSize

Gets the size of the indicator.

Declaration

public int IndicatorSize { get; }

Property Value

Type	Description
System.Int32

View Source

IsBackLeft

Gets a value indicating whether the object is to the back left 90 degree quadrant behind the player.

Declaration

public bool IsBackLeft { get; }

Property Value

Type	Description
System.Boolean

View Source

IsBackRight

Gets a value indicating whether the object is to the back right 90 degree quadrant behind the player.

Declaration

public bool IsBackRight { get; }

Property Value

Type	Description
System.Boolean

View Source

LastUpdated

Gets or sets the time the object was last updated.

Declaration

public DateTime LastUpdated { get; set; }

Property Value

Type	Description
System.DateTime

View Source

ObjectType

Gets or sets the object type associated with this view model.

Declaration

public CompassObjectType ObjectType { get; set; }

Property Value

Type	Description
CompassObjectType

View Source

QueueY

Gets the compass queue y position.

Declaration

public float QueueY { get; }

Property Value

Type	Description
System.Single

View Source

Tracked

Gets or sets a value indicating whether this object is being tracked or not.

Declaration

public bool Tracked { get; set; }

Property Value

Type	Description
System.Boolean

View Source

TrackedIndicatorSize

Gets the size of the tracked indicator.

Declaration

public int TrackedIndicatorSize { get; }

Property Value

Type	Description
System.Int32

Methods

View Source

ToString()

Returns a System.String that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents this instance.

View Source

UpdateCanvasPosition()

Informs the object that it's canvas position needs to be updated.

Declaration

public void UpdateCanvasPosition()