Skip navigation links
WordCram 1.0.1
A B C D E F G H I K L M N O P R S T U V W 

A

alwaysUse(float) - Static method in class wordcram.Anglers
If you want all your words to be drawn at the same angle, use this.
alwaysUse(int) - Static method in class wordcram.Colorers
 
alwaysUse(PFont) - Static method in class wordcram.Fonters
 
angledAt(float...) - Method in class wordcram.WordCram
Make the WordCram rotate each word at one of the given angles.
angledBetween(float, float) - Method in class wordcram.WordCram
Make the WordCram rotate words randomly, between the min and max angles.
angleFor(Word) - Method in interface wordcram.WordAngler
What angle should this Word be rotated at?
Anglers - Class in wordcram
Some pre-fab WordAnglers.
Anglers() - Constructor for class wordcram.Anglers
 

B

BBTree - Class in wordcram
 
BBTreeBuilder - Class in wordcram
 
BBTreeBuilder() - Constructor for class wordcram.BBTreeBuilder
 
beginDraw() - Method in interface wordcram.Observer
 
byRank(int, int) - Static method in class wordcram.Sizers
Returns a WordSizer that sizes words by their rank.
byWeight(int, int) - Static method in class wordcram.Sizers
Returns a WordSizer that sizes words by their weight, where the "heaviest" word will be sized at maxSize.

C

centerClump() - Static method in class wordcram.Placers
 
Colorers - Class in wordcram
 
Colorers() - Constructor for class wordcram.Colorers
 
colorFor(Word) - Method in interface wordcram.WordColorer
What color should this Word be?
compareTo(Word) - Method in class wordcram.Word
Compares Words based on weight only.

D

draw(PGraphics) - Method in class wordcram.BBTree
 
draw(PApplet) - Method in class wordcram.PlacerHeatMap
 
drawAll() - Method in class wordcram.WordCram
Just like it sounds: draw all the words.
drawNext() - Method in class wordcram.WordCram
If the WordCram has any more words to draw, draw the next one.

E

endDraw() - Method in interface wordcram.Observer
 
excludeNumbers() - Method in class wordcram.WordCram
Exclude numbers from the text in the WordCram.

F

Fonters - Class in wordcram
 
Fonters() - Constructor for class wordcram.Fonters
 
fontFor(Word) - Method in interface wordcram.WordFonter
What font should this Word be drawn in?
fromHtmlFile(String) - Method in class wordcram.WordCram
Make a WordCram from the text in a HTML file.
fromHtmlFile(String, String) - Method in class wordcram.WordCram
Make a WordCram from the text in any elements on a web page that match the cssSelector.
fromHtmlString(String...) - Method in class wordcram.WordCram
Deprecated.
because its signature is annoying, and makes it hard to pass a CSS Selector. If you love this method, and want it to stick around, let me know: open a github issue, send me a tweet, or say hello at wordcram at gmail. Otherwise, it'll be deleted in a future release, probably 0.6.
fromText(TextSource) - Method in class wordcram.WordCram
Makes a WordCram from any TextSource.
fromTextFile(String) - Method in class wordcram.WordCram
Makes a WordCram from a text file, either on the filesystem or the network.
fromTextString(String...) - Method in class wordcram.WordCram
Makes a WordCram from a String of text.
fromWebPage(String) - Method in class wordcram.WordCram
Make a WordCram from the text on a web page.
fromWebPage(String, String) - Method in class wordcram.WordCram
Make a WordCram from the text in any elements on a web page that match the cssSelector.
fromWords(Word[]) - Method in class wordcram.WordCram
Makes a WordCram from your own custom Word array.
fromWords(WordSource) - Method in class wordcram.WordCram
 

G

getProgress() - Method in class wordcram.WordCram
How far through the words are we? Useful for when drawing to a custom PGraphics.
getProperty(String) - Method in class wordcram.Word
Get a property value from this Word, for a WordColorer, a WordPlacer, etc.
getRenderedAngle() - Method in class wordcram.Word
Get the angle the Word was rendered at: either the value passed to setAngle(), or the value returned from the WordAngler.
getRenderedColor() - Method in class wordcram.Word
Get the color the Word was rendered in: either the value passed to setColor(), or the value returned from the WordColorer.
getRenderedFont() - Method in class wordcram.Word
Get the font the Word was rendered in: either the value passed to setFont(), or the value returned from the WordFonter.
getRenderedHeight() - Method in class wordcram.Word
Gets the height, in pixels, of the java.awt.Shape that will be rendered for this Word, based on the Font, Angle, and Size for this Word.
getRenderedPlace() - Method in class wordcram.Word
Get the final place the Word was rendered at, or null if it couldn't be placed.
getRenderedSize() - Method in class wordcram.Word
Get the size the Word was rendered at: either the value passed to setSize(), or the value returned from the WordSizer.
getRenderedWidth() - Method in class wordcram.Word
Gets the width, in pixels, of the java.awt.Shape that will be rendered for this Word, based on the Font, Angle, and Size for this Word.
getShapeFor(String, Font, float, float) - Method in class wordcram.WordShaper
 
getShapeFor(String, Font) - Method in class wordcram.WordShaper
 
getShapeFor(String, PFont, float, float) - Method in class wordcram.WordShaper
 
getShapeFor(String, PFont) - Method in class wordcram.WordShaper
 
getSkippedWords() - Method in class wordcram.WordCram
Returns an array of words that could not be placed.
getTargetPlace() - Method in class wordcram.Word
Get the place the Word was supposed to be rendered at: either the value passed to setPlace(), or the value returned from the WordPlacer.
getText() - Method in class wordcram.text.Html
 
getText() - Method in class wordcram.text.Text
 
getText() - Method in class wordcram.text.TextFile
 
getText() - Method in interface wordcram.text.TextSource
 
getText() - Method in class wordcram.text.WebPage
 
getWordAt(float, float) - Method in class wordcram.WordCram
Get the Word at the given (x,y) coordinates.
getWords() - Method in class wordcram.WordBag
 
getWords() - Method in class wordcram.WordCram
Get the Words that WordCram is drawing.
getWords() - Method in interface wordcram.WordSource
 

H

hasMore() - Method in class wordcram.WordCram
If you're drawing the words one-at-a-time using WordCram.drawNext(), this will tell you whether the WordCram has any words left to draw.
heaped() - Static method in class wordcram.Anglers
 
hexes() - Static method in class wordcram.Anglers
A WordAngler that draws all words at hexagonal angles, or (if you're a bit more mathy) 0π/6, 1π/6, 2π/6, 3π/6, 4π/6, and 5π/6.
horiz() - Static method in class wordcram.Anglers
A WordAngler that draws all words horizontally.
horizBandAnchoredLeft() - Static method in class wordcram.Placers
 
horizLine() - Static method in class wordcram.Placers
 
Html - Class in wordcram.text
 
Html(String) - Constructor for class wordcram.text.Html
 

I

ImageShaper - Class in wordcram
 
ImageShaper() - Constructor for class wordcram.ImageShaper
 
includeNumbers() - Method in class wordcram.WordCram
Include numbers from the text in the WordCram.

K

keepCase() - Method in class wordcram.WordCram
Make the WordCram leave all words cased as they appear in the text.

L

lowerCase() - Method in class wordcram.WordCram
Make the WordCram change all words to lower-case.

M

makeTree(Shape, int) - Method in class wordcram.BBTreeBuilder
 
maxAttemptsToPlaceWord(int) - Method in class wordcram.WordCram
How many attempts should be used to place a word.
maxNumberOfWordsToDraw(int) - Method in class wordcram.WordCram
The maximum number of Words WordCram should try to draw.
minShapeSize(int) - Method in class wordcram.WordCram
The smallest-sized Shape the WordCram should try to draw.
mostlyHoriz() - Static method in class wordcram.Anglers
A WordAngler that draws 5/7 words horizontally, and the rest going up and down.

N

nudgeFor(Word, int) - Method in class wordcram.PlottingWordNudger
 
nudgeFor(Word, int) - Method in class wordcram.RandomWordNudger
 
nudgeFor(Word, int) - Method in class wordcram.ShapeBasedPlacer
 
nudgeFor(Word, int) - Method in class wordcram.SpiralWordNudger
 
nudgeFor(Word, int) - Method in interface wordcram.WordNudger
How should this word be nudged, this time?

O

Observer - Interface in wordcram
 
overlaps(BBTree) - Method in class wordcram.BBTree
 

P

pickFrom(float...) - Static method in class wordcram.Anglers
Just like Anglers.alwaysUse(float), but it takes multiple angles.
pickFrom(int...) - Static method in class wordcram.Colorers
 
pickFrom(PFont...) - Static method in class wordcram.Fonters
 
place(Word, int, int, int, int, int, int) - Method in class wordcram.PlottingWordPlacer
 
place(Word, int, int, int, int, int, int) - Method in class wordcram.ShapeBasedPlacer
 
place(Word, int, int, int, int, int, int) - Method in class wordcram.SwirlWordPlacer
 
place(Word, int, int, int, int, int, int) - Method in class wordcram.UpperLeftWordPlacer
 
place(Word, int, int, int, int, int, int) - Method in class wordcram.WaveWordPlacer
 
place(Word, int, int, int, int, int, int) - Method in interface wordcram.WordPlacer
Where should this Word be drawn on the field?
PlacerHeatMap - Class in wordcram
 
Placers - Class in wordcram
 
Placers() - Constructor for class wordcram.Placers
 
PlottingWordNudger - Class in wordcram
If you're using a custom WordNudger, and having difficulty seeing how well it works, try wrapping it in a PlottingWordNudger.
PlottingWordNudger(PApplet, WordNudger) - Constructor for class wordcram.PlottingWordNudger
 
PlottingWordPlacer - Class in wordcram
If you're using a custom WordPlacer, and having difficulty seeing how well it works, try wrapping it in a PlottingWordPlacer.
PlottingWordPlacer(PApplet, WordPlacer) - Constructor for class wordcram.PlottingWordPlacer
 

R

random() - Static method in class wordcram.Anglers
 
randomBetween(float, float) - Static method in class wordcram.Anglers
 
RandomWordNudger - Class in wordcram
A RandomWordNudger, where each attempt's PVector has X & Y coords distributed randomly around the desired point, multiplied by a standard deviation, and multiplied by the attempt number (so it gets farther, as it gets more desperate).
RandomWordNudger() - Constructor for class wordcram.RandomWordNudger
Create a RandomWordNudger with a standard deviation of 0.6.
RandomWordNudger(float) - Constructor for class wordcram.RandomWordNudger
Create a RandomWordNudger with your own standard deviation.

S

setAngle(float) - Method in class wordcram.Word
Set the angle this Word should be rendered at - WordCram won't even call the WordAngler.
setColor(int) - Method in class wordcram.Word
Set the color this Word should be rendered in - WordCram won't call the WordColorer.
setFont(PFont) - Method in class wordcram.Word
Set the font this Word should be rendered in - WordCram won't call the WordFonter.
setLocation(int, int) - Method in class wordcram.BBTree
 
setPlace(PVector) - Method in class wordcram.Word
Set the place this Word should be rendered at - WordCram won't call the WordPlacer.
setPlace(float, float) - Method in class wordcram.Word
Set the place this Word should be rendered at - WordCram won't call the WordPlacer.
setProperty(String, Object) - Method in class wordcram.Word
Set a property on this Word, to be used by a WordColorer, a WordPlacer, etc, down the line.
setSize(float) - Method in class wordcram.Word
Set the size this Word should be rendered at - WordCram won't even call the WordSizer.
shape(PImage, int) - Method in class wordcram.ImageShaper
 
ShapeBasedPlacer - Class in wordcram
 
ShapeBasedPlacer(Shape) - Constructor for class wordcram.ShapeBasedPlacer
 
sizedByRank(int, int) - Method in class wordcram.WordCram
Make the WordCram size words by their rank.
sizedByWeight(int, int) - Method in class wordcram.WordCram
Make the WordCram size words by their weight, where the "heaviest" word will be sized at maxSize.
sizeFor(Word, int, int) - Method in interface wordcram.WordSizer
How big should this Word be rendered?
Sizers - Class in wordcram
Sizers contains pre-made WordSizer implementations that you might find useful.
Sizers() - Constructor for class wordcram.Sizers
 
SpiralWordNudger - Class in wordcram
 
SpiralWordNudger() - Constructor for class wordcram.SpiralWordNudger
 
swirl() - Static method in class wordcram.Placers
 
SwirlWordPlacer - Class in wordcram
 
SwirlWordPlacer() - Constructor for class wordcram.SwirlWordPlacer
 

T

testPlacer() - Method in class wordcram.WordCram
Render a heatmap of the locations where your WordPlacer places words.
Text - Class in wordcram.text
 
Text(String) - Constructor for class wordcram.text.Text
 
TextFile - Class in wordcram.text
 
TextFile(String, PApplet) - Constructor for class wordcram.text.TextFile
 
TextSource - Interface in wordcram.text
 
toCanvas(PGraphics) - Method in class wordcram.WordCram
Use a custom canvas instead of the applet's default one.
toString() - Method in class wordcram.Word
Displays the word, and its weight (in parentheses).
toString() - Method in enum wordcram.WordSkipReason
 
toSvg(String, int, int) - Method in class wordcram.WordCram
 
twoHuesRandomSats(PApplet) - Static method in class wordcram.Colorers
 
twoHuesRandomSatsOnWhite(PApplet) - Static method in class wordcram.Colorers
 

U

upAndDown() - Static method in class wordcram.Anglers
A WordAngler that draws all words vertically, pointing both up and down.
upperCase() - Method in class wordcram.WordCram
Make the WordCram change all words to upper-case.
upperLeft() - Static method in class wordcram.Placers
 
UpperLeftWordPlacer - Class in wordcram
 
UpperLeftWordPlacer() - Constructor for class wordcram.UpperLeftWordPlacer
 

V

valueOf(String) - Static method in enum wordcram.WordSkipReason
Returns the enum constant of this type with the specified name.
values() - Static method in enum wordcram.WordSkipReason
Returns an array containing the constants of this enum type, in the order they are declared.

W

wasPlaced() - Method in class wordcram.Word
Indicates whether the Word was placed successfully.
wasSkipped() - Method in class wordcram.Word
Indicates whether the Word was skipped.
wasSkippedBecause() - Method in class wordcram.Word
Tells you why this Word was skipped.
wave() - Static method in class wordcram.Placers
 
WaveWordPlacer - Class in wordcram
 
WaveWordPlacer() - Constructor for class wordcram.WaveWordPlacer
 
WebPage - Class in wordcram.text
 
WebPage(String, String, PApplet) - Constructor for class wordcram.text.WebPage
 
weight - Variable in class wordcram.Word
 
weightDistributionPower(float) - Method in class wordcram.WordBag
 
withAngler(WordAngler) - Method in class wordcram.WordCram
Use the given WordAngler to pick angles for each word.
withColor(int) - Method in class wordcram.WordCram
Renders all words in the given color.
withColorer(WordColorer) - Method in class wordcram.WordCram
Use the given WordColorer to pick colors for each word.
withColors(int...) - Method in class wordcram.WordCram
Render words by randomly choosing from the given colors.
withCustomCanvas(PGraphics) - Method in class wordcram.WordCram
Deprecated.
for more consistent naming. Use WordCram.toCanvas(PGraphics canvas) instead.
withFont(String) - Method in class wordcram.WordCram
Make the WordCram render all words in the font that matches the given name, via Processing's createFont.
withFont(PFont) - Method in class wordcram.WordCram
Make the WordCram render all words in the given PFont.
withFonter(WordFonter) - Method in class wordcram.WordCram
Use the given WordFonter to pick fonts for each word.
withFonts(String...) - Method in class wordcram.WordCram
This WordCram will get a PFont for each fontName, via createFont, and will render words in one of those PFonts.
withFonts(PFont...) - Method in class wordcram.WordCram
This WordCram will render words in one of the given PFonts.
withNudger(WordNudger) - Method in class wordcram.WordCram
Use the given WordNudger to pick angles for each word.
withObserver(Observer) - Method in class wordcram.WordCram
 
withPlacer(WordPlacer) - Method in class wordcram.WordCram
Use the given WordPlacer to pick locations for each word.
withSizer(WordSizer) - Method in class wordcram.WordCram
Use the given WordSizer to pick fonts for each word.
withStopWords(String) - Method in class wordcram.WordCram
Tells WordCram which words to ignore when it counts up the words in your text.
withWordPadding(int) - Method in class wordcram.WordCram
Add padding around each word, so they stand out from each other more.
Word - Class in wordcram
A weighted word, for rendering in the word cloud image.
Word(String, float) - Constructor for class wordcram.Word
 
word - Variable in class wordcram.Word
 
WordAngler - Interface in wordcram
A WordAngler tells WordCram what angle to draw a word at, in radians.
WordBag - Class in wordcram
 
WordBag(int, String...) - Constructor for class wordcram.WordBag
 
WordColorer - Interface in wordcram
A WordColorer tells WordCram what color to render a word in.
wordcram - package wordcram
 
WordCram - Class in wordcram
The main API for WordCram.
WordCram(PApplet) - Constructor for class wordcram.WordCram
Make a new WordCram.
wordcram.text - package wordcram.text
 
wordDrawn(Word) - Method in interface wordcram.Observer
 
WordFonter - Interface in wordcram
A WordFonter tells WordCram what font to render a word in.
WordNudger - Interface in wordcram
Once a WordPlacer tells WordCram where a word should go, a WordNudger tells WordCram how to nudge it around the field, until it fits in with the other words around it, or the WordCram gives up on the word.
WordPlacer - Interface in wordcram
A WordPlacer tells WordCram where to place a word (in x,y coordinates) on the field.
wordsCounted(Word[]) - Method in interface wordcram.Observer
 
WordShaper - Class in wordcram
 
WordShaper(boolean) - Constructor for class wordcram.WordShaper
 
WordShaper() - Constructor for class wordcram.WordShaper
 
WordSizer - Interface in wordcram
A WordSizer tells WordCram how big to render each word.
wordSkipped(Word) - Method in interface wordcram.Observer
 
WordSkipReason - Enum in wordcram
 
WordSource - Interface in wordcram
 
A B C D E F G H I K L M N O P R S T U V W 
Skip navigation links
WordCram 1.0.1