org.eclipse.eavp.viz.service.javafx.geometry

Class FXGeometryCanvas

java.lang.Object

org.eclipse.eavp.viz.service.javafx.canvas.FXVizCanvas

org.eclipse.eavp.viz.service.javafx.geometry.FXGeometryCanvas

All Implemented Interfaces:

IVizCanvas, IPlantView

public class FXGeometryCanvas
extends FXVizCanvas
implements IPlantView

An extension for FXVizCanvas that implements functionality for the Geometry Editor.

Author:

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

Constructor Summary

Constructors

Constructor and Description
FXGeometryCanvas(Geometry source) The default constructor.

Method Summary

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.

Methods inherited from class org.eclipse.eavp.viz.service.javafx.canvas.FXVizCanvas

addRoot, draw, getDataSource, getNumberOfAxes, getProperties, getRenderElementHolder, getSourceHost, getViewer, isSourceRemote, redraw, removeRoot, setProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

FXGeometryCanvas

public FXGeometryCanvas(Geometry source)

The default constructor.

Parameters:

source - The geometry to be displayed in the canvas.

Method Detail

createComposite

public org.eclipse.swt.widgets.Composite createComposite(org.eclipse.swt.widgets.Composite parent)

Description copied from interface: IPlantView

Creates a new SWT Composite with this object's associated Plant View embedded within it.

Specified by:

createComposite in interface IPlantView

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.

exportImage

public void exportImage()

Description copied from interface: IPlantView

Exports the view to an image file. The user is prompted for the image location.

Specified by:

exportImage in interface IPlantView

resetCamera

public void resetCamera()

Description copied from interface: IPlantView

Resets the plant view's camera to its default position and orientation.

Specified by:

resetCamera in interface IPlantView

See Also:

#setDefaultCameraPosition(Vector3f), #setDefaultCameraOrientation(Vector3f, Vector3f)

setWireframe

public void setWireframe(boolean wireframe)

Description copied from interface: IPlantView

Sets all rendered plant components to be viewed as wireframes or as solid objects.

Specified by:

setWireframe in interface IPlantView

Parameters:

wireframe - If true, plant components will be rendered with wireframes. If false, they will be rendered solid.

thrustCamera

public void thrustCamera(float distance)

Description copied from interface: IPlantView

Moves the camera forward or backward.

Specified by:

thrustCamera in interface IPlantView

Parameters:

distance - If positive, the camera moves forward. If negative, the camera moves backward.

strafeCamera

public void strafeCamera(float distance)

Description copied from interface: IPlantView

Moves the camera right or left.

Specified by:

strafeCamera in interface IPlantView

Parameters:

distance - If positive, the camera moves right. If negative, the camera moves left.

raiseCamera

public void raiseCamera(float distance)

Description copied from interface: IPlantView

Moves the camera up or down.

Specified by:

raiseCamera in interface IPlantView

Parameters:

distance - If positive, the camera moves up. If negative, the camera moves down.

rollCamera

public void rollCamera(float radians)

Description copied from interface: IPlantView

Rotates (rolls) the camera right or left.

Specified by:

rollCamera in interface IPlantView

Parameters:

radians - If positive, the camera rolls right. If negative, the camera rolls left.

pitchCamera

public void pitchCamera(float radians)

Description copied from interface: IPlantView

Changes the pitch of the camera (rotates up and down).

Specified by:

pitchCamera in interface IPlantView

Parameters:

radians - If positive, the camera pitches up. If negative, the camera pitches down.

yawCamera

public void yawCamera(float radians)

Description copied from interface: IPlantView

Changes the yaw of the camera right or left.

Specified by:

yawCamera in interface IPlantView

Parameters:

radians - If positive, the camera rotates right. If negative, the camera rotates left.

setDefaultCameraYByZ

public void setDefaultCameraYByZ()

Description copied from interface: IPlantView

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.

Specified by:

setDefaultCameraYByZ in interface IPlantView

setDefaultCameraXByY

public void setDefaultCameraXByY()

Description copied from interface: IPlantView

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.

Specified by:

setDefaultCameraXByY in interface IPlantView

setDefaultCameraZByX

public void setDefaultCameraZByX()

Description copied from interface: IPlantView

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.

Specified by:

setDefaultCameraZByX in interface IPlantView

dispose

public void dispose()

Description copied from interface: IPlantView

Dispose the plant view and its resources.

Specified by:

dispose in interface IPlantView

setPlant

public void setPlant(IPlantData plant)

Description copied from interface: IPlantView

Set the IPlantData object from which the view will render.

Specified by:

setPlant in interface IPlantView

Parameters:

plant - The new data source for the view.