wordcram

Interface WordPlacer

All Known Implementing Classes:

PlottingWordPlacer, SwirlWordPlacer, UpperLeftWordPlacer, WaveWordPlacer

public interface WordPlacer

A WordPlacer tells WordCram where to place a word (in x,y coordinates) on the field.

A WordPlacer only suggests: the WordCram will try to place the Word where the WordPlacer tells it to, but if the Word overlaps other Words, a WordNudger will suggest different near-by spots for the Word until it fits, or until the WordCram gives up.

Some useful implementations are available in Placers.

Method Summary

Methods

Modifier and Type	Method and Description
processing.core.PVector	place(Word word, int wordIndex, int wordsCount, int wordImageWidth, int wordImageHeight, int fieldWidth, int fieldHeight) Where should this Word be drawn on the field?

Method Detail

place

processing.core.PVector place(Word word,
                            int wordIndex,
                            int wordsCount,
                            int wordImageWidth,
                            int wordImageHeight,
                            int fieldWidth,
                            int fieldHeight)

Where should this Word be drawn on the field?

Parameters:

word - The Word to place. A typical WordPlacer might use the Word's weight.

wordIndex - The index (rank) of the Word to place. Since this isn't a property of the Word, it's passed in as well.

wordsCount - The total number of words. Gives a context to wordIndex: "Word {wordIndex} of {wordsCount}".

wordImageWidth - The width of the word image.

wordImageHeight - The height of the word image.

fieldWidth - The width of the field.

fieldHeight - The height of the field.

Returns:

the desired location for a Word on the field, as a 2D PVector.