BasicCameraController

java.lang.Object
- org.eclipse.eavp.viz.service.javafx.internal.scene.camera.BasicCameraController

All Implemented Interfaces:

ICameraController

Direct Known Subclasses:

ArcBallCameraController, CenteredCameraController, FPSCameraController, TopDownCameraController, TurntableCameraController
```
public abstract class BasicCameraController
extends java.lang.Object
implements ICameraController
```
An abstract implementation of a CameraController which features shared data members and generic camera functionality.

Author:

Tony McCrary (tmccrary@l33tlabs.com), Robert Smith

Constructor Summary

Constructors
Constructor and Description
`BasicCameraController(javafx.scene.Camera camera, javafx.scene.Scene scene, javafx.embed.swt.FXCanvas canvas)` The default constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`handleKeyPressed(javafx.scene.input.KeyEvent event)` This function defines the camera's behavior when a keyboard button is pressed.
`abstract void`	`handleMouseDragged(javafx.scene.input.MouseEvent event)` This function defines the camera's behavior when the mouse is dragged.
`abstract void`	`handleMousePressed(javafx.scene.input.MouseEvent event)` This function defines the camera's behavior when a mouse button is pressed.
`abstract void`	`handleMouseReleased(javafx.scene.input.MouseEvent event)` This function defines the camera's behavior when a mouse button is released.
`abstract void`	`handleMouseScroll(javafx.scene.input.ScrollEvent event)` This function defines the camera's behavior when the mouse wheel is scrolled.
`abstract void`	`pitchCamera(double radians)` Change the camera's pitch, its rotation about the axis perpendicular to its heading to the right, controlling how it is pointed in an up/down direction.
`abstract void`	`raiseCamera(double distance)` Move the camera to the up or down, orthogonal to the direction it is pointing.
`abstract void`	`reset()` Resets the camera to its default position.
`abstract void`	`rollCamera(double radians)` Change the camera's roll, it's rotation about the axis it is pointing.
`void`	`setDefaultAngle(double x, double y, double z)` Set the default angle for the camera.
`abstract void`	`strafeCamera(double distance)` Move the camera to the left or right, orthogonal to the direction it is pointing.
`abstract void`	`thrustCamera(double distance)` Move the camera forward or backwards in the direction it is pointing.
`abstract void`	`yawCamera(double radians)` Change the camera's yaw, its rotation about the axis perpendicular to its heading in to the above, controlling how it is pointed in a left/right direction.

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

- Constructor Detail
  - BasicCameraController
```
public BasicCameraController(javafx.scene.Camera camera,
                             javafx.scene.Scene scene,
                             javafx.embed.swt.FXCanvas canvas)
```
    The default constructor.
    
    Parameters:
    
    camera - The camera this controller will manage.
    
    scene - The scene the camera is viewing.
    
    canvas - The FXCanvas containing the scene.
- Method Detail
  - handleKeyPressed
```
public abstract void handleKeyPressed(javafx.scene.input.KeyEvent event)
```
    This function defines the camera's behavior when a keyboard button is pressed. By default, it does nothing. It is intended to be overwritten by subclasses.
    
    Parameters:
    
    event - An event sent to the scene.
  - handleMouseDragged
```
public abstract void handleMouseDragged(javafx.scene.input.MouseEvent event)
```
    This function defines the camera's behavior when the mouse is dragged. By default, it does nothing. It is intended to be overwritten by subclasses.
    
    Parameters:
    
    event - An event sent to the scene.
  - handleMousePressed
```
public abstract void handleMousePressed(javafx.scene.input.MouseEvent event)
```
    This function defines the camera's behavior when a mouse button is pressed. By default, it does nothing. It is intended to be overwritten by subclasses.
    
    Parameters:
    
    event - An event sent to the scene.
  - handleMouseReleased
```
public abstract void handleMouseReleased(javafx.scene.input.MouseEvent event)
```
    This function defines the camera's behavior when a mouse button is released. By default, it does nothing. It is intended to be overwritten by subclasses.
    
    Parameters:
    
    event - An event sent to the scene.
  - handleMouseScroll
```
public abstract void handleMouseScroll(javafx.scene.input.ScrollEvent event)
```
    This function defines the camera's behavior when the mouse wheel is scrolled. By default, it does nothing. It is intended to be overwritten by subclasses.
    
    Parameters:
    
    event - An event sent to the scene.
  - reset
```
public abstract void reset()
```
    Description copied from interface: ICameraController
    
    Resets the camera to its default position.
    
    Specified by:
    
    reset in interface ICameraController
  - pitchCamera
```
public abstract void pitchCamera(double radians)
```
    Description copied from interface: ICameraController
    
    Change the camera's pitch, its rotation about the axis perpendicular to its heading to the right, controlling how it is pointed in an up/down direction.
    
    Specified by:
    
    pitchCamera in interface ICameraController
    
    Parameters:
    
    radians - The number of radians by which to rotate the camera.
  - rollCamera
```
public abstract void rollCamera(double radians)
```
    Description copied from interface: ICameraController
    
    Change the camera's roll, it's rotation about the axis it is pointing.
    
    Specified by:
    
    rollCamera in interface ICameraController
    
    Parameters:
    
    radians - The number of radians by which to rotate the camera.
  - raiseCamera
```
public abstract void raiseCamera(double distance)
```
    Description copied from interface: ICameraController
    
    Move the camera to the up or down, orthogonal to the direction it is pointing.
    
    Specified by:
    
    raiseCamera in interface ICameraController
    
    Parameters:
    
    distance - The amount of space to move the camera. Positive distances move the camera up, negative distances move it down.
  - strafeCamera
```
public abstract void strafeCamera(double distance)
```
    Description copied from interface: ICameraController
    
    Move the camera to the left or right, orthogonal to the direction it is pointing.
    
    Specified by:
    
    strafeCamera in interface ICameraController
    
    Parameters:
    
    distance - The amount of space to move the camera. Positive distances move the camera right, negative distances move it left.
  - thrustCamera
```
public abstract void thrustCamera(double distance)
```
    Description copied from interface: ICameraController
    
    Move the camera forward or backwards in the direction it is pointing.
    
    Specified by:
    
    thrustCamera in interface ICameraController
    
    Parameters:
    
    distance - The amount of space to move the camera. Positive distances move the camera forward, negative distances move it backwards.
  - yawCamera
```
public abstract void yawCamera(double radians)
```
    Description copied from interface: ICameraController
    
    Change the camera's yaw, its rotation about the axis perpendicular to its heading in to the above, controlling how it is pointed in a left/right direction.
    
    Specified by:
    
    yawCamera in interface ICameraController
    
    Parameters:
    
    radians - The number of radians by which to rotate the camera.
  - setDefaultAngle
```
public void setDefaultAngle(double x,
                            double y,
                            double z)
```
    Description copied from interface: ICameraController
    
    Set the default angle for the camera. This will be used when reset() is called.
    
    Specified by:
    
    setDefaultAngle in interface ICameraController
    
    Parameters:
    
    x - The number of degrees of X axis rotation.
    
    y - The number of degrees of Y axis rotation.
    
    z - The number of degrees of Z axis rotation.

Class BasicCameraController

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BasicCameraController

Method Detail

handleKeyPressed

handleMouseDragged

handleMousePressed

handleMouseReleased

handleMouseScroll

reset

pitchCamera

rollCamera

raiseCamera

strafeCamera

thrustCamera

yawCamera

setDefaultAngle