svs_simulation.entities.base_entities.MovingEntity

Package svs_simulation :: Package entities :: Module base_entities :: Class MovingEntity_OLD

[show private | hide private]

Class MovingEntity_OLD

Entity --+
         |
        MovingEntity_OLD

Entity with basic movement capabilities.

@ivar self.velocity:velocity of entity.

Method Summary
	`__init__(self)`
	`isSpeedMaxedOut(self)` Checks if speed is at maximum.
boolean	`rotateHeadingToFacePosition(self, target)` Given a target position, this method rotates the entity's heading and side vectors by an amount not greater than `MovingEntity.maxTurnRate` until it directly faces the target.
	`setHeading(self, newHeading)` First checks that the given heading is not a vector of zero length.
	`speed(self)` Return current speed.
	`speedSq(self)` Return current speed squared.
Inherited from Entity
	`decode(self, data)` Applies encoded data to self.
	`encode(self)` Returns encoded representation of self.
	`enterPartition(self, partition)` Called when entity enters a partition.
	`enterStructure(self, structure)` Called when entity enters a structure.
	`enterWorld(self, world)` Called when entity is added to world.
	`exitPartition(self, partition)` Called when entity is leaves a structure.
	`exitWorld(self, simTime)` Called when structure is removed world.
	`getName(self)` If the entity has a name, return this, otherwise returns a name created from its class name and unique id.
	`handleSimEvent(self, event)` Handles event form simulation.
boolean	`isTagged(self)` Returns tag state.
	`placeInWorld(self)` Sets the structure and partition that the entity is within.
	`reportChange(self, data)` Forwards data representing change in entity to process handler.
	`setup(self)`
	`startWorld(self, simTime)` Called when the simulation world starts running, or if an entity has been added to a world after it has started.
	`stopWorld(self, simTime)` Called when the simulation world stops running, or if an entity has been removed from a world after it has started.
	`updateWorld(self, simTime)` Called when the simulation world updates.

Method Details

isSpeedMaxedOut(self)

Checks if speed is at maximum.

rotateHeadingToFacePosition(self, target)

Given a target position, this method rotates the entity's heading and side vectors by an amount not greater than MovingEntity.maxTurnRate until it directly faces the target.

Parameters:: target
(type=svs_core.geometry.vectors.Vector2D)

Returns:: true when the heading is facing in the desired direction
(type=boolean)

setHeading(self, newHeading)

First checks that the given heading is not a vector of zero length. If the new heading is valid this function sets the entity's heading and side vectors accordingly.

Parameters:: newHeading
(type=svs_core.geometry.vectors.Vector2D)

speed(self)

Return current speed.

speedSq(self)

Return current speed squared.

Generated by Epydoc 2.1 on Thu Oct 20 15:30:24 2005

http://epydoc.sf.net