-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
See #4, this should at a later point port the complete Seekers doc pdf to the wiki with all classes and methods. This is a test to give an example.
- Loading branch information
1 parent
320f639
commit 2d3d927
Showing
2 changed files
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
layout: page | ||
title: Classes in detail | ||
nav_order: 1 | ||
has_children: true | ||
--- | ||
|
||
# Classes in detail |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
layout: page | ||
title: Vector | ||
parent: Classes in detail | ||
nav_order: 1 | ||
--- | ||
|
||
# Vector | ||
|
||
Vector objects in Seekers are used to represent positions or velocities. All angles are given in radians. | ||
|
||
## Properties | ||
|
||
```x``` (float) | ||
|
||
x component of the vector. | ||
|
||
```y``` (float) | ||
|
||
y component of the vector. | ||
|
||
## Methods | ||
|
||
``copy()`` $\rightarrow$ Vector | ||
|
||
Returns a copy of the vector. | ||
|
||
``dot(other: Vector)`` $\rightarrow$ float | ||
|
||
Returns the scalar product with another vector. | ||
|
||
``static from_polar(angle: float, radius: float)`` $\rightarrow$ Vector | ||
|
||
Initializes a new vector from polar coordinates. |