TiledPattern Class Reference

List of all members.

Public Member Functions

 TiledPattern (PatternPackage thePatternPackage, int initialPatternFileN, int initialDotHorizOffset, int initialDotVertOffset, int numTilesNeededX, int numTilesNeededY, int numDotsXFromRightMostTiles, int numDotsYFromBottomMostTiles)
 The creator of this object has to calculate exactly how many dots it needs.
int getInitialPatternFileNumber ()
int getLastPatternFileUsed ()
int getNumDotsXFromRightMostTiles ()
int getNumDotsXPerFullTile ()
int getNumDotsYFromBottomMostTiles ()
int getNumDotsYPerFullTile ()
double getNumHorizDotsBetweenTiles ()
int getNumTilesX ()
int getNumTilesY ()
int getNumTotalColumns ()
int getNumTotalRows ()
double getNumVertDotsBetweenTiles ()
double getOriginXInDots ()
double getOriginYInDots ()
String getPatternOnRow (int row)
String toString ()

Detailed Description

A TiledPatternGenerator can create a TiledPattern object, which allows you to iterate through the object to find the dot pattern.

This class will also know the physical and logical coordinates of the pattern that it reads in. This allows other classes to determine this information later on, for coordinate transformations, etc.

This software is distributed under the BSD License.

Author:
Ron B Yeh (ronyeh(AT)cs.stanford.edu)

Definition at line 24 of file TiledPattern.java.


Constructor & Destructor Documentation

TiledPattern ( PatternPackage  thePatternPackage,
int  initialPatternFileN,
int  initialDotHorizOffset,
int  initialDotVertOffset,
int  numTilesNeededX,
int  numTilesNeededY,
int  numDotsXFromRightMostTiles,
int  numDotsYFromBottomMostTiles 
)

The creator of this object has to calculate exactly how many dots it needs.

This class doesn't have smarts. It will give you exactly what you ask for.

Parameters:
thePatternPackage 
initialPatternFileN 
initialDotHorizOffset 
initialDotVertOffset 
numTilesNeededX 
numTilesNeededY 
numDotsXFromRightMostTiles 
numDotsYFromBottomMostTiles 

Definition at line 117 of file TiledPattern.java.

References PatternPackage.getNumPatternColsPerFile(), PatternPackage.getNumPatternRowsPerFile(), PatternPackage.getPatternCoordinateOfOriginOfFile(), StreamedPatternCoordinates.getXVal(), StreamedPatternCoordinates.getYVal(), StreamedPatternCoordinates.setX(), and StreamedPatternCoordinates.setY().


Member Function Documentation

int getInitialPatternFileNumber (  ) 

Returns:
which file we will use to start looking for pattern.

Definition at line 188 of file TiledPattern.java.

Referenced by TiledPatternCoordinateConverter.setPatternInformationByReadingItFrom().

int getLastPatternFileUsed (  ) 

Returns:
which was the last file we took pattern from.

Definition at line 195 of file TiledPattern.java.

Referenced by TiledPatternGenerator.getPattern().

int getNumDotsXPerFullTile (  ) 

Returns:

Definition at line 206 of file TiledPattern.java.

Referenced by TiledPatternCoordinateConverter.setPatternInformationByReadingItFrom().

int getNumDotsYPerFullTile (  ) 

Returns:

Definition at line 217 of file TiledPattern.java.

Referenced by TiledPatternCoordinateConverter.setPatternInformationByReadingItFrom().

double getNumHorizDotsBetweenTiles (  ) 

Returns:

Definition at line 224 of file TiledPattern.java.

References PatternPackage.getNumDotsHorizontalBetweenPages().

Referenced by TiledPatternCoordinateConverter.setPatternInformationByReadingItFrom().

int getNumTilesX (  ) 

Returns:

Definition at line 231 of file TiledPattern.java.

Referenced by TiledPatternCoordinateConverter.setPatternInformationByReadingItFrom().

int getNumTilesY (  ) 

Returns:

Definition at line 238 of file TiledPattern.java.

Referenced by TiledPatternCoordinateConverter.setPatternInformationByReadingItFrom().

int getNumTotalColumns (  ) 

Returns:

Definition at line 245 of file TiledPattern.java.

Referenced by PDFPatternGenerator.renderPattern(), and TiledPatternCoordinateConverter.setPatternInformationByReadingItFrom().

int getNumTotalRows (  ) 

Returns:
the number of rows of pattern this object represents

Definition at line 252 of file TiledPattern.java.

Referenced by PDFPatternGenerator.renderPattern(), and TiledPatternCoordinateConverter.setPatternInformationByReadingItFrom().

double getNumVertDotsBetweenTiles (  ) 

Returns:

Definition at line 259 of file TiledPattern.java.

References PatternPackage.getNumDotsVerticalBetweenPages().

Referenced by TiledPatternCoordinateConverter.setPatternInformationByReadingItFrom().

double getOriginXInDots (  ) 

Returns:
X coordinate of the top of the tile.

Definition at line 266 of file TiledPattern.java.

References StreamedPatternCoordinates.getXVal().

Referenced by TiledPatternCoordinateConverter.setPatternInformationByReadingItFrom().

double getOriginYInDots (  ) 

Returns:
Y coordinate of the top of the tile.

Definition at line 273 of file TiledPattern.java.

References StreamedPatternCoordinates.getYVal().

Referenced by TiledPatternCoordinateConverter.setPatternInformationByReadingItFrom().

String getPatternOnRow ( int  row  ) 

Parameters:
row 
Returns:

Definition at line 281 of file TiledPattern.java.

Referenced by PDFPatternGenerator.renderPattern().

String toString (  ) 

See also:
java.lang.Object.toString()

Definition at line 365 of file TiledPattern.java.


The documentation for this class was generated from the following file:
Generated on Sat Apr 14 18:21:42 2007 for R3 Paper Toolkit by  doxygen 1.4.7