For special keys, one of OF_KEY_* (.

See Also

ofConstants.h). For all other keys, the Unicode code point you'd expect if this key combo (including modifier keys that may be down) was pressed in a text editor (same as codepoint).

The keycode returned by the windowing system, independent of any modifier keys or keyboard layout settings. For ofAppGLFWWindow this value is one of GLFW_KEY_* (.

See Also

glfw3.h) - typically, ASCII representation of the symbol on the physical key, so A key always returns 0x41 even if shift, alt, ctrl are down.

The raw scan code returned by the keyboard, OS and hardware specific.

The Unicode code point you'd expect if this key combo (including modifier keys) was pressed in a text editor, or -1 for non-printable characters.

Returns a pointer to the memory position of the first element of the vector (x); the second element (y) immediately follows it in memory.

This is very useful when using arrays of ofVec2fs to store geometry information, as it allows the vector to be treated as a simple C array of floats that can be passed verbatim to OpenGL.

Allows to access the x and y components of an ofVec2f as though it is an array.

This function can be handy if you want to do the same operation to both x and y components, as it means you can just make a for loop that repeats twice.

Set x and y components of this vector with just one function call.

Set the x and y components of this vector by copying the corresponding values from vec.

Check for equality between two ofVec2f.

Returns

true if each component is the same as the corresponding component in vec, ie if x == vec.x and y == vec.y; otherwise returns false.

Check for inequality between two ofVec2f.

Returns

true if any component is different to its corresponding component in vec, ie if 'x != vec.x' or 'y != vec.y', otherwise returns false.

Returns true if each component is close enough to its corresponding component in vec, where what is close enough is determined by the value of tolerance:

This is handy if, for example, you want to find out when a point becomes close enough to another point to trigger an event.

Determine if two vectors are aligned.

Parameters

vec	The vector to compare alignment with
tolerance	an angle tolerance/threshold (specified in degrees) for deciding if the vectors are sufficiently aligned.

Returns

true if both vectors are aligned (pointing in the same direction).

Determine if two vectors are aligned with tolerance in radians.

Parameters

vec	The vector to compare alignment with
tolerance	an angle tolerance/threshold (specified in radians) for deciding if the vectors are sufficiently aligned.

See Also

isAligned()

Determine if two vectors are aligned.

Parameters

vec	The vector to compare alignment with
tolerance	an angle tolerance/threshold (specified in degrees) for deciding if the vectors are sufficiently aligned.

Returns

true if both vectors are aligned (pointing in the same direction).

Determine if two vectors are aligned with tolerance in radians.

Parameters

vec	The vector to compare alignment with
tolerance	an angle tolerance/threshold (specified in radians) for deciding if the vectors are sufficiently aligned.

See Also

align()

Super easy vector addition. Returns a new vector (x+vec.x,y+vec.y).

Returns a new vector with a float value f added to both x and y members.

Super easy addition assignment. Adds vec.x to x, and adds vec.y to y.

Adds a float value f to both x and y members.

Super easy vector subtraction. Returns a new vector (x-vec.x,y-vec.y).

Returns a new vector with a float value f subtracted from both x and y members.

Returns a new ofVec2f that is the inverted version (mirrored in X and Y) of this vector.

Super easy subtraction assignment. Subtracts vec.x from x, and subtracts vec.y from y.

Subtract a float value f from both x and y members.

Returns a new vector (x*vec.x , y*vec.y).

Useful for scaling a 2D point by a non-uniform scale.

Return a new ofVec2f that is this vector scaled by multiplying both x and y members by the float.

Multiplies x by vec.x, and multiplies y by vec.y.

Useful for scaling a 2D point by a non-uniform scale.

Scale this vector by multiplying both x and y members by f.

Returns a new vector (x/vec.x,y/vec.y).

Useful for scaling a 2D point by a non-uniform scale.

Return a new ofVec2f that is this vector scaled by dividing both x and y members by f.

Divides x by vec.x, and divides y by vec.y.

Useful for scaling a 2D point by a non-uniform scale.

Scale this vector by dividing both x and y members by f.

Return a new ofVec2f that is the result of scaling this vector up or down so that it has the requested length.

~~~~{.cpp} ofVec2f v1( 3, 4 ); // length is 5 ofVec2f v2 = v1.getScaled( 15 ); // ( 9, 12 ), length is now 15 ~~~~ofVec2f

See Also

scale()

Scales this vector up or down so that it has the requested length.

See Also

getScaled()

Return a new ofVec2f that is the result of rotating this vector by angle degrees around the origin.

See Also

getRotatedRad()

rotate()

Like getRotated() but rotates around pivot rather than around the origin.

Return a new ofVec2f that is the result of rotating this vector by angle radians around the origin.

Like getRotatedRad() but rotates around pivot rather than around the origin.

Rotate this vector by angle degrees around the origin.

See Also

getRotated()

Like rotate() but rotates around pivot rather than around the origin.

Rotate this vector by angle radians around the origin.

See Also

getRotatedRad()

Like rotateRad() but rotates around pivot rather than around the origin.

Get vector mapped to new coordinate system.

In most cases you want vx and vy to be perpendicular and of unit length; if they are not perpendicular you will have shearing as part of the mapping, and if they are not of unit length you will have scaling as part of the mapping.

Returns

A new ofVec2f calculated by copying this vector and then mapping from its default coordinate system – origin (0,0), X direction (1,0), Y direction (0,1) – to a new coordinate system defined with origin at origin, X direction vx, and Y direction vy.

Maps this vector from its default coordinate system – origin (0,0), X direction (1,0), Y direction (0,1) – to a new coordinate system defined with origin at origin, X direction vx, and Y direction vy.

In most case you want vx and vy to be perpendicular and of unit length; if they are not perpendicular you will have shearing as part of the mapping, and if they are not of unit length you will have scaling as part of the mapping.

See Also

perpendicular()

Distance between two points.

Treats both this vector and pnt as points in 2D space, and calculates and returns the distance between them.

Distance involves a square root calculation, which is one of the slowest things you can do in programming. If you don't need an exact number but rather just a rough idea of distance (for example when finding the shortest distance of a bunch of points to a reference point, where it doesn't matter exactly what the distances are, you just want the shortest), you can use squareDistance() instead.

Parameters

pnt	The point to calculate the distance to

Returns

The distance as float

See Also

squareDistance()

Distance between two points squared.

Treats both this vector and pnt as points in 2D space, and calculates and returns the squared distance between them.

Use as a much faster alternative to distance if you don't need to know an exact number but rather just a rough idea of distance (for example when finding the shortest distance of a bunch of points to a reference point, where it doesn't matter exactly what the distances are, you just want the shortest). It avoids the square root calculation that is ordinarily required to calculate a length.

Returns

The distance squared as float

See Also

distance()

Linear interpolation.

Perform a linear interpolation of this vector's position towards pnt and return the interpolated position without altering the original vector.

p is normally between 0 and 1 and where 0 means stay the original position and 1 means move all the way to pnt, but you can also have p greater than 1 overshoot pnt, or less than 0 to move backwards away from pnt.

Parameters

pnt	The point to move towards
p	The amount to move towards pnt

See Also

interpolate()

Linear interpolation.

Perform a linear interpolation of this vector's position towards pnt. p controls the amount to move towards pnt. p is normally between 0 and 1 and where 0 means stay the original position and 1 means move all the way to pnt, but you can also have p greater than 1 overshoot pnt, or less than 0 to move backwards away from pnt.

See Also

getInterpolated()

Calculate and return the midpoint between this vector and pnt.

Parameters

pnt	The vector to find the middle to

Returns

The middle between this vector and pnt

See Also

middle()

Set this vector to the midpoint between itself and pnt.

See Also

getMiddle()

Average vector over an array of points.

Sets this vector to be the average (centre of gravity or centroid) of a given array of ofVec2f.

Parameters

points	The array of ofVec2f to avarage over
num	specifies the number of ofVec2f in the array.

Returns

Vector that is the avarage of the points in the array

Returns a normalized copy of this vector.

Normalization means to scale the vector so that its length (magnitude) is exactly 1, at which stage all that is left is the direction. A normalized vector is usually called a unit vector, and can be used to represent a pure direction (heading).

Normalize the vector.

Normalizing means to scale the vector so that its length (magnitude) is exactly 1, at which stage all that is left is the direction. A normalized vector is usually called a unit vector, and can be used to represent a pure direction (heading).

See Also

getNormalized()

Get vector limited by length.

See Also

limit()

Parameters

max	The maximum length of the vector to return

Returns

A copy of this vector with its length (magnitude) restricted to a maximum of max units by scaling down if necessary.

Restrict the length (magnitude) of this vector to a maximum of max units by scaling down if necessary.

See Also

limit()

Return the length (magnitude) of this vector.

length() involves a square root calculation, which is one of the slowest things you can do in programming. If you don't need an exact number but rather just a rough idea of a length (for example when finding the shortest distance of a bunch of points to a reference point, where it doesn't matter exactly what the lengths are, you just want the shortest), you can use lengthSquared() instead.

See Also

lengthSquared()

Return the squared length (squared magnitude) of this vector.

Use as a much faster alternative to length() if you don't need to know an accurate length but rather just a rough idea of a length (for example when finding the shortest distance of a bunch of points to a reference point, where it doesn't matter exactly what the lengths are, you just want the shortest). It avoids the square root calculation that is ordinarily required to calculate a length.

See Also

length()

Calculate the angle to another vector in degrees.

Parameters

vec	The vector to calculate the angle to

Returns

The angle in degrees (-180...180)

Calculate the angle to another vector in radians.

Parameters

vec	The vector to calculate the angle to

Returns

The angle in radians (-PI...PI)

Return the normalized ofVec2f that is perpendicular to this vector (ie rotated 90 degrees and normalized).

Image courtesy of Wikipedia

See Also

perpendicular()

Set this vector to its own normalized perpendicular (by rotating 90 degrees and normalizing).

Image courtesy of Wikipedia

See Also

getPerpendicular()

Calculate and return the dot product of this vector with vec.

Dot product (less commonly known as Euclidean inner product) expresses the angular relationship between two vectors. In other words it is a measure of how parallel two vectors are. If they are completely perpendicular the dot product is 0; if they are completely parallel their dot product is either 1 if they are pointing in the same direction, or -1 if they are pointing in opposite directions.

Image courtesy of Wikipedia

Parameters

vec	The vector to dotproduct

Stores the x component of the vector.

Stores the y component of the vector.

Returns a pointer to the memory position of the first element of the vector (x); the second element (y) immediately follows it in memory.

This is very useful when using arrays of ofVec2fs to store geometry information, as it allows the vector to be treated as a simple C array of floats that can be passed verbatim to OpenGL.

Allows to access the x and y components of an ofVec2f as though it is an array.

This function can be handy if you want to do the same operation to both x and y components, as it means you can just make a for loop that repeats twice.

Set x and y components of this vector with just one function call.

Set the x and y components of this vector by copying the corresponding values from vec.

Check for equality between two ofVec2f.

Returns

true if each component is the same as the corresponding component in vec, ie if x == vec.x and y == vec.y; otherwise returns false.

Check for inequality between two ofVec2f.

Returns

true if any component is different to its corresponding component in vec, ie if 'x != vec.x' or 'y != vec.y', otherwise returns false.

Returns true if each component is close enough to its corresponding component in vec, where what is close enough is determined by the value of tolerance:

This is handy if, for example, you want to find out when a point becomes close enough to another point to trigger an event.

Determine if two vectors are aligned.

Parameters

vec	The vector to compare alignment with
tolerance	an angle tolerance/threshold (specified in degrees) for deciding if the vectors are sufficiently aligned.

Returns

true if both vectors are aligned (pointing in the same direction).

Determine if two vectors are aligned with tolerance in radians.

Parameters

vec	The vector to compare alignment with
tolerance	an angle tolerance/threshold (specified in radians) for deciding if the vectors are sufficiently aligned.

See Also

isAligned()

Determine if two vectors are aligned.

Parameters

vec	The vector to compare alignment with
tolerance	an angle tolerance/threshold (specified in degrees) for deciding if the vectors are sufficiently aligned.

Returns

true if both vectors are aligned (pointing in the same direction).

Determine if two vectors are aligned with tolerance in radians.

Parameters

vec	The vector to compare alignment with
tolerance	an angle tolerance/threshold (specified in radians) for deciding if the vectors are sufficiently aligned.

See Also

align()

Super easy vector addition. Returns a new vector (x+vec.x,y+vec.y).

Returns a new vector with a float value f added to both x and y members.

Super easy addition assignment. Adds vec.x to x, and adds vec.y to y.

Adds a float value f to both x and y members.

Super easy vector subtraction. Returns a new vector (x-vec.x,y-vec.y).

Returns a new vector with a float value f subtracted from both x and y members.

Returns a new ofVec2f that is the inverted version (mirrored in X and Y) of this vector.

Super easy subtraction assignment. Subtracts vec.x from x, and subtracts vec.y from y.

Subtract a float value f from both x and y members.

Returns a new vector (x*vec.x , y*vec.y).

Useful for scaling a 2D point by a non-uniform scale.

Return a new ofVec2f that is this vector scaled by multiplying both x and y members by the float.

Multiplies x by vec.x, and multiplies y by vec.y.

Useful for scaling a 2D point by a non-uniform scale.

Scale this vector by multiplying both x and y members by f.

Returns a new vector (x/vec.x,y/vec.y).

Useful for scaling a 2D point by a non-uniform scale.

Return a new ofVec2f that is this vector scaled by dividing both x and y members by f.

Divides x by vec.x, and divides y by vec.y.

Useful for scaling a 2D point by a non-uniform scale.

Scale this vector by dividing both x and y members by f.

Return a new ofVec2f that is the result of scaling this vector up or down so that it has the requested length.

~~~~{.cpp} ofVec2f v1( 3, 4 ); // length is 5 ofVec2f v2 = v1.getScaled( 15 ); // ( 9, 12 ), length is now 15 ~~~~ofVec2f

See Also

scale()

Scales this vector up or down so that it has the requested length.

See Also

getScaled()

Return a new ofVec2f that is the result of rotating this vector by angle degrees around the origin.

See Also

getRotatedRad()

rotate()

Like getRotated() but rotates around pivot rather than around the origin.

Return a new ofVec2f that is the result of rotating this vector by angle radians around the origin.

Like getRotatedRad() but rotates around pivot rather than around the origin.

Rotate this vector by angle degrees around the origin.

See Also

getRotated()

Like rotate() but rotates around pivot rather than around the origin.

Rotate this vector by angle radians around the origin.

See Also

getRotatedRad()

Like rotateRad() but rotates around pivot rather than around the origin.

Get vector mapped to new coordinate system.

In most cases you want vx and vy to be perpendicular and of unit length; if they are not perpendicular you will have shearing as part of the mapping, and if they are not of unit length you will have scaling as part of the mapping.

Returns

A new ofVec2f calculated by copying this vector and then mapping from its default coordinate system – origin (0,0), X direction (1,0), Y direction (0,1) – to a new coordinate system defined with origin at origin, X direction vx, and Y direction vy.

Maps this vector from its default coordinate system – origin (0,0), X direction (1,0), Y direction (0,1) – to a new coordinate system defined with origin at origin, X direction vx, and Y direction vy.

In most case you want vx and vy to be perpendicular and of unit length; if they are not perpendicular you will have shearing as part of the mapping, and if they are not of unit length you will have scaling as part of the mapping.

See Also

perpendicular()

Distance between two points.

Treats both this vector and pnt as points in 2D space, and calculates and returns the distance between them.

Distance involves a square root calculation, which is one of the slowest things you can do in programming. If you don't need an exact number but rather just a rough idea of distance (for example when finding the shortest distance of a bunch of points to a reference point, where it doesn't matter exactly what the distances are, you just want the shortest), you can use squareDistance() instead.

Parameters

pnt	The point to calculate the distance to

Returns

The distance as float

See Also

squareDistance()

Distance between two points squared.

Treats both this vector and pnt as points in 2D space, and calculates and returns the squared distance between them.

Use as a much faster alternative to distance if you don't need to know an exact number but rather just a rough idea of distance (for example when finding the shortest distance of a bunch of points to a reference point, where it doesn't matter exactly what the distances are, you just want the shortest). It avoids the square root calculation that is ordinarily required to calculate a length.

Returns

The distance squared as float

See Also

distance()

Linear interpolation.

Perform a linear interpolation of this vector's position towards pnt and return the interpolated position without altering the original vector.

p is normally between 0 and 1 and where 0 means stay the original position and 1 means move all the way to pnt, but you can also have p greater than 1 overshoot pnt, or less than 0 to move backwards away from pnt.

Parameters

pnt	The point to move towards
p	The amount to move towards pnt

See Also

interpolate()

Linear interpolation.

Perform a linear interpolation of this vector's position towards pnt. p controls the amount to move towards pnt. p is normally between 0 and 1 and where 0 means stay the original position and 1 means move all the way to pnt, but you can also have p greater than 1 overshoot pnt, or less than 0 to move backwards away from pnt.

See Also

getInterpolated()

Calculate and return the midpoint between this vector and pnt.

Parameters

pnt	The vector to find the middle to

Returns

The middle between this vector and pnt

See Also

middle()

Set this vector to the midpoint between itself and pnt.

See Also

getMiddle()

Average vector over an array of points.

Sets this vector to be the average (centre of gravity or centroid) of a given array of ofVec2f.

Parameters

points	The array of ofVec2f to avarage over
num	specifies the number of ofVec2f in the array.

Returns

Vector that is the avarage of the points in the array

Returns a normalized copy of this vector.

Normalization means to scale the vector so that its length (magnitude) is exactly 1, at which stage all that is left is the direction. A normalized vector is usually called a unit vector, and can be used to represent a pure direction (heading).

Normalize the vector.

Normalizing means to scale the vector so that its length (magnitude) is exactly 1, at which stage all that is left is the direction. A normalized vector is usually called a unit vector, and can be used to represent a pure direction (heading).

See Also

getNormalized()

Get vector limited by length.

See Also

limit()

Parameters

max	The maximum length of the vector to return

Returns

A copy of this vector with its length (magnitude) restricted to a maximum of max units by scaling down if necessary.

Restrict the length (magnitude) of this vector to a maximum of max units by scaling down if necessary.

See Also

limit()

Return the length (magnitude) of this vector.

length() involves a square root calculation, which is one of the slowest things you can do in programming. If you don't need an exact number but rather just a rough idea of a length (for example when finding the shortest distance of a bunch of points to a reference point, where it doesn't matter exactly what the lengths are, you just want the shortest), you can use lengthSquared() instead.

See Also

lengthSquared()

Return the squared length (squared magnitude) of this vector.

Use as a much faster alternative to length() if you don't need to know an accurate length but rather just a rough idea of a length (for example when finding the shortest distance of a bunch of points to a reference point, where it doesn't matter exactly what the lengths are, you just want the shortest). It avoids the square root calculation that is ordinarily required to calculate a length.

See Also

length()

Calculate the angle to another vector in degrees.

Parameters

vec	The vector to calculate the angle to

Returns

The angle in degrees (-180...180)

Calculate the angle to another vector in radians.

Parameters

vec	The vector to calculate the angle to

Returns

The angle in radians (-PI...PI)

Return the normalized ofVec2f that is perpendicular to this vector (ie rotated 90 degrees and normalized).

Image courtesy of Wikipedia

See Also

perpendicular()

Set this vector to its own normalized perpendicular (by rotating 90 degrees and normalizing).

Image courtesy of Wikipedia

See Also

getPerpendicular()

Calculate and return the dot product of this vector with vec.

Dot product (less commonly known as Euclidean inner product) expresses the angular relationship between two vectors. In other words it is a measure of how parallel two vectors are. If they are completely perpendicular the dot product is 0; if they are completely parallel their dot product is either 1 if they are pointing in the same direction, or -1 if they are pointing in opposite directions.

Image courtesy of Wikipedia

Parameters

vec	The vector to dotproduct

Stores the x component of the vector.

Stores the y component of the vector.