1
/* Auto generated file: with makeref.py . Docs go in src/ *.doc . */
2
#define DOC_PYGAMEMATH "pygame module for vector classes"
4
#define DOC_PYGAMEMATHENABLESWIZZLING "enable_swizzling() -> None\nglobally enables swizzling for vectors."
6
#define DOC_PYGAMEMATHDISABLESWIZZLING "disable_swizzling() -> None\nglobally disables swizzling for vectors."
8
#define DOC_PYGAMEMATHVECTOR2 "Vector2() -> Vector2\nVector2(Vector2) -> Vector2\nVector2(x, y) -> Vector2\nVector2((x, y)) -> Vector2\na 2-Dimensional Vector"
10
#define DOC_VECTOR2DOT "dot(Vector2) -> float\ncalculates the dot- or scalar-product with the other vector"
12
#define DOC_VECTOR2CROSS "cross(Vector2) -> float\ncalculates the cross- or vector-product"
14
#define DOC_VECTOR2LENGTH "length() -> float\nreturns the euclidic length of the vector."
16
#define DOC_VECTOR2LENGTHSQUARED "length_squared() -> float\nreturns the squared euclidic length of the vector."
18
#define DOC_VECTOR2NORMALIZE "normalize() -> Vector2\nreturns a vector with the same direction but length 1."
20
#define DOC_VECTOR2NORMALIZEIP "normalize_ip() -> None\nnormalizes the vector in place so that its length is 1."
22
#define DOC_VECTOR2ISNORMALIZED "is_normalized() -> Bool\ntests if the vector is normalized i.e. has length == 1."
24
#define DOC_VECTOR2SCALETOLENGTH "scale_to_length(float) -> None\nscales the vector to a given length."
26
#define DOC_VECTOR2REFLECT "reflect(Vector2) -> Vector2\nreturns a vector reflected of a given normal."
28
#define DOC_VECTOR2REFLECTIP "reflect_ip(Vector2) -> None\nreflect the vector of a given normal in place."
30
#define DOC_VECTOR2DISTANCETO "distance_to(Vector2) -> float\ncalculates the euclidic distance to a given vector."
32
#define DOC_VECTOR2DISTANCESQUAREDTO "distance_squared_to(Vector2) -> float\ncalculates the squared euclidic distance to a given vector."
34
#define DOC_VECTOR2LERP "lerp(Vector2, float) -> Vector2\nreturns a linear interpolation to the given vector."
36
#define DOC_VECTOR2SLERP "slerp(Vector2, float) -> Vector2\nreturns a spherical interpolation to the given vector."
38
#define DOC_VECTOR2ELEMENTWISE "elementwise() -> VectorElementwizeProxy\nThe next operation will be performed elementwize."
40
#define DOC_VECTOR2ROTATE "rotate(float) -> Vector2\nrotates a vector by a given angle in degrees."
42
#define DOC_VECTOR2ROTATEIP "rotate_ip(float) -> None\nrotates the vector by a given angle in degrees in place."
44
#define DOC_VECTOR2ANGLETO "angle_to(Vector2) -> float\ncalculates the angle to a given vector in degrees."
46
#define DOC_VECTOR2ASPOLAR "as_polar() -> (r, phi)\nreturns a tuple with radial distance and azimuthal angle."
48
#define DOC_VECTOR2FROMPOLAR "from_polar((r, phi)) -> None\nSets x and y from a polar coordinates tuple."
50
#define DOC_PYGAMEMATHVECTOR3 "Vector3() -> Vector3\nVector3(Vector3) -> Vector3\nVector3(x, y, z) -> Vector3\nVector3((x, y, z)) -> Vector3\na 3-Dimensional Vector"
52
#define DOC_VECTOR3DOT "dot(Vector3) -> float\ncalculates the dot- or scalar-product with the other vector"
54
#define DOC_VECTOR3CROSS "cross(Vector3) -> float\ncalculates the cross- or vector-product"
56
#define DOC_VECTOR3LENGTH "length() -> float\nreturns the euclidic length of the vector."
58
#define DOC_VECTOR3LENGTHSQUARED "length_squared() -> float\nreturns the squared euclidic length of the vector."
60
#define DOC_VECTOR3NORMALIZE "normalize() -> Vector3\nreturns a vector with the same direction but length 1."
62
#define DOC_VECTOR3NORMALIZEIP "normalize_ip() -> None\nnormalizes the vector in place so that its length is 1."
64
#define DOC_VECTOR3ISNORMALIZED "is_normalized() -> Bool\ntests if the vector is normalized i.e. has length == 1."
66
#define DOC_VECTOR3SCALETOLENGTH "scale_to_length(float) -> None\nscales the vector to a given length."
68
#define DOC_VECTOR3REFLECT "reflect(Vector3) -> Vector3\nreturns a vector reflected of a given normal."
70
#define DOC_VECTOR3REFLECTIP "reflect_ip(Vector3) -> None\nreflect the vector of a given normal in place."
72
#define DOC_VECTOR3DISTANCETO "distance_to(Vector3) -> float\ncalculates the euclidic distance to a given vector."
74
#define DOC_VECTOR3DISTANCESQUAREDTO "distance_squared_to(Vector3) -> float\ncalculates the squared euclidic distance to a given vector."
76
#define DOC_VECTOR3LERP "lerp(Vector3, float) -> Vector3\nreturns a linear interpolation to the given vector."
78
#define DOC_VECTOR3SLERP "slerp(Vector3, float) -> Vector3\nreturns a spherical interpolation to the given vector."
80
#define DOC_VECTOR3ELEMENTWISE "elementwise() -> VectorElementwizeProxy\nThe next operation will be performed elementwize."
82
#define DOC_VECTOR3ROTATE "rotate(Vector3, float) -> Vector3\nrotates a vector by a given angle in degrees."
84
#define DOC_VECTOR3ROTATEIP "rotate_ip(Vector3, float) -> None\nrotates the vector by a given angle in degrees in place."
86
#define DOC_VECTOR3ROTATEX "rotate_x(float) -> Vector3\nrotates a vector around the x-axis by the angle in degrees."
88
#define DOC_VECTOR3ROTATEXIP "rotate_x_ip(float) -> None\nrotates the vector around the x-axis by the angle in degrees in place."
90
#define DOC_VECTOR3ROTATEY "rotate_y(float) -> Vector3\nrotates a vector around the y-axis by the angle in degrees."
92
#define DOC_VECTOR3ROTATEYIP "rotate_y_ip(float) -> None\nrotates the vector around the y-axis by the angle in degrees in place."
94
#define DOC_VECTOR3ROTATEZ "rotate_z(float) -> Vector3\nrotates a vector around the z-axis by the angle in degrees."
96
#define DOC_VECTOR3ROTATEZIP "rotate_z_ip(float) -> None\nrotates the vector around the z-axis by the angle in degrees in place."
98
#define DOC_VECTOR3ANGLETO "angle_to(Vector3) -> float\ncalculates the angle to a given vector in degrees."
100
#define DOC_VECTOR3ASSPHERICAL "as_spherical() -> (r, theta, phi)\nreturns a tuple with radial distance, inclination and azimuthal angle."
102
#define DOC_VECTOR3FROMSPHERICAL "from_spherical((r, theta, phi)) -> None\nSets x, y and z from a spherical coordinates 3-tuple."
106
/* Docs in a comment... slightly easier to read. */
111
pygame module for vector classes
113
pygame.math.enable_swizzling
114
enable_swizzling() -> None
115
globally enables swizzling for vectors.
117
pygame.math.disable_swizzling
118
disable_swizzling() -> None
119
globally disables swizzling for vectors.
123
Vector2(Vector2) -> Vector2
124
Vector2(x, y) -> Vector2
125
Vector2((x, y)) -> Vector2
126
a 2-Dimensional Vector
128
pygame.math.Vector2.dot
129
dot(Vector2) -> float
130
calculates the dot- or scalar-product with the other vector
132
pygame.math.Vector2.cross
133
cross(Vector2) -> float
134
calculates the cross- or vector-product
136
pygame.math.Vector2.length
138
returns the euclidic length of the vector.
140
pygame.math.Vector2.length_squared
141
length_squared() -> float
142
returns the squared euclidic length of the vector.
144
pygame.math.Vector2.normalize
145
normalize() -> Vector2
146
returns a vector with the same direction but length 1.
148
pygame.math.Vector2.normalize_ip
149
normalize_ip() -> None
150
normalizes the vector in place so that its length is 1.
152
pygame.math.Vector2.is_normalized
153
is_normalized() -> Bool
154
tests if the vector is normalized i.e. has length == 1.
156
pygame.math.Vector2.scale_to_length
157
scale_to_length(float) -> None
158
scales the vector to a given length.
160
pygame.math.Vector2.reflect
161
reflect(Vector2) -> Vector2
162
returns a vector reflected of a given normal.
164
pygame.math.Vector2.reflect_ip
165
reflect_ip(Vector2) -> None
166
reflect the vector of a given normal in place.
168
pygame.math.Vector2.distance_to
169
distance_to(Vector2) -> float
170
calculates the euclidic distance to a given vector.
172
pygame.math.Vector2.distance_squared_to
173
distance_squared_to(Vector2) -> float
174
calculates the squared euclidic distance to a given vector.
176
pygame.math.Vector2.lerp
177
lerp(Vector2, float) -> Vector2
178
returns a linear interpolation to the given vector.
180
pygame.math.Vector2.slerp
181
slerp(Vector2, float) -> Vector2
182
returns a spherical interpolation to the given vector.
184
pygame.math.Vector2.elementwise
185
elementwise() -> VectorElementwizeProxy
186
The next operation will be performed elementwize.
188
pygame.math.Vector2.rotate
189
rotate(float) -> Vector2
190
rotates a vector by a given angle in degrees.
192
pygame.math.Vector2.rotate_ip
193
rotate_ip(float) -> None
194
rotates the vector by a given angle in degrees in place.
196
pygame.math.Vector2.angle_to
197
angle_to(Vector2) -> float
198
calculates the angle to a given vector in degrees.
200
pygame.math.Vector2.as_polar
201
as_polar() -> (r, phi)
202
returns a tuple with radial distance and azimuthal angle.
204
pygame.math.Vector2.from_polar
205
from_polar((r, phi)) -> None
206
Sets x and y from a polar coordinates tuple.
210
Vector3(Vector3) -> Vector3
211
Vector3(x, y, z) -> Vector3
212
Vector3((x, y, z)) -> Vector3
213
a 3-Dimensional Vector
215
pygame.math.Vector3.dot
216
dot(Vector3) -> float
217
calculates the dot- or scalar-product with the other vector
219
pygame.math.Vector3.cross
220
cross(Vector3) -> float
221
calculates the cross- or vector-product
223
pygame.math.Vector3.length
225
returns the euclidic length of the vector.
227
pygame.math.Vector3.length_squared
228
length_squared() -> float
229
returns the squared euclidic length of the vector.
231
pygame.math.Vector3.normalize
232
normalize() -> Vector3
233
returns a vector with the same direction but length 1.
235
pygame.math.Vector3.normalize_ip
236
normalize_ip() -> None
237
normalizes the vector in place so that its length is 1.
239
pygame.math.Vector3.is_normalized
240
is_normalized() -> Bool
241
tests if the vector is normalized i.e. has length == 1.
243
pygame.math.Vector3.scale_to_length
244
scale_to_length(float) -> None
245
scales the vector to a given length.
247
pygame.math.Vector3.reflect
248
reflect(Vector3) -> Vector3
249
returns a vector reflected of a given normal.
251
pygame.math.Vector3.reflect_ip
252
reflect_ip(Vector3) -> None
253
reflect the vector of a given normal in place.
255
pygame.math.Vector3.distance_to
256
distance_to(Vector3) -> float
257
calculates the euclidic distance to a given vector.
259
pygame.math.Vector3.distance_squared_to
260
distance_squared_to(Vector3) -> float
261
calculates the squared euclidic distance to a given vector.
263
pygame.math.Vector3.lerp
264
lerp(Vector3, float) -> Vector3
265
returns a linear interpolation to the given vector.
267
pygame.math.Vector3.slerp
268
slerp(Vector3, float) -> Vector3
269
returns a spherical interpolation to the given vector.
271
pygame.math.Vector3.elementwise
272
elementwise() -> VectorElementwizeProxy
273
The next operation will be performed elementwize.
275
pygame.math.Vector3.rotate
276
rotate(Vector3, float) -> Vector3
277
rotates a vector by a given angle in degrees.
279
pygame.math.Vector3.rotate_ip
280
rotate_ip(Vector3, float) -> None
281
rotates the vector by a given angle in degrees in place.
283
pygame.math.Vector3.rotate_x
284
rotate_x(float) -> Vector3
285
rotates a vector around the x-axis by the angle in degrees.
287
pygame.math.Vector3.rotate_x_ip
288
rotate_x_ip(float) -> None
289
rotates the vector around the x-axis by the angle in degrees in place.
291
pygame.math.Vector3.rotate_y
292
rotate_y(float) -> Vector3
293
rotates a vector around the y-axis by the angle in degrees.
295
pygame.math.Vector3.rotate_y_ip
296
rotate_y_ip(float) -> None
297
rotates the vector around the y-axis by the angle in degrees in place.
299
pygame.math.Vector3.rotate_z
300
rotate_z(float) -> Vector3
301
rotates a vector around the z-axis by the angle in degrees.
303
pygame.math.Vector3.rotate_z_ip
304
rotate_z_ip(float) -> None
305
rotates the vector around the z-axis by the angle in degrees in place.
307
pygame.math.Vector3.angle_to
308
angle_to(Vector3) -> float
309
calculates the angle to a given vector in degrees.
311
pygame.math.Vector3.as_spherical
312
as_spherical() -> (r, theta, phi)
313
returns a tuple with radial distance, inclination and azimuthal angle.
315
pygame.math.Vector3.from_spherical
316
from_spherical((r, theta, phi)) -> None
317
Sets x, y and z from a spherical coordinates 3-tuple.
b'\\ No newline at end of file'
added
removed
src/doc/math_doc.h
