fr.inria.zvtm.engine.portals

Class OverviewPortal

java.lang.Object

fr.inria.zvtm.engine.portals.Portal

fr.inria.zvtm.engine.portals.CameraPortal

fr.inria.zvtm.engine.portals.OverviewPortal

public class OverviewPortal
extends CameraPortal

A portal showing what is seen through a camera that serves as an overview. Shape: rectangular. The Camera should not be used in any other View or Portal.

Field Summary

Fields inherited from class fr.inria.zvtm.engine.portals.CameraPortal

borderWidth, halfBorderWidth, stroke

Fields inherited from class fr.inria.zvtm.engine.portals.Portal

cursorInside, h, w, x, y

Constructor Summary

Constructors

Constructor and Description
OverviewPortal(int x, int y, int w, int h, Camera pc, Camera orc) Builds a new portal displaying what is seen through a camera and the region seen through another camera.

Method Summary

Modifier and Type	Method and Description
boolean	coordInsideObservedRegion(int cx, int cy) Is the given point inside the observed region rectangle depicting what is seen through the main camera (viewfinder).
void	dispose()
void	drawObservedRegionLocator(boolean b)
Camera	getObservedRegionCamera()
Color	getObservedRegionColor() Get color of rectangle depicting what is seen through the main camera.
double	getObservedRegionCX()
double	getObservedRegionCY()
double	getObservedRegionH()
AlphaComposite	getObservedRegionTranslucency()
double	getObservedRegionW()
double	getObservedRegionX()
double	getObservedRegionY()
boolean	isDrawObservedRegionLocator()
void	paint(Graphics2D g2d, int viewWidth, int viewHeight)
float	setObservedRegionBorderWidth() Get the border width of the rectangle depicting what is seen through the main camera.
void	setObservedRegionBorderWidth(float bw) Set the border width of the rectangle depicting what is seen through the main camera.
void	setObservedRegionColor(Color c) Set color of rectangle depicting what is seen through the main camera.
void	setObservedRegionListener(ObservedRegionListener orl)
void	setObservedRegionTranslucency(float a)

Methods inherited from class fr.inria.zvtm.engine.portals.CameraPortal

centerOnRegion, centerOnRegion, centerOnRegion, centerOnRegion, coordInside, coordInsideBorder, getBackgroundColor, getBorder, getBorderWidth, getCamera, getCameras, getGlobalView, getGlobalView, getGlobalView, getGlobalView, getPicker, getSeamlessView, getTranslucencyValue, getVisibleRegion, getVisibleRegion, getVisibleRegion, getVSCoordinates, getVSCoordinates, pick, setBackgroundColor, setBorder, setBorderWidth, setOwningView, setTranslucencyValue

Methods inherited from class fr.inria.zvtm.engine.portals.Portal

cursorInOut, getDimensions, getDistanceFromBorders, getOwningView, getPortalListener, isVisible, move, moveTo, resize, setPortalListener, setVisible, sizeTo, updateDimensions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OverviewPortal

public OverviewPortal(int x,
                      int y,
                      int w,
                      int h,
                      Camera pc,
                      Camera orc)

Builds a new portal displaying what is seen through a camera and the region seen through another camera.

Parameters:

x - top-left horizontal coordinate of portal, in parent's JPanel coordinates

y - top-left vertical coordinate of portal, in parent's JPanel coordinates

w - portal width

h - portal height

pc - camera associated with the portal (provinding the overview)

orc - camera observing a region; this region is displayed as an overlay in the portal

Method Detail

drawObservedRegionLocator

public void drawObservedRegionLocator(boolean b)

isDrawObservedRegionLocator

public boolean isDrawObservedRegionLocator()

coordInsideObservedRegion

public boolean coordInsideObservedRegion(int cx,
                                         int cy)

Is the given point inside the observed region rectangle depicting what is seen through the main camera (viewfinder).

Parameters:

cx - cursor x-coordinate (JPanel coordinates system)

cy - cursor y-coordinate (JPanel coordinates system)

setObservedRegionColor

public void setObservedRegionColor(Color c)

Set color of rectangle depicting what is seen through the main camera.

getObservedRegionColor

public Color getObservedRegionColor()

Get color of rectangle depicting what is seen through the main camera.

setObservedRegionTranslucency

public void setObservedRegionTranslucency(float a)

setObservedRegionBorderWidth

public void setObservedRegionBorderWidth(float bw)

Set the border width of the rectangle depicting what is seen through the main camera.

setObservedRegionBorderWidth

public float setObservedRegionBorderWidth()

Get the border width of the rectangle depicting what is seen through the main camera.

getObservedRegionX

public double getObservedRegionX()

getObservedRegionY

public double getObservedRegionY()

getObservedRegionW

public double getObservedRegionW()

getObservedRegionH

public double getObservedRegionH()

getObservedRegionCX

public double getObservedRegionCX()

getObservedRegionCY

public double getObservedRegionCY()

getObservedRegionTranslucency

public AlphaComposite getObservedRegionTranslucency()

Returns:

null if translucency is 1.0f (opaque).

getObservedRegionCamera

public Camera getObservedRegionCamera()

paint

public void paint(Graphics2D g2d,
                  int viewWidth,
                  int viewHeight)

Overrides:

paint in class CameraPortal

dispose

public void dispose()

setObservedRegionListener

public void setObservedRegionListener(ObservedRegionListener orl)