HoverSim Design

From Hovercraft

(Difference between revisions)
(HoverCraft(CraftComponent))
Line 4: Line 4:
=CraftComponent=
=CraftComponent=
 +
Base class for all craft components.
 +
* CraftComponent parent
* CraftComponent parent
 +
 +
Relative properties
* Vector2 position
* Vector2 position
* float orientation
* float orientation
* Vector2 velocity
* Vector2 velocity
 +
Absolute properties
* Vector2 absPosition
* Vector2 absPosition
* float absOrientation
* float absOrientation
* Vector2 absVelocity
* Vector2 absVelocity
-
* recalcAbsoluteProperties() # recalculate absolute properties using the parent as a reference
+
Recalculate absolute properties using the parent as a reference
 +
* recalcAbsoluteProperties()
=HoverCraft(CraftComponent)=
=HoverCraft(CraftComponent)=
 +
Base class for hovercraft vehicles.
 +
Assumes a circular shape.
 +
* Vector2 thrust
* Vector2 thrust
* float weight
* float weight
* float radius
* float radius
 +
* __init__(weight, radius)
=Sensor(CraftComponent)=
=Sensor(CraftComponent)=
 +
Base class for sensor components
* read()
* read()
-
=LightSensor(Sensor)
+
=LightSensor(Sensor)=
 +
Implements a light sensor with the specified range
 +
* __init__(range)
* read()
* read()
=Fan(CraftComponent)=
=Fan(CraftComponent)=
* thrust()
* thrust()

Revision as of 14:38, 26 September 2006

Contents

Introduction

This design refers to the core classes of the HoverSim API.

CraftComponent

Base class for all craft components.

  • CraftComponent parent

Relative properties

  • Vector2 position
  • float orientation
  • Vector2 velocity

Absolute properties

  • Vector2 absPosition
  • float absOrientation
  • Vector2 absVelocity

Recalculate absolute properties using the parent as a reference

  • recalcAbsoluteProperties()

HoverCraft(CraftComponent)

Base class for hovercraft vehicles. Assumes a circular shape.

  • Vector2 thrust
  • float weight
  • float radius
  • __init__(weight, radius)

Sensor(CraftComponent)

Base class for sensor components

  • read()

LightSensor(Sensor)

Implements a light sensor with the specified range

  • __init__(range)
  • read()

Fan(CraftComponent)

  • thrust()
Personal tools