summaryrefslogtreecommitdiff
path: root/vectorgfx.mod/doc
diff options
context:
space:
mode:
authorIan C <ianc@noddybox.co.uk>2005-10-24 00:10:52 +0000
committerIan C <ianc@noddybox.co.uk>2005-10-24 00:10:52 +0000
commit53cc1b3be81ac220f6353bb5206b667261b3eab6 (patch)
tree404ae3aa0977272c6dbd434d1a8f794d0f001504 /vectorgfx.mod/doc
parent2c4a357e8f8e62fe50ab489519990e91e718c0d0 (diff)
Added a different method for handling collisions
Diffstat (limited to 'vectorgfx.mod/doc')
-rw-r--r--vectorgfx.mod/doc/.cvsignore1
-rw-r--r--vectorgfx.mod/doc/intro.html44
2 files changed, 45 insertions, 0 deletions
diff --git a/vectorgfx.mod/doc/.cvsignore b/vectorgfx.mod/doc/.cvsignore
new file mode 100644
index 0000000..2ec3ca5
--- /dev/null
+++ b/vectorgfx.mod/doc/.cvsignore
@@ -0,0 +1 @@
+commands.html \ No newline at end of file
diff --git a/vectorgfx.mod/doc/intro.html b/vectorgfx.mod/doc/intro.html
new file mode 100644
index 0000000..c456aa1
--- /dev/null
+++ b/vectorgfx.mod/doc/intro.html
@@ -0,0 +1,44 @@
+<html>
+<head>
+<title></title>
+<link rel="styleSheet" href="../../../../doc/css/bmxref.css" type="text/css">
+</head>
+<body>
+<h1>noddybox.VectorGfx</h1>
+This module provides methods for displaying 2D vector graphics, and finding
+collisions between objects.
+This is implemented in two different ways depending on how you want collisions
+work work.
+<p>
+
+<ul>
+
+<li>
+A collision map can be used, whereby objects can be drawn into the map when
+being drawn onto the screen. A mask of these collisions, as well as the
+actual objects and lines involved with the collisions is returned. This
+method uses a <a href="commands.html#TVectorGfxCollisionMap" class="token">
+TVectorGfxCollisionMap</a> to store collision data, and is invoked using the
+<a href=commands.html#DrawToCollisionMap class=token>DrawToCollisionMap</a>
+method in
+<a href="commands.html#TVectorGfxObject" class="token">TVectorGfxObject</a>.
+</li>
+
+<li>
+The other method is more manual in that a point of lists is returned (defined
+using
+<a href="commands.html#TVectorGfxPoint" class="token">TVectorGfxPoint</a>
+objects) defining all the points drawn for an object.
+This is invoked using the
+<a href=commands.html#DrawToPointList class=token>DrawToPointList</a>
+method in
+<a href="commands.html#TVectorGfxObject" class="token">TVectorGfxObject</a>.
+</li>
+
+</ul>
+
+It should be noted that the collision map method is not fool-proof. For
+example, two diagnal lines may pass through each other without colliding.
+
+</body>
+</html>