Rule

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> eireneh >> bible >> control >> [ map overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.eireneh.bible.control.map.Rule

SOURCE |

Download com.eireneh.bible.control.map.Rule

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.eireneh.bible.control.map
Interface Rule

All Known Implementing Classes:: AbstractRule

public interface Rule

A Rule has the ability to specify where it would like a node to be positioned in space.

Distribution Licence:
Project B is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
The License is available on the internet here, by writing to Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA, Or locally at the Licence link below.
The copyright to this program is held by it's authors.

Version:: D0.I0.T0

Method Summary

Position[] getDesiredPosition(Map map, int ord)
          Specify where it would like a node to be positioned in space.

int getScale()
          Each call to getDesiredPosition() returns an array of Positions, this method gets the preferred length of that returned array.

void setScale(int scale)
          Each call to getDesiredPosition() returns an array of Positions, this method sets the preferred length of that returned array.

Method Detail

getDesiredPosition

public Position[] getDesiredPosition(Map map,
                                     int ord)

Specify where it would like a node to be positioned in space. Rules return an array of positions where the average of them specifies the real desired position. So to specify a single place simply return an array of one position. The positions are added to the results from all Rules so to specify a single position more strongly, return an array conataining that position many times.
I expect that any Rule will not return more than 30 positions. This expectation may be useful in colouring how many times to include your Position(s) in the array.

setScale

public void setScale(int scale)

Each call to getDesiredPosition() returns an array of Positions, this method sets the preferred length of that returned array. It is only a preferred length, so non-perfect Rules are free to miss by one or 2.

getScale

public int getScale()

Each call to getDesiredPosition() returns an array of Positions, this method gets the preferred length of that returned array.