net.cscott.sdr.calls
Class FormationMatch

java.lang.Object
  net.cscott.sdr.calls.FormationMatch

public class FormationMatch
extends Object

A successful attempt to match one or more instances of a given formation against the current setup yields a FormationMatch objects. The FormationMatch contains a list of TaggedFormation; for example, matching a diamond against a twin diamond setup will result in two TaggedFormations, one for each diamond. A FormationMatch may also contain a Warp, which specifies a transformation on the paths resulting from executing a call in the given TaggedFormations. For example, matching stretched boxes will result in TaggedFormations of undistorted boxes, and a Warp which will initially stretch the boxes.

Field Summary

Map<Dancer,TaggedFormation>	matches The matches field is a map from phantom dancers in the meta formation to real dancers in a tagged subformation.
Formation	meta The meta formation contains one dancer for each matched sub-formation in the setup.

Constructor Summary

FormationMatch(Formation meta, Map<Dancer,TaggedFormation> matches)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

meta

public final Formation meta

The meta formation contains one dancer for each matched sub-formation in the setup. Unmatched dancers (if allowed by the match) result in phantom dancers in the meta formation mapped to the FormationList#SINGLE_DANCER sub-formation.

matches

public final Map<Dancer,TaggedFormation> matches

The matches field is a map from phantom dancers in the meta formation to real dancers in a tagged subformation. The meta formation says how these subformations could be rotated, shifted, and recombined into the original setup.

Constructor Detail

FormationMatch

public FormationMatch(Formation meta,
                      Map<Dancer,TaggedFormation> matches)