SLCamera (Snifflib API)

java.lang.Object
- com.mockturtlesolutions.snifflib.graphics.SLCamera

All Implemented Interfaces:: SLComponentEventListener, SLLocator, java.util.EventListener

public class SLCamera
extends java.lang.Object
implements SLLocator, SLComponentEventListener

Field Summary

Fields
Modifier and Type	Field and Description
`protected DblMatrix[]`	`cameraBasis`
`protected DblMatrix`	`focus`
`static int`	`ORTHO_PERSPECTIVE`
`protected DblMatrix`	`phi`
`protected DblMatrix`	`psi`
`static int`	`SIMPLE_PERSPECTIVE`
`protected DblMatrix`	`theta`
`static int`	`X_AXIS`
`protected DblMatrix`	`XLim`
`static int`	`Y_AXIS`
`protected DblMatrix`	`YLim`
`static int`	`Z_AXIS`
`protected DblMatrix`	`ZLim`

Constructor Summary

Constructors
Constructor and Description

SLCamera(SLAxes p)

Constructors
Constructor and Description
`SLCamera(SLAxes p)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`actionPerformed(SLComponentEvent e)` Respond to updates in the positions/coordinates of existing components.
`void`	`addChangeListener(SLCameraChangeListener l)`
`void`	`centerView()` Pans the camera left/right and up/down to place the center the scene in the center of the frame.
`void`	`componentAdded(SLComponentEvent e)` This method is called when a component has been added.
`void`	`componentModified(SLComponentEvent e)`
`void`	`componentRemoved(SLComponentEvent e)`
`void`	`fireSLCameraChangeEvent(SLCameraChangeEvent ev)`
`DblMatrix[]`	`getCameraBasis()`
`DblMatrix`	`getCameraDirection()` Returns a unit vector (centered at the origin) indicating the direction of the camera.
`static DblMatrix`	`getCameraDirection(DblMatrix[] camBasis, DblMatrix camPos)` Returns a unit vector (centered at the origin) indicating the direction of the camera.
`java.lang.String`	`getCameraName()`
`DblMatrix`	`getCameraPosition()`
`DblMatrix`	`getCameraStarboardDirection()` Returns a unit vector (centered at the origin) indicating the direction to the right of the camera.
`static DblMatrix`	`getCameraStarboardDirection(DblMatrix[] camBasis, DblMatrix camPos)` Returns a unit vector (centered at the origin) indicating the direction to the right of the camera.
`DblMatrix`	`getCameraUpDirection()` Returns a unit vector (centered at the origin) indicating the direction up from the camera.
`static DblMatrix`	`getCameraUpDirection(DblMatrix[] camBasis, DblMatrix camPos)` Returns a unit vector (centered at the origin) indicating the direction up from the camera.
`DblMatrix`	`getCoordinate(double[] pixel)` Return the actual coordinates for the given pixel.
`DblMatrix`	`getCoordinate(int[] pixel)` Return the actual coordinates for the given pixel.
`int[]`	`getDataBoundingBox()`
`DblMatrix`	`getDataUnitsPerPixel()` This method does not adjust or account for digital zoom.
`DblMatrix`	`getDigitalZoom()`
`int`	`getNumberOfComponents()`
`SLAxes`	`getParent()`
`int`	`getPerspectiveType()`
`DblMatrix`	`getPhi()`
`int[]`	`getPixel(DblMatrix cx, DblMatrix cy)` Get the screen pixels of the given data (camera focus plane) coordinates using this SLLocator.
`int[]`	`getPixel(DblMatrix x, DblMatrix y, DblMatrix z)`
`DblMatrix`	`getPixelAsDbl(DblMatrix x, DblMatrix y)`
`DblMatrix`	`getPixelAsDbl(DblMatrix x, DblMatrix y, DblMatrix z)`
`float[]`	`getPixelAsFloat(DblMatrix x, DblMatrix y)`
`float[]`	`getPixelAsFloat(DblMatrix x, DblMatrix y, DblMatrix z)`
`DblMatrix`	`getPsi()`
`int[]`	`getScreenPixel(DblMatrix cx, DblMatrix cy)` Get the physical screen pixels of the given data (camera focus plane) coordinates using this SLLocator.
`DblMatrix`	`getTheta()`
`java.awt.Dimension`	`getViewableBoundingBox()` Get's the size of the parent container (usually axes) in pixels.
`DblMatrix`	`getXDataUnitsPerPixel()` This method does not adjust or account for digital zoom.
`DblMatrix`	`getXLim()`
`DblMatrix`	`getYDataUnitsPerPixel()` This method does not adjust or account for digital zoom.
`DblMatrix`	`getYLim()`
`DblMatrix`	`getZLim()`
`void`	`lookAt(DblMatrix lba)` Rotate the view of the camera so that it is looking at the given coordinates.
`void`	`panAbout(DblMatrix reforigin, DblMatrix deltatheta)` Pans the camera horizontally relative to a reference point.
`void`	`panAbout(DblMatrix reforigin, DblMatrix deltatheta, DblMatrix deltaphi)` Pans the camera relative to a reference point.
`void`	`panAbout(DblMatrix reforigin, DblMatrix deltatheta, DblMatrix deltaphi, DblMatrix deltarho)` Pans the camera relative to a reference point.
`void`	`putInFrameUsing(DblMatrix direction)` Moves camera parallel to the given vector (anchored at the origin) until all components are "in frame".
`void`	`putInFrameUsing(int axis)` Zooms the camera along the cardinal axis given so that all components are inside the viewable frame.
`void`	`removeChangeListener(SLCameraChangeListener l)`
`static DblMatrix`	`rotatorFor(DblMatrix tt, DblMatrix U)` Return in R a 3D rotation matrix that rotates an angle theta about the fixed unit vector u.
`void`	`setCameraName(java.lang.String nam)`
`void`	`setCameraPosition(DblMatrix x)`
`void`	`setDigitalZoom(DblMatrix x)`
`void`	`setDigitalZoom(java.lang.Double x)`
`void`	`setPerspectiveType(int L)`
`void`	`setPhi(DblMatrix x)` Sets the angle of rotation away from the z-axis.
`void`	`setPsi(DblMatrix x)` Sets the angle of axial rotation of the camera.
`void`	`setTheta(DblMatrix x)` Sets the angle of rotation away from the x-axis.
`static void`	`updateCameraBasis(DblMatrix[] camBasis, DblMatrix Phi, DblMatrix Theta, DblMatrix Psi, DblMatrix Position)`
`void`	`viewXY()` Sets a view down the z-axis keeping all components in frame.
`void`	`viewXYZ()` Sets camera to standard location for viewing a 3D scene.
`void`	`viewXZ()` Sets a view down the y-axis keeping all components in frame.
`void`	`viewYX()` Sets a view up the z-axis keeping all components in frame.
`void`	`viewYZ()` Sets a view down the x-axis keeping all components in frame.
`void`	`viewZX()` Sets a view up the y-axis keeping all components in frame.
`void`	`viewZY()` Sets a view up the x-axis keeping all components in frame.

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

- Field Detail
  - X_AXIS
```
public static final int X_AXIS
```
    See Also:
    Constant Field Values
  - Y_AXIS
```
public static final int Y_AXIS
```
    See Also:
    Constant Field Values
  - Z_AXIS
```
public static final int Z_AXIS
```
    See Also:
    Constant Field Values
  - ORTHO_PERSPECTIVE
```
public static final int ORTHO_PERSPECTIVE
```
    See Also:
    Constant Field Values
  - SIMPLE_PERSPECTIVE
```
public static final int SIMPLE_PERSPECTIVE
```
    See Also:
    Constant Field Values
  - theta
```
protected DblMatrix theta
```
  - phi
```
protected DblMatrix phi
```
  - psi
```
protected DblMatrix psi
```
  - cameraBasis
```
protected DblMatrix[] cameraBasis
```
  - focus
```
protected DblMatrix focus
```
  - XLim
```
protected DblMatrix XLim
```
  - YLim
```
protected DblMatrix YLim
```
  - ZLim
```
protected DblMatrix ZLim
```
- Constructor Detail
  - SLCamera
```
public SLCamera(SLAxes p)
```
- Method Detail
  - addChangeListener
```
public void addChangeListener(SLCameraChangeListener l)
```
  - removeChangeListener
```
public void removeChangeListener(SLCameraChangeListener l)
```
  - setCameraName
```
public void setCameraName(java.lang.String nam)
```
  - fireSLCameraChangeEvent
```
public void fireSLCameraChangeEvent(SLCameraChangeEvent ev)
```
  - getCameraName
```
public java.lang.String getCameraName()
```
  - getDigitalZoom
```
public DblMatrix getDigitalZoom()
```
  - setDigitalZoom
```
public void setDigitalZoom(DblMatrix x)
```
  - setDigitalZoom
```
public void setDigitalZoom(java.lang.Double x)
```
  - getPerspectiveType
```
public int getPerspectiveType()
```
  - setPerspectiveType
```
public void setPerspectiveType(int L)
```
  - getParent
```
public SLAxes getParent()
```
  - getNumberOfComponents
```
public int getNumberOfComponents()
```
  - componentModified
```
public void componentModified(SLComponentEvent e)
```
  - componentAdded
```
public void componentAdded(SLComponentEvent e)
```
    This method is called when a component has been added.
    
    Specified by:
    
    componentAdded in interface SLComponentEventListener
  - componentRemoved
```
public void componentRemoved(SLComponentEvent e)
```
    Specified by:
    
    componentRemoved in interface SLComponentEventListener
  - actionPerformed
```
public void actionPerformed(SLComponentEvent e)
```
    Respond to updates in the positions/coordinates of existing components.
    
    Specified by:
    
    actionPerformed in interface SLComponentEventListener
  - getCoordinate
```
public DblMatrix getCoordinate(int[] pixel)
```
    Return the actual coordinates for the given pixel. This falls apart in >2D.
    
    Specified by:
    
    getCoordinate in interface SLLocator
  - getDataUnitsPerPixel
```
public DblMatrix getDataUnitsPerPixel()
```
    This method does not adjust or account for digital zoom.
  - getXDataUnitsPerPixel
```
public DblMatrix getXDataUnitsPerPixel()
```
    This method does not adjust or account for digital zoom.
  - getYDataUnitsPerPixel
```
public DblMatrix getYDataUnitsPerPixel()
```
    This method does not adjust or account for digital zoom.
  - getCoordinate
```
public DblMatrix getCoordinate(double[] pixel)
```
    Return the actual coordinates for the given pixel. This falls apart in >2D.
    
    Specified by:
    
    getCoordinate in interface SLLocator
  - getScreenPixel
```
public int[] getScreenPixel(DblMatrix cx,
                   DblMatrix cy)
```
    Get the physical screen pixels of the given data (camera focus plane) coordinates using this SLLocator. Assumed to be in 2D.
  - getPixel
```
public int[] getPixel(DblMatrix cx,
             DblMatrix cy)
```
    Get the screen pixels of the given data (camera focus plane) coordinates using this SLLocator. Assumed to be in 2D.
    
    Specified by:
    
    getPixel in interface SLLocator
  - getPixel
```
public int[] getPixel(DblMatrix x,
             DblMatrix y,
             DblMatrix z)
```
    Specified by:
    
    getPixel in interface SLLocator
  - getViewableBoundingBox
```
public java.awt.Dimension getViewableBoundingBox()
```
    Get's the size of the parent container (usually axes) in pixels. This is always a 2-element vector and represents the screen pixels targeted for painting the camera's view.
  - getDataBoundingBox
```
public int[] getDataBoundingBox()
```
  - updateCameraBasis
```
public static void updateCameraBasis(DblMatrix[] camBasis,
                     DblMatrix Phi,
                     DblMatrix Theta,
                     DblMatrix Psi,
                     DblMatrix Position)
```
  - rotatorFor
```
public static DblMatrix rotatorFor(DblMatrix tt,
                   DblMatrix U)
```
    Return in R a 3D rotation matrix that rotates an angle theta about the fixed unit vector u.
  - setCameraPosition
```
public void setCameraPosition(DblMatrix x)
```
  - getCameraPosition
```
public DblMatrix getCameraPosition()
```
  - getCameraBasis
```
public DblMatrix[] getCameraBasis()
```
  - getCameraDirection
```
public DblMatrix getCameraDirection()
```
    Returns a unit vector (centered at the origin) indicating the direction of the camera.
  - getCameraDirection
```
public static DblMatrix getCameraDirection(DblMatrix[] camBasis,
                           DblMatrix camPos)
```
    Returns a unit vector (centered at the origin) indicating the direction of the camera.
  - getCameraStarboardDirection
```
public DblMatrix getCameraStarboardDirection()
```
    Returns a unit vector (centered at the origin) indicating the direction to the right of the camera.
  - getCameraStarboardDirection
```
public static DblMatrix getCameraStarboardDirection(DblMatrix[] camBasis,
                                    DblMatrix camPos)
```
    Returns a unit vector (centered at the origin) indicating the direction to the right of the camera.
  - getCameraUpDirection
```
public DblMatrix getCameraUpDirection()
```
    Returns a unit vector (centered at the origin) indicating the direction up from the camera.
  - getCameraUpDirection
```
public static DblMatrix getCameraUpDirection(DblMatrix[] camBasis,
                             DblMatrix camPos)
```
    Returns a unit vector (centered at the origin) indicating the direction up from the camera.
  - setTheta
```
public void setTheta(DblMatrix x)
```
    Sets the angle of rotation away from the x-axis.
  - getTheta
```
public DblMatrix getTheta()
```
  - setPhi
```
public void setPhi(DblMatrix x)
```
    Sets the angle of rotation away from the z-axis.
  - getPhi
```
public DblMatrix getPhi()
```
  - setPsi
```
public void setPsi(DblMatrix x)
```
    Sets the angle of axial rotation of the camera.
  - getPsi
```
public DblMatrix getPsi()
```
  - getPixelAsFloat
```
public float[] getPixelAsFloat(DblMatrix x,
                      DblMatrix y)
```
    Specified by:
    
    getPixelAsFloat in interface SLLocator
  - getPixelAsFloat
```
public float[] getPixelAsFloat(DblMatrix x,
                      DblMatrix y,
                      DblMatrix z)
```
    Specified by:
    
    getPixelAsFloat in interface SLLocator
  - getPixelAsDbl
```
public DblMatrix getPixelAsDbl(DblMatrix x,
                      DblMatrix y)
```
    Specified by:
    
    getPixelAsDbl in interface SLLocator
  - getPixelAsDbl
```
public DblMatrix getPixelAsDbl(DblMatrix x,
                      DblMatrix y,
                      DblMatrix z)
```
    Specified by:
    
    getPixelAsDbl in interface SLLocator
  - getXLim
```
public DblMatrix getXLim()
```
    Specified by:
    
    getXLim in interface SLLocator
  - getYLim
```
public DblMatrix getYLim()
```
    Specified by:
    
    getYLim in interface SLLocator
  - getZLim
```
public DblMatrix getZLim()
```
    Specified by:
    
    getZLim in interface SLLocator
  - putInFrameUsing
```
public void putInFrameUsing(int axis)
```
    Zooms the camera along the cardinal axis given so that all components are inside the viewable frame.
  - putInFrameUsing
```
public void putInFrameUsing(DblMatrix direction)
```
    Moves camera parallel to the given vector (anchored at the origin) until all components are "in frame".
  - lookAt
```
public void lookAt(DblMatrix lba)
```
    Rotate the view of the camera so that it is looking at the given coordinates.
  - panAbout
```
public void panAbout(DblMatrix reforigin,
            DblMatrix deltatheta,
            DblMatrix deltaphi,
            DblMatrix deltarho)
```
    Pans the camera relative to a reference point. Imagine that the camera in its current configuration is tethered by a string to a referenc point. Then the specified rotations are applied. In particular, if the camera is currently focused on the reference point then it will continue to be focused on the reference point after the panning.
  - panAbout
```
public void panAbout(DblMatrix reforigin,
            DblMatrix deltatheta,
            DblMatrix deltaphi)
```
    Pans the camera relative to a reference point. The path is on a sphere with radius equal to the current distance between the camera location and the reference point.
  - panAbout
```
public void panAbout(DblMatrix reforigin,
            DblMatrix deltatheta)
```
    Pans the camera horizontally relative to a reference point. The path is on a circle with radius equal to the current distance between the camera location and the reference point.
  - viewXYZ
```
public void viewXYZ()
```
    Sets camera to standard location for viewing a 3D scene.
  - centerView
```
public void centerView()
```
    Pans the camera left/right and up/down to place the center the scene in the center of the frame.
  - viewXY
```
public void viewXY()
```
    Sets a view down the z-axis keeping all components in frame.
  - viewYZ
```
public void viewYZ()
```
    Sets a view down the x-axis keeping all components in frame.
  - viewXZ
```
public void viewXZ()
```
    Sets a view down the y-axis keeping all components in frame.
  - viewYX
```
public void viewYX()
```
    Sets a view up the z-axis keeping all components in frame.
  - viewZY
```
public void viewZY()
```
    Sets a view up the x-axis keeping all components in frame.
  - viewZX
```
public void viewZX()
```
    Sets a view up the y-axis keeping all components in frame.

Class SLCamera

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

X_AXIS

Y_AXIS

Z_AXIS

ORTHO_PERSPECTIVE

SIMPLE_PERSPECTIVE

theta

phi

psi

cameraBasis

focus

XLim

YLim

ZLim

Constructor Detail

SLCamera

Method Detail

addChangeListener

removeChangeListener

setCameraName

fireSLCameraChangeEvent

getCameraName

getDigitalZoom

setDigitalZoom

setDigitalZoom

getPerspectiveType

setPerspectiveType

getParent

getNumberOfComponents

componentModified

componentAdded

componentRemoved

actionPerformed

getCoordinate

getDataUnitsPerPixel

getXDataUnitsPerPixel

getYDataUnitsPerPixel

getCoordinate

getScreenPixel

getPixel

getPixel

getViewableBoundingBox

getDataBoundingBox

updateCameraBasis

rotatorFor

setCameraPosition

getCameraPosition

getCameraBasis

getCameraDirection

getCameraDirection

getCameraStarboardDirection

getCameraStarboardDirection

getCameraUpDirection

getCameraUpDirection

setTheta

getTheta

setPhi

getPhi

setPsi

getPsi

getPixelAsFloat

getPixelAsFloat

getPixelAsDbl

getPixelAsDbl

getXLim

getYLim

getZLim

putInFrameUsing

putInFrameUsing

lookAt

panAbout

panAbout

panAbout

viewXYZ

centerView