org.omegahat.Graphics.Primitives
Interface RegionDescriptionInt

All Known Subinterfaces:
AllocatorRegionDescriptionInt
All Known Implementing Classes:
RectRegionDescription

public interface RegionDescriptionInt

A potentially symbolic description of a Region's shape, that is location and dimension. The actual dimensions, etc. are computed when the associated Region is drawn and the dimensions of its parent are known and passed to this interface's compute() method.


Method Summary
 RectRegion compute(ScaleInt sx, ScaleInt sy, int origin, double widthCM, double heightCM, int fontsize, GraphicalContainerInt parentId)
          Compute the actual bounding box described by this region description in terms of the normalized dimensions of its parent container, that is NPC.
 UDouble getHeight()
          Retrieve the vertical dimension and unit for this object.
 int getHJust()
          Retrieve the type for the horizontal justification for this object.
 int getVJust()
          Retrieve the type for the vertical justification for this object.
 UDouble getWidth()
          Retrieve the horizontal dimension and unit for this object.
 UDouble getX()
          Retrieve the horizontal position and unit for this object.
 UDouble getY()
          Retrieve the vertical position and unit for this object.
 UDouble setHeight(UDouble w)
          Set the value and unit of the vertical dimension of this description.
 int setHJust(int v)
          Set the type for the horizontal justification for this object.
 int setVJust(int v)
          Set the type for the vertical justification for this object.
 UDouble setWidth(UDouble w)
          Set the value and unit of the horizontal dimension of this description.
 UDouble setX(UDouble w)
          Set the value and unit of the horizontal location of this description.
 UDouble setY(UDouble w)
          Set the value and unit of the vertical location of this description.
 

Method Detail

compute

public RectRegion compute(ScaleInt sx,
                          ScaleInt sy,
                          int origin,
                          double widthCM,
                          double heightCM,
                          int fontsize,
                          GraphicalContainerInt parentId)
Compute the actual bounding box described by this region description in terms of the normalized dimensions of its parent container, that is NPC.
Parameters:
sx - parent container's horizontal ScaleInt object for transforming coordinates in that space.
sy - parent container's vertical ScaleInt object for transforming coordinates in that space.

setX

public UDouble setX(UDouble w)
Set the value and unit of the horizontal location of this description.

setY

public UDouble setY(UDouble w)
Set the value and unit of the vertical location of this description.

setWidth

public UDouble setWidth(UDouble w)
Set the value and unit of the horizontal dimension of this description.

setHeight

public UDouble setHeight(UDouble w)
Set the value and unit of the vertical dimension of this description.

setHJust

public int setHJust(int v)
Set the type for the horizontal justification for this object.

setVJust

public int setVJust(int v)
Set the type for the vertical justification for this object.

getX

public UDouble getX()
Retrieve the horizontal position and unit for this object.

getY

public UDouble getY()
Retrieve the vertical position and unit for this object.

getWidth

public UDouble getWidth()
Retrieve the horizontal dimension and unit for this object.

getHeight

public UDouble getHeight()
Retrieve the vertical dimension and unit for this object.

getHJust

public int getHJust()
Retrieve the type for the horizontal justification for this object.

getVJust

public int getVJust()
Retrieve the type for the vertical justification for this object.