facets.core.app.avatar
Interface PlaneView

All Superinterfaces:
AvatarView, SView, Titled
All Known Subinterfaces:
ZoomPanView
All Known Implementing Classes:
PlaneViewWorks, ZoomPanViewWorks

public interface PlaneView
extends AvatarView

Policy for a custom viewer that plots to an unbounded plane.


Nested Class Summary
static class PlaneView.ResizeResponse
          Possible responses to resizing of the viewer managed by a PlaneView.
 
Field Summary
static double INCH_PTS
           
static java.lang.String ZOOM_IN
           
static java.lang.String ZOOM_OUT
           
 
Fields inherited from interface facets.core.superficial.app.SView
NO_VIEW
 
Method Summary
 Vector plotShift()
          The location of the viewport origin.
 PlaneView.ResizeResponse resizeResponse()
          Does the view adjust its scale or its shape if the viewer facet is resized?
 double scale()
           
 void setShowValues(double width, double height, Vector plotShift, double scale)
          Set the view area.
 double showHeight()
          The minimum unscaled height of the viewport onto the plane.
 double showWidth()
          The minimum unscaled width of the viewport onto the plane.
 java.lang.Object stamp()
          Identifier that should change with each change in view properties.
 int ySign()
          Which way up is the unscaled Y axis?.
 
Methods inherited from interface facets.core.app.avatar.AvatarView
avatars, backgroundStyle, doesDnD, markLeapPixels, markPixels, pickHitPixels
 
Methods inherited from interface facets.core.superficial.app.SView
allowMultipleSelection, isLive
 
Methods inherited from interface facets.util.Titled
title
 

Field Detail

ZOOM_OUT

static final java.lang.String ZOOM_OUT
See Also:
Constant Field Values

ZOOM_IN

static final java.lang.String ZOOM_IN
See Also:
Constant Field Values

INCH_PTS

static final double INCH_PTS
See Also:
Constant Field Values
Method Detail

showHeight

double showHeight()
The minimum unscaled height of the viewport onto the plane.

Returns:
a positive double

showWidth

double showWidth()
The minimum unscaled width of the viewport onto the plane.

Returns:
a positive double

ySign

int ySign()
Which way up is the unscaled Y axis?.

Returns:
either +1 or -1.

plotShift

Vector plotShift()
The location of the viewport origin.

Returns:
any Vector

resizeResponse

PlaneView.ResizeResponse resizeResponse()
Does the view adjust its scale or its shape if the viewer facet is resized?


setShowValues

void setShowValues(double width,
                   double height,
                   Vector plotShift,
                   double scale)
Set the view area.

Parameters:
width - will be returned as showWidth()
height - will be returned as showHeight()
plotShift - will be returned as plotShift()
scale - will be returned as

stamp

java.lang.Object stamp()
Identifier that should change with each change in view properties.

Returns:
typically an Integer containing an auto-incremented value

scale

double scale()