-
Notifications
You must be signed in to change notification settings - Fork 0
Vector2
Home | API by Category | Complete API Index | API Compatibility
| Field | Value |
|---|---|
| Full name | Electron2D.Vector2 |
| Namespace | Electron2D |
| Kind | struct |
| Category | Math and Data |
Represents the vector2 value type.
public struct Electron2D.Vector2 : System.IEquatable<Electron2D.Vector2>This type is part of the Electron2D 0.1.0 Preview public API.
Instances of this type are not synchronized. Access them from the thread that owns the object unless the member documentation states otherwise.
This API is available since Electron2D 0.1.0 Preview.
| Member | Kind | Summary |
|---|---|---|
Down |
Field | Represents the down value. |
Inf |
Field | Represents the inf value. |
Left |
Field | Represents the left value. |
One |
Field | Represents the one value. |
Right |
Field | Represents the right value. |
Up |
Field | Represents the up value. |
Zero |
Field | Represents the zero value. |
X |
Property | Gets or sets the x value. |
Y |
Property | Gets or sets the y value. |
Electron2D.Vector2(System.Single, System.Single) |
Constructor | Initializes a new instance of the Vector2 type. |
Abs() |
Method | Executes the abs operation. |
Angle() |
Method | Executes the angle operation. |
AngleTo(Electron2D.Vector2) |
Method | Executes the angle to operation. |
Ceil() |
Method | Executes the ceil operation. |
Clamp(Electron2D.Vector2, Electron2D.Vector2) |
Method | Executes the clamp operation. |
Cross(Electron2D.Vector2) |
Method | Executes the cross operation. |
DirectionTo(Electron2D.Vector2) |
Method | Executes the direction to operation. |
DistanceSquaredTo(Electron2D.Vector2) |
Method | Executes the distance squared to operation. |
DistanceTo(Electron2D.Vector2) |
Method | Executes the distance to operation. |
Dot(Electron2D.Vector2) |
Method | Executes the dot operation. |
Equals(Electron2D.Vector2) |
Method | Executes the equals operation. |
Equals(System.Object) |
Method | Executes the equals operation. |
Floor() |
Method | Executes the floor operation. |
GetHashCode() |
Method | Gets the hash code value. |
IsEqualApprox(Electron2D.Vector2) |
Method | Checks whether equal approx is true. |
IsFinite() |
Method | Checks whether finite is true. |
IsNormalized() |
Method | Checks whether normalized is true. |
IsZeroApprox() |
Method | Checks whether zero approx is true. |
Length() |
Method | Executes the length operation. |
LengthSquared() |
Method | Executes the length squared operation. |
Lerp(Electron2D.Vector2, System.Single) |
Method | Executes the lerp operation. |
Max(Electron2D.Vector2) |
Method | Executes the max operation. |
Min(Electron2D.Vector2) |
Method | Executes the min operation. |
Normalized() |
Method | Executes the normalized operation. |
Rotated(System.Single) |
Method | Executes the rotated operation. |
Round() |
Method | Executes the round operation. |
Sign() |
Method | Executes the sign operation. |
ToString() |
Method | Executes the to string operation. |
op_Addition(Electron2D.Vector2, Electron2D.Vector2) |
Method | Applies the + operator. |
op_Division(Electron2D.Vector2, Electron2D.Vector2) |
Method | Applies the / operator. |
op_Division(Electron2D.Vector2, System.Single) |
Method | Applies the / operator. |
op_Equality(Electron2D.Vector2, Electron2D.Vector2) |
Method | Applies the == operator. |
op_Inequality(Electron2D.Vector2, Electron2D.Vector2) |
Method | Applies the != operator. |
op_Multiply(Electron2D.Vector2, Electron2D.Vector2) |
Method | Applies the * operator. |
op_Multiply(Electron2D.Vector2, System.Single) |
Method | Applies the * operator. |
op_Multiply(System.Single, Electron2D.Vector2) |
Method | Applies the * operator. |
op_Subtraction(Electron2D.Vector2, Electron2D.Vector2) |
Method | Applies the - operator. |
op_UnaryNegation(Electron2D.Vector2) |
Method | Applies the - operator. |
Kind: Field
public static Electron2D.Vector2 DownRepresents the down value.
Use this field as a stable value supplied by the declaring type.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Field
public static Electron2D.Vector2 InfRepresents the inf value.
Use this field as a stable value supplied by the declaring type.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Field
public static Electron2D.Vector2 LeftRepresents the left value.
Use this field as a stable value supplied by the declaring type.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Field
public static Electron2D.Vector2 OneRepresents the one value.
Use this field as a stable value supplied by the declaring type.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Field
public static Electron2D.Vector2 RightRepresents the right value.
Use this field as a stable value supplied by the declaring type.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Field
public static Electron2D.Vector2 UpRepresents the up value.
Use this field as a stable value supplied by the declaring type.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Field
public static Electron2D.Vector2 ZeroRepresents the zero value.
Use this field as a stable value supplied by the declaring type.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Property
public System.Single X { get; set; }Gets or sets the x value.
This property follows the validation and lifetime rules of its declaring type.
The current x value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Property
public System.Single Y { get; set; }Gets or sets the y value.
This property follows the validation and lifetime rules of its declaring type.
The current y value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Constructor
public Electron2D.Vector2(System.Single x, System.Single y)Initializes a new instance of the Vector2 type.
The new instance follows the lifetime and validation rules of its declaring type.
-
x: The X coordinate or component. -
y: The Y coordinate or component.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public Electron2D.Vector2 Abs()()Executes the abs operation.
This method follows the validation and lifetime rules of its declaring type.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Single Angle()()Executes the angle operation.
This method follows the validation and lifetime rules of its declaring type.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Single AngleTo(Electron2D.Vector2)(Electron2D.Vector2 to)Executes the angle to operation.
This method follows the validation and lifetime rules of its declaring type.
-
to: The to value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public Electron2D.Vector2 Ceil()()Executes the ceil operation.
This method follows the validation and lifetime rules of its declaring type.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public Electron2D.Vector2 Clamp(Electron2D.Vector2, Electron2D.Vector2)(Electron2D.Vector2 min, Electron2D.Vector2 max)Executes the clamp operation.
This method follows the validation and lifetime rules of its declaring type.
-
min: The min value. -
max: The max value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Single Cross(Electron2D.Vector2)(Electron2D.Vector2 with)Executes the cross operation.
This method follows the validation and lifetime rules of its declaring type.
-
with: The with value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public Electron2D.Vector2 DirectionTo(Electron2D.Vector2)(Electron2D.Vector2 to)Executes the direction to operation.
This method follows the validation and lifetime rules of its declaring type.
-
to: The to value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Single DistanceSquaredTo(Electron2D.Vector2)(Electron2D.Vector2 to)Executes the distance squared to operation.
This method follows the validation and lifetime rules of its declaring type.
-
to: The to value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Single DistanceTo(Electron2D.Vector2)(Electron2D.Vector2 to)Executes the distance to operation.
This method follows the validation and lifetime rules of its declaring type.
-
to: The to value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Single Dot(Electron2D.Vector2)(Electron2D.Vector2 with)Executes the dot operation.
This method follows the validation and lifetime rules of its declaring type.
-
with: The with value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Boolean Equals(Electron2D.Vector2)(Electron2D.Vector2 other)Executes the equals operation.
This method follows the validation and lifetime rules of its declaring type.
-
other: The other value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Boolean Equals(System.Object)(System.Object obj)Executes the equals operation.
This method follows the validation and lifetime rules of its declaring type.
-
obj: The obj value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public Electron2D.Vector2 Floor()()Executes the floor operation.
This method follows the validation and lifetime rules of its declaring type.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Int32 GetHashCode()()Gets the hash code value.
This method follows the validation and lifetime rules of its declaring type.
The current hash code value.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Boolean IsEqualApprox(Electron2D.Vector2)(Electron2D.Vector2 other)Checks whether equal approx is true.
This method follows the validation and lifetime rules of its declaring type.
-
other: The other value.
true when the condition is met; otherwise, false.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Boolean IsFinite()()Checks whether finite is true.
This method follows the validation and lifetime rules of its declaring type.
true when the condition is met; otherwise, false.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Boolean IsNormalized()()Checks whether normalized is true.
This method follows the validation and lifetime rules of its declaring type.
true when the condition is met; otherwise, false.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Boolean IsZeroApprox()()Checks whether zero approx is true.
This method follows the validation and lifetime rules of its declaring type.
true when the condition is met; otherwise, false.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Single Length()()Executes the length operation.
This method follows the validation and lifetime rules of its declaring type.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.Single LengthSquared()()Executes the length squared operation.
This method follows the validation and lifetime rules of its declaring type.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public Electron2D.Vector2 Lerp(Electron2D.Vector2, System.Single)(Electron2D.Vector2 to, System.Single weight)Executes the lerp operation.
This method follows the validation and lifetime rules of its declaring type.
-
to: The to value. -
weight: The weight value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public Electron2D.Vector2 Max(Electron2D.Vector2)(Electron2D.Vector2 with)Executes the max operation.
This method follows the validation and lifetime rules of its declaring type.
-
with: The with value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public Electron2D.Vector2 Min(Electron2D.Vector2)(Electron2D.Vector2 with)Executes the min operation.
This method follows the validation and lifetime rules of its declaring type.
-
with: The with value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public Electron2D.Vector2 Normalized()()Executes the normalized operation.
This method follows the validation and lifetime rules of its declaring type.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public Electron2D.Vector2 Rotated(System.Single)(System.Single angle)Executes the rotated operation.
This method follows the validation and lifetime rules of its declaring type.
-
angle: The angle value.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public Electron2D.Vector2 Round()()Executes the round operation.
This method follows the validation and lifetime rules of its declaring type.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public Electron2D.Vector2 Sign()()Executes the sign operation.
This method follows the validation and lifetime rules of its declaring type.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public System.String ToString()()Executes the to string operation.
This method follows the validation and lifetime rules of its declaring type.
The result of the operation.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public static Electron2D.Vector2 op_Addition(Electron2D.Vector2, Electron2D.Vector2)(Electron2D.Vector2 left, Electron2D.Vector2 right)Applies the + operator.
This operator returns a value derived from the supplied operands.
-
left: The left value. -
right: The right value.
The result of the operator.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public static Electron2D.Vector2 op_Division(Electron2D.Vector2, Electron2D.Vector2)(Electron2D.Vector2 left, Electron2D.Vector2 right)Applies the / operator.
This operator returns a value derived from the supplied operands.
-
left: The left value. -
right: The right value.
The result of the operator.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public static Electron2D.Vector2 op_Division(Electron2D.Vector2, System.Single)(Electron2D.Vector2 value, System.Single scalar)Applies the / operator.
This operator returns a value derived from the supplied operands.
-
value: The value to use. -
scalar: The scalar value.
The result of the operator.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public static System.Boolean op_Equality(Electron2D.Vector2, Electron2D.Vector2)(Electron2D.Vector2 left, Electron2D.Vector2 right)Applies the == operator.
This operator returns a value derived from the supplied operands.
-
left: The left value. -
right: The right value.
The result of the operator.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public static System.Boolean op_Inequality(Electron2D.Vector2, Electron2D.Vector2)(Electron2D.Vector2 left, Electron2D.Vector2 right)Applies the != operator.
This operator returns a value derived from the supplied operands.
-
left: The left value. -
right: The right value.
The result of the operator.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public static Electron2D.Vector2 op_Multiply(Electron2D.Vector2, Electron2D.Vector2)(Electron2D.Vector2 left, Electron2D.Vector2 right)Applies the * operator.
This operator returns a value derived from the supplied operands.
-
left: The left value. -
right: The right value.
The result of the operator.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public static Electron2D.Vector2 op_Multiply(Electron2D.Vector2, System.Single)(Electron2D.Vector2 value, System.Single scalar)Applies the * operator.
This operator returns a value derived from the supplied operands.
-
value: The value to use. -
scalar: The scalar value.
The result of the operator.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public static Electron2D.Vector2 op_Multiply(System.Single, Electron2D.Vector2)(System.Single scalar, Electron2D.Vector2 value)Applies the * operator.
This operator returns a value derived from the supplied operands.
-
scalar: The scalar value. -
value: The value to use.
The result of the operator.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public static Electron2D.Vector2 op_Subtraction(Electron2D.Vector2, Electron2D.Vector2)(Electron2D.Vector2 left, Electron2D.Vector2 right)Applies the - operator.
This operator returns a value derived from the supplied operands.
-
left: The left value. -
right: The right value.
The result of the operator.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Kind: Method
public static Electron2D.Vector2 op_UnaryNegation(Electron2D.Vector2)(Electron2D.Vector2 value)Applies the - operator.
This operator returns a value derived from the supplied operands.
-
value: The value to use.
The result of the operator.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.Vector2
Electron2D 0.1.0 Preview API reference. Generated from 175 public runtime types.