Region (ZVTM-ZUIST 0.12.0 API)

java.lang.Object
- fr.inria.zuist.engine.Region

```
public class Region
extends Object
```
A region in the scene. Regions contain objects. Regions belong to levels, and can span one or more contiguous level(s).

Author:

Emmanuel Pietriga

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`APPEAR` Objects appear immediately (no animated transition).
`static String`	`APPEAR_STR` Objects disappear immediately (no animated transition), keyword in ZUIST XML vocabulary.
`static short`	`DISAPPEAR` Objects disappear immediately (no animated transition).
`static String`	`DISAPPEAR_STR` Objects disappear immediately (no animated transition), keyword in ZUIST XML vocabulary.
`static short`	`FADE_IN` Objects appear gradually (animated fade-in transition).
`static String`	`FADE_IN_STR` Objects appear gradually (animated fade-in transition), keyword in ZUIST XML vocabulary.
`static short`	`FADE_OUT` Objects disappear gradually (animated fade-out transition).
`static String`	`FADE_OUT_STR` Objects disappear gradually (animated fade-out transition), keyword in ZUIST XML vocabulary..
`static short`	`ORDERING_ARRAY`
`static String`	`ORDERING_ARRAY_STR`
`static short`	`ORDERING_DISTANCE`
`static String`	`ORDERING_DISTANCE_STR`
`static short`	`TASL` Entering/leaving region: already in level range (transition at same level).
`static short`	`TFLL` Entering region: approaching from lower level.
`static short`	`TFUL` Entering region: approaching from upper level.
`static short`	`TTLL` Leaving region: going to lower level.
`static short`	`TTUL` Leaving region: going to upper level.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addContainedRegion(Region r)`
`void`	`addObject(ObjectDescription od)`
`void`	`addTag(String tag)`
`boolean`	`coordInside(double vx, double vy)`
`Region`	`getContainingRegion()` Get containing region, if any has been declared.
`Vector<Region>`	`getContainingRegions(Vector<Region> cr)` Get containing regions recursively, if any have been declared.
`double`	`getHeight()` Get this region's height.
`int`	`getHighestLevel()` Get index of highest and lowest levels this region belongs to.
`String`	`getID()` Get Region ID.
`int`	`getLowestLevel()` Get index of highest and lowest levels this region belongs to.
`ObjectDescription[]`	`getObjectsInRegion()` Get objects in this region.
`String[]`	`getTags()`
`String`	`getTitle()` Get Region title.
`double`	`getWidth()` Get this region's width.
`double`	`getX()` Get this region's center x-coordinate.
`double`	`getY()` Get this region's center y-coordinate.
`boolean`	`hasTag(String tag)`
`void`	`moveTo(double x, double y)` Set this region's center (x,y)-coordinates.
`void`	`removeTag(String tag)`
`void`	`setContainingRegion(Region r)`
`static void`	`setDefaultTransitions(short from, short to)`
`void`	`setGeometry(double x, double y, double w, double h)` Set this region's center (x,y)-coordinates, width and height.
`void`	`setHeight(double h)` Set this region's height.
`void`	`setTitle(String t)` Set Region title.
`void`	`setWidth(double w)` Set this region's width.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FADE_IN
```
public static final short FADE_IN
```
    Objects appear gradually (animated fade-in transition).
    
    See Also:
    
    Constant Field Values
  - FADE_OUT
```
public static final short FADE_OUT
```
    Objects disappear gradually (animated fade-out transition).
    
    See Also:
    
    Constant Field Values
  - APPEAR
```
public static final short APPEAR
```
    Objects appear immediately (no animated transition).
    
    See Also:
    
    Constant Field Values
  - DISAPPEAR
```
public static final short DISAPPEAR
```
    Objects disappear immediately (no animated transition).
    
    See Also:
    
    Constant Field Values
  - FADE_IN_STR
```
public static final String FADE_IN_STR
```
    Objects appear gradually (animated fade-in transition), keyword in ZUIST XML vocabulary.
    
    See Also:
    
    Constant Field Values
  - FADE_OUT_STR
```
public static final String FADE_OUT_STR
```
    Objects disappear gradually (animated fade-out transition), keyword in ZUIST XML vocabulary..
    
    See Also:
    
    Constant Field Values
  - APPEAR_STR
```
public static final String APPEAR_STR
```
    Objects disappear immediately (no animated transition), keyword in ZUIST XML vocabulary.
    
    See Also:
    
    Constant Field Values
  - DISAPPEAR_STR
```
public static final String DISAPPEAR_STR
```
    Objects disappear immediately (no animated transition), keyword in ZUIST XML vocabulary.
    
    See Also:
    
    Constant Field Values
  - TFUL
```
public static final short TFUL
```
    Entering region: approaching from upper level.
    
    See Also:
    
    Constant Field Values
  - TFLL
```
public static final short TFLL
```
    Entering region: approaching from lower level.
    
    See Also:
    
    Constant Field Values
  - TTUL
```
public static final short TTUL
```
    Leaving region: going to upper level.
    
    See Also:
    
    Constant Field Values
  - TTLL
```
public static final short TTLL
```
    Leaving region: going to lower level.
    
    See Also:
    
    Constant Field Values
  - TASL
```
public static final short TASL
```
    Entering/leaving region: already in level range (transition at same level). Not stored, always appear/disappear as this is always off screen.
    
    See Also:
    
    Constant Field Values
  - ORDERING_ARRAY
```
public static final short ORDERING_ARRAY
```
    See Also:
    
    Constant Field Values
  - ORDERING_DISTANCE
```
public static final short ORDERING_DISTANCE
```
    See Also:
    
    Constant Field Values
  - ORDERING_ARRAY_STR
```
public static final String ORDERING_ARRAY_STR
```
    See Also:
    
    Constant Field Values
  - ORDERING_DISTANCE_STR
```
public static final String ORDERING_DISTANCE_STR
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setDefaultTransitions
```
public static void setDefaultTransitions(short from,
                                         short to)
```
  - getID
```
public String getID()
```
    Get Region ID.
  - hasTag
```
public boolean hasTag(String tag)
```
  - addTag
```
public void addTag(String tag)
```
  - removeTag
```
public void removeTag(String tag)
```
  - getTags
```
public String[] getTags()
```
    Returns:
    
    null if no tags attached
  - setTitle
```
public void setTitle(String t)
```
    Set Region title.
  - getTitle
```
public String getTitle()
```
    Get Region title.
  - getHighestLevel
```
public int getHighestLevel()
```
    Get index of highest and lowest levels this region belongs to.
  - getLowestLevel
```
public int getLowestLevel()
```
    Get index of highest and lowest levels this region belongs to.
  - getContainingRegion
```
public Region getContainingRegion()
```
    Get containing region, if any has been declared.
    
    Returns:
    
    null if no containing region declared
  - getContainingRegions
```
public Vector<Region> getContainingRegions(Vector<Region> cr)
```
    Get containing regions recursively, if any have been declared.
    
    Parameters:
    
    cr - an initially empty Vector that will be recursively populated with containing regions up to the root.
    
    Returns:
    
    cr populated with additional regions if any declared.
  - getObjectsInRegion
```
public ObjectDescription[] getObjectsInRegion()
```
    Get objects in this region.
    
    Returns:
    
    the actual list, not a clone. Do not temper with.
  - getX
```
public double getX()
```
    Get this region's center x-coordinate.
  - getY
```
public double getY()
```
    Get this region's center y-coordinate.
  - getWidth
```
public double getWidth()
```
    Get this region's width.
  - getHeight
```
public double getHeight()
```
    Get this region's height.
  - moveTo
```
public void moveTo(double x,
                   double y)
```
    Set this region's center (x,y)-coordinates.
  - setWidth
```
public void setWidth(double w)
```
    Set this region's width.
  - setHeight
```
public void setHeight(double h)
```
    Set this region's height.
  - setGeometry
```
public void setGeometry(double x,
                        double y,
                        double w,
                        double h)
```
    Set this region's center (x,y)-coordinates, width and height.
  - addObject
```
public void addObject(ObjectDescription od)
```
  - setContainingRegion
```
public void setContainingRegion(Region r)
```
  - addContainedRegion
```
public void addContainedRegion(Region r)
```
  - coordInside
```
public boolean coordInside(double vx,
                           double vy)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Copyright © 2000-2002 Xerox Corporation. All Rights Reserved
Copyright © 2003 World Wide Web Consortium. All Rights Reserved
Copyright © 2004-2015 INRIA. All Rights Reserved
Licensed under the GNU LGPL. For full terms see the file COPYING.

Class Region

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FADE_IN

FADE_OUT

APPEAR

DISAPPEAR

FADE_IN_STR

FADE_OUT_STR

APPEAR_STR

DISAPPEAR_STR

TFUL

TFLL

TTUL

TTLL

TASL

ORDERING_ARRAY

ORDERING_DISTANCE

ORDERING_ARRAY_STR

ORDERING_DISTANCE_STR

Method Detail

setDefaultTransitions

getID

hasTag

addTag

removeTag

getTags

setTitle

getTitle

getHighestLevel

getLowestLevel

getContainingRegion

getContainingRegions

getObjectsInRegion

getX

getY

getWidth

getHeight

moveTo

setWidth

setHeight

setGeometry

addObject

setContainingRegion

addContainedRegion

coordInside

toString