movements
Class MovementGenerator.FigurePlacement

java.lang.Object
  movements.MovementGenerator.FigurePlacement

Enclosing class:

MovementGenerator

private class MovementGenerator.FigurePlacement

extends java.lang.Object

Defines where a figure is placed on the dance floor.

Field Summary

private Figure	figure
private double	figureDefinitionOrientation
private double	figureOrientation
private MovementGenerator.FigurePlacement	outerFigurePlacement
private Position	point
private double	scale

Constructor Summary

MovementGenerator.FigurePlacement()
The default constructor creates a figure placement such that the co-ordinates used inside the figure are the co-ordinates on the dance floor.

MovementGenerator.FigurePlacement(Figure figure, Position point1, double orientation, MovementGenerator.FigurePlacement outerFigurePlacement)
Constructs a figure placement object where the figure is fixed using a point and an orientation.

MovementGenerator.FigurePlacement(Figure figure, Position point1, Position point2, MovementGenerator.FigurePlacement outerFigurePlacement)
Constructs a figure placement object where the figure is fixed using two points.

Method Summary

(package private) int	getChirality() Determine whether the figure is being reflected.
(package private) double	GetFloorDirection(double direction)
(package private) ParticipantPosition	getFloorParticipantPosition(double down, double across, double direction) DOCUMENT ME!
(package private) Position	GetFloorPosition(double down, double across) Given a pair of co-ordinates used inside the figure, return the point using the floor's co-ordinates to which this maps.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

outerFigurePlacement

private MovementGenerator.FigurePlacement outerFigurePlacement

figure

private Figure figure

point

private Position point

figureDefinitionOrientation

private double figureDefinitionOrientation

figureOrientation

private double figureOrientation

scale

private double scale

Constructor Detail

MovementGenerator.FigurePlacement

public MovementGenerator.FigurePlacement()

The default constructor creates a figure placement such that the co-ordinates used inside the figure are the co-ordinates on the dance floor.

MovementGenerator.FigurePlacement

public MovementGenerator.FigurePlacement(Figure figure,
                                         Position point1,
                                         Position point2,
                                         MovementGenerator.FigurePlacement outerFigurePlacement)

Constructs a figure placement object where the figure is fixed using two points. This constructor takes the Figure object for the innermost figure and also the FigurePlacement object to map outer figures (If this explanation makes any sense!!!)

Parameters:

figure - DOCUMENT ME!

point1 - The position, in the co-ordinate system of the outer figure, of the first fix point. This object must not be modified by the caller after it has been passed to this constructor.

point2 - The position, in the co-ordinate system of the outer figure, of the second fix point. This object must not be modified by the caller after it has been passed to this constructor.

outerFigurePlacement - DOCUMENT ME!

MovementGenerator.FigurePlacement

public MovementGenerator.FigurePlacement(Figure figure,
                                         Position point1,
                                         double orientation,
                                         MovementGenerator.FigurePlacement outerFigurePlacement)

Constructs a figure placement object where the figure is fixed using a point and an orientation. This constructor takes the Figure object for the innermost figure and also the FigurePlacement object to map outer figures (If this explanation makes any sense!!!)

Parameters:

figure - DOCUMENT ME!

point1 - The position, in the co-ordinate system of the outer figure, of the fix point. This object must not be modified by the caller after it has been passed to this constructor.

orientation - The direction, in the co-ordinate system of the outer figure, of the orientation reference line.

outerFigurePlacement - DOCUMENT ME!

Method Detail

GetFloorPosition

Position GetFloorPosition(double down,
                          double across)

Given a pair of co-ordinates used inside the figure, return the point using the floor's co-ordinates to which this maps.

Parameters:

down - DOCUMENT ME!

across - DOCUMENT ME!

Returns:

DOCUMENT ME!

GetFloorDirection

double GetFloorDirection(double direction)

getFloorParticipantPosition

ParticipantPosition getFloorParticipantPosition(double down,
                                                double across,
                                                double direction)

DOCUMENT ME!

Parameters:

down - DOCUMENT ME!

across - DOCUMENT ME!

direction - DOCUMENT ME!

Returns:

DOCUMENT ME!

getChirality

int getChirality()

Determine whether the figure is being reflected. Note that if a figure is used in a reflected state inside an outer figure, but the outer figure is then used in a reflected state then the inner figure would be danced in its unreflected state and this method would return 1.

Returns:

1 if figure is not being reflected and -1 if figure is being reflected.