IPlantView

All Known Implementing Classes:

FXGeometryCanvas
```
public interface IPlantView
```
An interface for classes which create the graphical representations for Plant Views and maintain their current state.

Author:

Jordan Deyton, Robert Smith

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`org.eclipse.swt.widgets.Composite`	`createComposite(org.eclipse.swt.widgets.Composite parent)` Creates a new SWT `Composite` with this object's associated Plant View embedded within it.
`void`	`dispose()` Dispose the plant view and its resources.
`void`	`exportImage()` Exports the view to an image file.
`void`	`pitchCamera(float radians)` Changes the pitch of the camera (rotates up and down).
`void`	`raiseCamera(float distance)` Moves the camera up or down.
`void`	`resetCamera()` Resets the plant view's camera to its default position and orientation.
`void`	`rollCamera(float radians)` Rotates (rolls) the camera right or left.
`void`	`setDefaultCameraXByY()` Sets the camera to face the origin with the X axis horizontal and the Y axis vertical.
`void`	`setDefaultCameraYByZ()` Sets the camera to face the origin with the Y axis horizontal and the Z axis vertical.
`void`	`setDefaultCameraZByX()` Sets the camera to face the origin with the Z axis horizontal and the X axis vertical.
`void`	`setPlant(IPlantData plant)` Set the IPlantData object from which the view will render.
`void`	`setWireframe(boolean wireframe)` Sets all rendered plant components to be viewed as wireframes or as solid objects.
`void`	`strafeCamera(float distance)` Moves the camera right or left.
`void`	`thrustCamera(float distance)` Moves the camera forward or backward.
`void`	`yawCamera(float radians)` Changes the yaw of the camera right or left.

- Method Detail
  - createComposite
```
org.eclipse.swt.widgets.Composite createComposite(org.eclipse.swt.widgets.Composite parent)
```
    Creates a new SWT Composite with this object's associated Plant View embedded within it.
    
    Parameters:
    
    parent - The parent Composite.
    
    Returns:
    
    The Composite that has an embedded visualization managed by this PlantState. This Composite's layout should be set by the caller. This Composite should be disposed when it is no longer required.
  - dispose
```
void dispose()
```
    Dispose the plant view and its resources.
  - exportImage
```
void exportImage()
```
    Exports the view to an image file. The user is prompted for the image location.
  - resetCamera
```
void resetCamera()
```
    Resets the plant view's camera to its default position and orientation.
    
    See Also:
    
    #setDefaultCameraPosition(Vector3f), #setDefaultCameraOrientation(Vector3f, Vector3f)
  - setDefaultCameraYByZ
```
void setDefaultCameraYByZ()
```
    Sets the camera to face the origin with the Y axis horizontal and the Z axis vertical. This will also be the new default position reset to when case resetCamera() is called.
  - setDefaultCameraXByY
```
void setDefaultCameraXByY()
```
    Sets the camera to face the origin with the X axis horizontal and the Y axis vertical. This will also be the new default position reset to when case resetCamera() is called.
  - setDefaultCameraZByX
```
void setDefaultCameraZByX()
```
    Sets the camera to face the origin with the Z axis horizontal and the X axis vertical. This will also be the new default position reset to when case resetCamera() is called.
  - setPlant
```
void setPlant(IPlantData plant)
```
    Set the IPlantData object from which the view will render.
    
    Parameters:
    
    plant - The new data source for the view.
  - setWireframe
```
void setWireframe(boolean wireframe)
```
    Sets all rendered plant components to be viewed as wireframes or as solid objects.
    
    Parameters:
    
    wireframe - If true, plant components will be rendered with wireframes. If false, they will be rendered solid.
  - thrustCamera
```
void thrustCamera(float distance)
```
    Moves the camera forward or backward.
    
    Parameters:
    
    distance - If positive, the camera moves forward. If negative, the camera moves backward.
  - strafeCamera
```
void strafeCamera(float distance)
```
    Moves the camera right or left.
    
    Parameters:
    
    distance - If positive, the camera moves right. If negative, the camera moves left.
  - raiseCamera
```
void raiseCamera(float distance)
```
    Moves the camera up or down.
    
    Parameters:
    
    distance - If positive, the camera moves up. If negative, the camera moves down.
  - rollCamera
```
void rollCamera(float radians)
```
    Rotates (rolls) the camera right or left.
    
    Parameters:
    
    radians - If positive, the camera rolls right. If negative, the camera rolls left.
  - pitchCamera
```
void pitchCamera(float radians)
```
    Changes the pitch of the camera (rotates up and down).
    
    Parameters:
    
    radians - If positive, the camera pitches up. If negative, the camera pitches down.
  - yawCamera
```
void yawCamera(float radians)
```
    Changes the yaw of the camera right or left.
    
    Parameters:
    
    radians - If positive, the camera rotates right. If negative, the camera rotates left.

Interface IPlantView

Method Summary

Method Detail

createComposite

dispose

exportImage

resetCamera

setDefaultCameraYByZ

setDefaultCameraXByY

setDefaultCameraZByX

setPlant

setWireframe

thrustCamera

strafeCamera

raiseCamera

rollCamera

pitchCamera

yawCamera