dot_product

Returns the dot_product of the vectors x1,y1 and x2,y2.


Syntax:

GML Code Example

dot_product(x1, y1, x2, y2)


Argument Description
x1 The x coordinate of the first vector.
y1 The y coordinate of the first vector.
x2 The x coordinate of the second vector.
y2 The y coordinate of the second vector.


Returns: Real


Description

The dot product is a value expressing the angular relationship between two vectors and is found by taking two vectors, multiplying them together and then adding the results. The name "dot product" is derived from the centered dot "·" that is often used to designate this operation (the alternative name "scalar product" emphasizes the scalar rather than vector nature of the result).

The actual mathematical formula can be written like this:


So, in 2D the dot product of vectors a[x1,y1] and b[x2,2] is x1x2 + y1y2, meaning that the dot_product in GameMaker: Studio is calculated as:

GML Code Example

a · b = (x1*x2)+(y1*y2);
 

The curious thing about the dot product is the relationship it has to the angle formed by the input vectors which can be expressed as:

GML Code Example

a · b = (length of a) * (length of b) * cos(angle)

That is to say, the dot product of two vectors will be equal to the cosine of the angle between those vectors, multiplied by the lengths of each of them. Here is an image to illustrate:

There are a few things that we can now state from any two vectors in relation to the result of their dot product:

  • If a and b are perpendicular (at 90 degrees to each other), the result of the dot product will be zero, because cos(ang) will be zero
  • If the angle between a and b are less than 90 degrees, the dot product will be positive (greater than zero), as cos(ang) will be positive
  • If the angle between a and b are greater than 90 degrees, the dot product will be negative (less than zero), as cos(ang) will be negative

So what does this mean for those of us that make games? Well, this mathematical relationship can be used in quite a few circumstances, but the best way to see it is to build an actual scenario and see for yourself what is going on. One of the simplest ways to do this is to generate a simple "line of sight" check for an enemy in, say, a platform game so that the enemy will "see" the player if they are within 90� of either side of their vector normal.

Basically, we have to get the vector normal from the enemy (ie: comprised of a direction and sight distance) and then we need to get the vector of the player to the enemy. We will then get the dot_product of these vectors, and if the result is positive the player has been seen, and if it is negative he hasn't. The actual code to get this working is supplied in the example below.


Example:

GML Code Example

var x1, y1, x2, y2;
 x1 = lengthdir_x(1, image_angle);
 y1 = lengthdir_y(1, image_angle);
 x2 = o_Player.x - x;
 y2 = o_Player.y - y;
 if dot_product(x1, y1, x2, y2) > 0 seen=true else seen=false;
 

The above code creates a vector using the instances image angle, and then gets the vector of the player object "o_Player" to itself. Finally it calculates the dot product of these two vectors and if it is greater than 0 it sets the variable "seen" to true, and if it is equal to or less than 0 it sets it to "false".





No Examples Submitted

Does this page need better examples? Be the first to Submit

No Edits Suggested

Is this page unclear or not descriptive enough? Suggest an edit to the page and with enough upvotes your changes will be made.

No Questions Have Been Ask

Do you have a question about this page? Ask it Here