pygame: src/doc/math_doc.h annotate

annotate src/doc/math_doc.h @ 3172:d1b367fc08bc tests-returncode

Use a return code of 1 when the tests fail.

author	Thomas Kluyver <takowl@gmail.com>
date	Wed, 09 Jan 2013 10:13:57 +0000
parents	da4302429d3b
children

rev	line source
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	1 /* Auto generated file: with makeref.py . Docs go in src/ .doc . /
04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	2 #define DOC_PYGAMEMATH "pygame module for vector classes"
04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	3
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	4 #define DOC_PYGAMEMATHENABLESWIZZLING "enable_swizzling() -> None\nglobally enables swizzling for vectors."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	5
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	6 #define DOC_PYGAMEMATHDISABLESWIZZLING "disable_swizzling() -> None\nglobally disables swizzling for vectors."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	7
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	8 #define DOC_PYGAMEMATHVECTOR2 "Vector2() -> Vector2\nVector2(Vector2) -> Vector2\nVector2(x, y) -> Vector2\nVector2((x, y)) -> Vector2\na 2-Dimensional Vector"
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	9
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	10 #define DOC_VECTOR2DOT "dot(Vector2) -> float\ncalculates the dot- or scalar-product with the other vector"
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	11
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	12 #define DOC_VECTOR2CROSS "cross(Vector2) -> float\ncalculates the cross- or vector-product"
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	13
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	14 #define DOC_VECTOR2LENGTH "length() -> float\nreturns the euclidic length of the vector."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	15
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	16 #define DOC_VECTOR2LENGTHSQUARED "length_squared() -> float\nreturns the squared euclidic length of the vector."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	17
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	18 #define DOC_VECTOR2NORMALIZE "normalize() -> Vector2\nreturns a vector with the same direction but length 1."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	19
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	20 #define DOC_VECTOR2NORMALIZEIP "normalize_ip() -> None\nnormalizes the vector in place so that its length is 1."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	21
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	22 #define DOC_VECTOR2ISNORMALIZED "is_normalized() -> Bool\ntests if the vector is normalized i.e. has length == 1."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	23
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	24 #define DOC_VECTOR2SCALETOLENGTH "scale_to_length(float) -> None\nscales the vector to a given length."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	25
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	26 #define DOC_VECTOR2REFLECT "reflect(Vector2) -> Vector2\nreturns a vector reflected of a given normal."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	27
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	28 #define DOC_VECTOR2REFLECTIP "reflect_ip(Vector2) -> None\nreflect the vector of a given normal in place."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	29
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	30 #define DOC_VECTOR2DISTANCETO "distance_to(Vector2) -> float\ncalculates the euclidic distance to a given vector."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	31
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	32 #define DOC_VECTOR2DISTANCESQUAREDTO "distance_squared_to(Vector2) -> float\ncalculates the squared euclidic distance to a given vector."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	33
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	34 #define DOC_VECTOR2LERP "lerp(Vector2, float) -> Vector2\nreturns a linear interpolation to the given vector."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	35
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	36 #define DOC_VECTOR2SLERP "slerp(Vector2, float) -> Vector2\nreturns a spherical interpolation to the given vector."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	37
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	38 #define DOC_VECTOR2ELEMENTWISE "elementwise() -> VectorElementwizeProxy\nThe next operation will be performed elementwize."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	39
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	40 #define DOC_VECTOR2ROTATE "rotate(float) -> Vector2\nrotates a vector by a given angle in degrees."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	41
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	42 #define DOC_VECTOR2ROTATEIP "rotate_ip(float) -> None\nrotates the vector by a given angle in degrees in place."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	43
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	44 #define DOC_VECTOR2ANGLETO "angle_to(Vector2) -> float\ncalculates the angle to a given vector in degrees."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	45
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	46 #define DOC_VECTOR2ASPOLAR "as_polar() -> (r, phi)\nreturns a tuple with radial distance and azimuthal angle."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	47
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	48 #define DOC_VECTOR2FROMPOLAR "from_polar((r, phi)) -> None\nSets x and y from a polar coordinates tuple."
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	49
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	50 #define DOC_PYGAMEMATHVECTOR3 "Vector3() -> Vector3\nVector3(Vector3) -> Vector3\nVector3(x, y, z) -> Vector3\nVector3((x, y, z)) -> Vector3\na 3-Dimensional Vector"
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	51
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	52 #define DOC_VECTOR3DOT "dot(Vector3) -> float\ncalculates the dot- or scalar-product with the other vector"
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	53
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	54 #define DOC_VECTOR3CROSS "cross(Vector3) -> float\ncalculates the cross- or vector-product"
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	55
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	56 #define DOC_VECTOR3LENGTH "length() -> float\nreturns the euclidic length of the vector."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	57
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	58 #define DOC_VECTOR3LENGTHSQUARED "length_squared() -> float\nreturns the squared euclidic length of the vector."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	59
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	60 #define DOC_VECTOR3NORMALIZE "normalize() -> Vector3\nreturns a vector with the same direction but length 1."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	61
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	62 #define DOC_VECTOR3NORMALIZEIP "normalize_ip() -> None\nnormalizes the vector in place so that its length is 1."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	63
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	64 #define DOC_VECTOR3ISNORMALIZED "is_normalized() -> Bool\ntests if the vector is normalized i.e. has length == 1."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	65
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	66 #define DOC_VECTOR3SCALETOLENGTH "scale_to_length(float) -> None\nscales the vector to a given length."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	67
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	68 #define DOC_VECTOR3REFLECT "reflect(Vector3) -> Vector3\nreturns a vector reflected of a given normal."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	69
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	70 #define DOC_VECTOR3REFLECTIP "reflect_ip(Vector3) -> None\nreflect the vector of a given normal in place."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	71
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	72 #define DOC_VECTOR3DISTANCETO "distance_to(Vector3) -> float\ncalculates the euclidic distance to a given vector."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	73
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	74 #define DOC_VECTOR3DISTANCESQUAREDTO "distance_squared_to(Vector3) -> float\ncalculates the squared euclidic distance to a given vector."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	75
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	76 #define DOC_VECTOR3LERP "lerp(Vector3, float) -> Vector3\nreturns a linear interpolation to the given vector."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	77
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	78 #define DOC_VECTOR3SLERP "slerp(Vector3, float) -> Vector3\nreturns a spherical interpolation to the given vector."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	79
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	80 #define DOC_VECTOR3ELEMENTWISE "elementwise() -> VectorElementwizeProxy\nThe next operation will be performed elementwize."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	81
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	82 #define DOC_VECTOR3ROTATE "rotate(Vector3, float) -> Vector3\nrotates a vector by a given angle in degrees."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	83
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	84 #define DOC_VECTOR3ROTATEIP "rotate_ip(Vector3, float) -> None\nrotates the vector by a given angle in degrees in place."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	85
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	86 #define DOC_VECTOR3ROTATEX "rotate_x(float) -> Vector3\nrotates a vector around the x-axis by the angle in degrees."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	87
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	88 #define DOC_VECTOR3ROTATEXIP "rotate_x_ip(float) -> None\nrotates the vector around the x-axis by the angle in degrees in place."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	89
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	90 #define DOC_VECTOR3ROTATEY "rotate_y(float) -> Vector3\nrotates a vector around the y-axis by the angle in degrees."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	91
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	92 #define DOC_VECTOR3ROTATEYIP "rotate_y_ip(float) -> None\nrotates the vector around the y-axis by the angle in degrees in place."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	93
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	94 #define DOC_VECTOR3ROTATEZ "rotate_z(float) -> Vector3\nrotates a vector around the z-axis by the angle in degrees."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	95
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	96 #define DOC_VECTOR3ROTATEZIP "rotate_z_ip(float) -> None\nrotates the vector around the z-axis by the angle in degrees in place."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	97
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	98 #define DOC_VECTOR3ANGLETO "angle_to(Vector3) -> float\ncalculates the angle to a given vector in degrees."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	99
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	100 #define DOC_VECTOR3ASSPHERICAL "as_spherical() -> (r, theta, phi)\nreturns a tuple with radial distance, inclination and azimuthal angle."
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	101
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	102 #define DOC_VECTOR3FROMSPHERICAL "from_spherical((r, theta, phi)) -> None\nSets x, y and z from a spherical coordinates 3-tuple."
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	103
04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	104
04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	105
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	106 /* Docs in a comment... slightly easier to read. */
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	107
04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	108 /*
04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	109
04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	110 pygame.math
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	111 pygame module for vector classes
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	112
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	113 pygame.math.enable_swizzling
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	114 enable_swizzling() -> None
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	115 globally enables swizzling for vectors.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	116
2166 b206b62b875a Run makeref.py on doc changes Lenard Lindstrom <len-l@telus.net> parents: 2131 diff changeset	117 pygame.math.disable_swizzling
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	118 disable_swizzling() -> None
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	119 globally disables swizzling for vectors.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	120
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	121 pygame.math.Vector2
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	122 Vector2() -> Vector2
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	123 Vector2(Vector2) -> Vector2
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	124 Vector2(x, y) -> Vector2
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	125 Vector2((x, y)) -> Vector2
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	126 a 2-Dimensional Vector
04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	127
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	128 pygame.math.Vector2.dot
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	129 dot(Vector2) -> float
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	130 calculates the dot- or scalar-product with the other vector
04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	131
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	132 pygame.math.Vector2.cross
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	133 cross(Vector2) -> float
1996 04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	134 calculates the cross- or vector-product
04461b5e6bb9 added missing documentation files from the math module lorenz parents: diff changeset	135
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	136 pygame.math.Vector2.length
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	137 length() -> float
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	138 returns the euclidic length of the vector.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	139
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	140 pygame.math.Vector2.length_squared
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	141 length_squared() -> float
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	142 returns the squared euclidic length of the vector.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	143
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	144 pygame.math.Vector2.normalize
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	145 normalize() -> Vector2
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	146 returns a vector with the same direction but length 1.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	147
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	148 pygame.math.Vector2.normalize_ip
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	149 normalize_ip() -> None
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	150 normalizes the vector in place so that its length is 1.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	151
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	152 pygame.math.Vector2.is_normalized
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	153 is_normalized() -> Bool
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	154 tests if the vector is normalized i.e. has length == 1.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	155
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	156 pygame.math.Vector2.scale_to_length
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	157 scale_to_length(float) -> None
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	158 scales the vector to a given length.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	159
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	160 pygame.math.Vector2.reflect
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	161 reflect(Vector2) -> Vector2
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	162 returns a vector reflected of a given normal.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	163
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	164 pygame.math.Vector2.reflect_ip
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	165 reflect_ip(Vector2) -> None
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	166 reflect the vector of a given normal in place.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	167
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	168 pygame.math.Vector2.distance_to
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	169 distance_to(Vector2) -> float
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	170 calculates the euclidic distance to a given vector.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	171
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	172 pygame.math.Vector2.distance_squared_to
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	173 distance_squared_to(Vector2) -> float
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	174 calculates the squared euclidic distance to a given vector.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	175
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	176 pygame.math.Vector2.lerp
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	177 lerp(Vector2, float) -> Vector2
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	178 returns a linear interpolation to the given vector.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	179
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	180 pygame.math.Vector2.slerp
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	181 slerp(Vector2, float) -> Vector2
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	182 returns a spherical interpolation to the given vector.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	183
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	184 pygame.math.Vector2.elementwise
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	185 elementwise() -> VectorElementwizeProxy
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	186 The next operation will be performed elementwize.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	187
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	188 pygame.math.Vector2.rotate
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	189 rotate(float) -> Vector2
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	190 rotates a vector by a given angle in degrees.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	191
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	192 pygame.math.Vector2.rotate_ip
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	193 rotate_ip(float) -> None
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	194 rotates the vector by a given angle in degrees in place.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	195
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	196 pygame.math.Vector2.angle_to
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	197 angle_to(Vector2) -> float
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	198 calculates the angle to a given vector in degrees.
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	199
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	200 pygame.math.Vector2.as_polar
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	201 as_polar() -> (r, phi)
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	202 returns a tuple with radial distance and azimuthal angle.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	203
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	204 pygame.math.Vector2.from_polar
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	205 from_polar((r, phi)) -> None
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	206 Sets x and y from a polar coordinates tuple.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	207
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	208 pygame.math.Vector3
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	209 Vector3() -> Vector3
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	210 Vector3(Vector3) -> Vector3
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	211 Vector3(x, y, z) -> Vector3
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	212 Vector3((x, y, z)) -> Vector3
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	213 a 3-Dimensional Vector
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	214
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	215 pygame.math.Vector3.dot
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	216 dot(Vector3) -> float
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	217 calculates the dot- or scalar-product with the other vector
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	218
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	219 pygame.math.Vector3.cross
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	220 cross(Vector3) -> float
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	221 calculates the cross- or vector-product
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	222
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	223 pygame.math.Vector3.length
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	224 length() -> float
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	225 returns the euclidic length of the vector.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	226
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	227 pygame.math.Vector3.length_squared
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	228 length_squared() -> float
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	229 returns the squared euclidic length of the vector.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	230
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	231 pygame.math.Vector3.normalize
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	232 normalize() -> Vector3
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	233 returns a vector with the same direction but length 1.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	234
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	235 pygame.math.Vector3.normalize_ip
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	236 normalize_ip() -> None
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	237 normalizes the vector in place so that its length is 1.
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	238
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	239 pygame.math.Vector3.is_normalized
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	240 is_normalized() -> Bool
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	241 tests if the vector is normalized i.e. has length == 1.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	242
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	243 pygame.math.Vector3.scale_to_length
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	244 scale_to_length(float) -> None
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	245 scales the vector to a given length.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	246
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	247 pygame.math.Vector3.reflect
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	248 reflect(Vector3) -> Vector3
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	249 returns a vector reflected of a given normal.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	250
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	251 pygame.math.Vector3.reflect_ip
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	252 reflect_ip(Vector3) -> None
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	253 reflect the vector of a given normal in place.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	254
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	255 pygame.math.Vector3.distance_to
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	256 distance_to(Vector3) -> float
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	257 calculates the euclidic distance to a given vector.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	258
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	259 pygame.math.Vector3.distance_squared_to
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	260 distance_squared_to(Vector3) -> float
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	261 calculates the squared euclidic distance to a given vector.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	262
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	263 pygame.math.Vector3.lerp
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	264 lerp(Vector3, float) -> Vector3
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	265 returns a linear interpolation to the given vector.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	266
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	267 pygame.math.Vector3.slerp
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	268 slerp(Vector3, float) -> Vector3
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	269 returns a spherical interpolation to the given vector.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	270
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	271 pygame.math.Vector3.elementwise
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	272 elementwise() -> VectorElementwizeProxy
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	273 The next operation will be performed elementwize.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	274
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	275 pygame.math.Vector3.rotate
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	276 rotate(Vector3, float) -> Vector3
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	277 rotates a vector by a given angle in degrees.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	278
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	279 pygame.math.Vector3.rotate_ip
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	280 rotate_ip(Vector3, float) -> None
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	281 rotates the vector by a given angle in degrees in place.
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	282
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	283 pygame.math.Vector3.rotate_x
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	284 rotate_x(float) -> Vector3
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	285 rotates a vector around the x-axis by the angle in degrees.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	286
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	287 pygame.math.Vector3.rotate_x_ip
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	288 rotate_x_ip(float) -> None
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	289 rotates the vector around the x-axis by the angle in degrees in place.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	290
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	291 pygame.math.Vector3.rotate_y
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	292 rotate_y(float) -> Vector3
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	293 rotates a vector around the y-axis by the angle in degrees.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	294
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	295 pygame.math.Vector3.rotate_y_ip
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	296 rotate_y_ip(float) -> None
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	297 rotates the vector around the y-axis by the angle in degrees in place.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	298
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	299 pygame.math.Vector3.rotate_z
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	300 rotate_z(float) -> Vector3
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	301 rotates a vector around the z-axis by the angle in degrees.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	302
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	303 pygame.math.Vector3.rotate_z_ip
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	304 rotate_z_ip(float) -> None
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	305 rotates the vector around the z-axis by the angle in degrees in place.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	306
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	307 pygame.math.Vector3.angle_to
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	308 angle_to(Vector3) -> float
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	309 calculates the angle to a given vector in degrees.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	310
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	311 pygame.math.Vector3.as_spherical
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	312 as_spherical() -> (r, theta, phi)
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	313 returns a tuple with radial distance, inclination and azimuthal angle.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	314
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	315 pygame.math.Vector3.from_spherical
da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	316 from_spherical((r, theta, phi)) -> None
2004 8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	317 Sets x, y and z from a spherical coordinates 3-tuple.
8c57b44e60a8 some more Py3k fixes. compiles but test don't pass yet. lorenz parents: 1996 diff changeset	318
2198 da4302429d3b replace makeref.py generated documents with makeref2.py documents Lenard Lindstrom <len-l@telus.net> parents: 2166 diff changeset	319 */

Mercurial > pygame

annotate src/doc/math_doc.h @ 3172:d1b367fc08bc tests-returncode