com.jme.renderer
Class AbstractCamera

java.lang.Object
  com.jme.renderer.AbstractCamera

All Implemented Interfaces:

Camera, java.io.Serializable

Direct Known Subclasses:

LWJGLCamera

public abstract class AbstractCamera

extends java.lang.Object

implements Camera

AbstractCamera implments the Camera interface implementing all non-API specific camera calculations. Those requiring API (LWJGL, JOGL, etc) specific calls are not implemented making this class abstract. API specific classes are expected to extend this class and handle renderer viewport setting.

Version:

$Id: AbstractCamera.java,v 1.27 2005/02/25 19:34:04 renanse Exp $

Author:

Mark Powell, Joshua Slack -- Quats

See Also:

Serialized Form

Field Summary

static int	BOTTOM_PLANE BOTTOM_PLANE represents the bottom plane of the camera frustum.
protected float[]	coeffBottom
protected float[]	coeffLeft
protected float[]	coeffRight
protected float[]	coeffTop
protected Vector3f	direction Direction the camera is facing.
static int	FAR_PLANE FAR_PLANE represents the far plane of the camera frustum.
static int	FRUSTUM_PLANES FRUSTUM_PLANES represents the number of planes of the camera frustum.
protected float	frustumBottom Distance from camera to bottom frustum plane.
protected float	frustumFar Distance from camera to far frustum plane.
protected float	frustumLeft Distance from camera to left frustum plane.
protected float	frustumNear Distance from camera to near frustum plane.
protected float	frustumRight Distance from camera to right frustum plane.
protected float	frustumTop Distance from camera to top frustum plane.
protected Vector3f	left Direction of camera's 'left'
static int	LEFT_PLANE LEFT_PLANE represents the left plane of the camera frustum.
protected Vector3f	location Camera's location
protected Vector3f	lookAt Optional Vector3f representing a point this camera is looking at.
static int	MAX_WORLD_PLANES MAX_WORLD_PLANES holds the maximum planes allowed by the system.
static int	NEAR_PLANE NEAR_PLANE represents the near plane of the camera frustum.
protected boolean	overrideLookAt If true, the lookAt vector is used.
protected int	planeQuantity
static int	RIGHT_PLANE RIGHT_PLANE represents the right plane of the camera frustum.
static int	TOP_PLANE TOP_PLANE represents the top plane of the camera frustum.
protected Vector3f	up Direction of 'up' for camera.
protected float	viewPortBottom Percent value on display where vertical viewing begins for this camera.
protected float	viewPortLeft Percent value on display where horizontal viewing starts for this camera.
protected float	viewPortRight Percent value on display where horizontal viewing ends for this camera.
protected float	viewPortTop Percent value on display where vertical viewing ends for this camera.
protected Plane[]	worldPlane Array holding the planes that this camera will check for culling.

Fields inherited from interface com.jme.renderer.Camera

INSIDE_FRUSTUM, INTERSECTS_FRUSTUM, OUTSIDE_FRUSTUM

Constructor Summary

AbstractCamera()
Constructor instantiates a new AbstractCamera object.

Method Summary

int	contains(BoundingVolume bound) culled tests a bounding volume against the planes of the camera's frustum.
Vector3f	getDirection() getDirection retrieves the direction vector the camera is facing.
float	getFrustumBottom() getFrustumBottom returns the value of the bottom frustum plane.
float	getFrustumFar() getFrustumFar gets the value of the far frustum plane.
float	getFrustumLeft() getFrustumLeft gets the value of the left frustum plane.
float	getFrustumNear() getFrustumNear gets the value of the near frustum plane.
float	getFrustumRight() getFrustumRight gets the value of the right frustum plane.
float	getFrustumTop() getFrustumTop gets the value of the top frustum plane.
Vector3f	getLeft() getLeft retrieves the left axis of the camera.
Vector3f	getLocation() getLocation retrieves the location vector of the camera.
int	getPlaneState() getPlaneState returns the state of the frustum planes.
Vector3f	getUp() getUp retrieves the up axis of the camera.
float	getViewPortBottom() getViewPortBottom gets the bottom boundary of the viewport
float	getViewPortLeft() getViewPortLeft gets the left boundary of the viewport
float	getViewPortRight() getViewPortRight gets the right boundary of the viewport
float	getViewPortTop() getViewPortTop gets the top boundary of the viewport
void	lookAt(Vector3f pos) lookAt is a convienence method for auto-setting the frame.
void	onFrameChange() onFrameChange updates the view frame of the camera.
void	onFrustumChange() onFrustumChange updates the frustum to reflect any changes made to the planes.
void	setAxes(Quaternion axes) setAxes uses a rotational matrix to set the axes of the camera.
void	setAxes(Vector3f left, Vector3f up, Vector3f direction) setAxes sets the axes (left, up and direction) for this camera.
void	setDirection(Vector3f direction) setDirection sets the direction this camera is facing.
void	setFrame(Vector3f location, Quaternion axes) setFrame sets the orientation and location of the camera.
void	setFrame(Vector3f location, Vector3f left, Vector3f up, Vector3f direction) setFrame sets the orientation and location of the camera.
void	setFrustum(float near, float far, float left, float right, float top, float bottom) setFrustum sets the frustum of this camera object.
void	setFrustumBottom(float frustumBottom) setFrustumBottom sets the value of the bottom frustum plane.
void	setFrustumFar(float frustumFar) setFrustumFar sets the value of the far frustum plane.
void	setFrustumLeft(float frustumLeft) setFrustumLeft sets the value of the left frustum plane.
void	setFrustumNear(float frustumNear) setFrustumNear sets the value of the near frustum plane.
void	setFrustumPerspective(float fovY, float aspect, float near, float far) setFrustumPerspective defines the frustum for the camera.
void	setFrustumRight(float frustumRight) setFrustumRight sets the value of the right frustum plane.
void	setFrustumTop(float frustumTop) setFrustumTop sets the value of the top frustum plane.
void	setLeft(Vector3f left) setLeft sets the left axis of this camera.
void	setLocation(Vector3f location) setLocation sets the position of the camera.
void	setPlaneState(int planeState) setPlaneState sets the state to keep track of tested planes for culling.
void	setUp(Vector3f up) setUp sets the up axis of this camera.
void	setViewPort(float left, float right, float bottom, float top) setViewPort sets the boundaries of the viewport
void	setViewPortBottom(float bottom) setViewPortBottom sets the bottom boundary of the viewport
void	setViewPortLeft(float left) setViewPortLeft sets the left boundary of the viewport
void	setViewPortRight(float right) setViewPortRight sets the right boundary of the viewport
void	setViewPortTop(float top) setViewPortTop sets the top boundary of the viewport
void	update() update updates the camera parameters by calling onFrustumChange,onViewPortChange and onFrameChange.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jme.renderer.Camera

onViewPortChange, resize

Field Detail

LEFT_PLANE

public static final int LEFT_PLANE

LEFT_PLANE represents the left plane of the camera frustum.

See Also:

Constant Field Values

RIGHT_PLANE

public static final int RIGHT_PLANE

RIGHT_PLANE represents the right plane of the camera frustum.

See Also:

Constant Field Values

BOTTOM_PLANE

public static final int BOTTOM_PLANE

BOTTOM_PLANE represents the bottom plane of the camera frustum.

See Also:

Constant Field Values

TOP_PLANE

public static final int TOP_PLANE

TOP_PLANE represents the top plane of the camera frustum.

See Also:

Constant Field Values

FAR_PLANE

public static final int FAR_PLANE

FAR_PLANE represents the far plane of the camera frustum.

See Also:

Constant Field Values

NEAR_PLANE

public static final int NEAR_PLANE

NEAR_PLANE represents the near plane of the camera frustum.

See Also:

Constant Field Values

FRUSTUM_PLANES

public static final int FRUSTUM_PLANES

FRUSTUM_PLANES represents the number of planes of the camera frustum.

See Also:

Constant Field Values

MAX_WORLD_PLANES

public static final int MAX_WORLD_PLANES

MAX_WORLD_PLANES holds the maximum planes allowed by the system.

See Also:

Constant Field Values

location

protected Vector3f location

Camera's location

left

protected Vector3f left

Direction of camera's 'left'

up

protected Vector3f up

Direction of 'up' for camera.

direction

protected Vector3f direction

Direction the camera is facing.

frustumNear

protected float frustumNear

Distance from camera to near frustum plane.

frustumFar

protected float frustumFar

Distance from camera to far frustum plane.

frustumLeft

protected float frustumLeft

Distance from camera to left frustum plane.

frustumRight

protected float frustumRight

Distance from camera to right frustum plane.

frustumTop

protected float frustumTop

Distance from camera to top frustum plane.

frustumBottom

protected float frustumBottom

Distance from camera to bottom frustum plane.

coeffLeft

protected float[] coeffLeft

coeffRight

protected float[] coeffRight

coeffBottom

protected float[] coeffBottom

coeffTop

protected float[] coeffTop

planeQuantity

protected int planeQuantity

viewPortLeft

protected float viewPortLeft

Percent value on display where horizontal viewing starts for this camera. Default is 0.

viewPortRight

protected float viewPortRight

Percent value on display where horizontal viewing ends for this camera. Default is 1.

viewPortTop

protected float viewPortTop

Percent value on display where vertical viewing ends for this camera. Default is 1.

viewPortBottom

protected float viewPortBottom

Percent value on display where vertical viewing begins for this camera. Default is 0.

worldPlane

protected Plane[] worldPlane

Array holding the planes that this camera will check for culling.

lookAt

protected Vector3f lookAt

Optional Vector3f representing a point this camera is looking at.

overrideLookAt

protected boolean overrideLookAt

If true, the lookAt vector is used. Normally false.

Constructor Detail

AbstractCamera

public AbstractCamera()

Constructor instantiates a new AbstractCamera object. All values of the camera are set to default.

Method Detail

getFrustumBottom

public float getFrustumBottom()

getFrustumBottom returns the value of the bottom frustum plane.

Specified by:

getFrustumBottom in interface Camera

Returns:

the value of the bottom frustum plane.

setFrustumBottom

public void setFrustumBottom(float frustumBottom)

setFrustumBottom sets the value of the bottom frustum plane.

Specified by:

setFrustumBottom in interface Camera

Parameters:

frustumBottom - the value of the bottom frustum plane.

getFrustumFar

public float getFrustumFar()

getFrustumFar gets the value of the far frustum plane.

Specified by:

getFrustumFar in interface Camera

Returns:

the value of the far frustum plane.

setFrustumFar

public void setFrustumFar(float frustumFar)

setFrustumFar sets the value of the far frustum plane.

Specified by:

setFrustumFar in interface Camera

Parameters:

frustumFar - the value of the far frustum plane.

getFrustumLeft

public float getFrustumLeft()

getFrustumLeft gets the value of the left frustum plane.

Specified by:

getFrustumLeft in interface Camera

Returns:

the value of the left frustum plane.

setFrustumLeft

public void setFrustumLeft(float frustumLeft)

setFrustumLeft sets the value of the left frustum plane.

Specified by:

setFrustumLeft in interface Camera

Parameters:

frustumLeft - the value of the left frustum plane.

getFrustumNear

public float getFrustumNear()

getFrustumNear gets the value of the near frustum plane.

Specified by:

getFrustumNear in interface Camera

Returns:

the value of the near frustum plane.

setFrustumNear

public void setFrustumNear(float frustumNear)

setFrustumNear sets the value of the near frustum plane.

Specified by:

setFrustumNear in interface Camera

Parameters:

frustumNear - the value of the near frustum plane.

getFrustumRight

public float getFrustumRight()

getFrustumRight gets the value of the right frustum plane.

Specified by:

getFrustumRight in interface Camera

Returns:

frustumRight the value of the right frustum plane.

setFrustumRight

public void setFrustumRight(float frustumRight)

setFrustumRight sets the value of the right frustum plane.

Specified by:

setFrustumRight in interface Camera

Parameters:

frustumRight - the value of the right frustum plane.

getFrustumTop

public float getFrustumTop()

getFrustumTop gets the value of the top frustum plane.

Specified by:

getFrustumTop in interface Camera

Returns:

the value of the top frustum plane.

setFrustumTop

public void setFrustumTop(float frustumTop)

setFrustumTop sets the value of the top frustum plane.

Specified by:

setFrustumTop in interface Camera

Parameters:

frustumTop - the value of the top frustum plane.

getLocation

public Vector3f getLocation()

getLocation retrieves the location vector of the camera.

Specified by:

getLocation in interface Camera

Returns:

the position of the camera.

See Also:

Camera.getLocation()

getDirection

public Vector3f getDirection()

getDirection retrieves the direction vector the camera is facing.

Specified by:

getDirection in interface Camera

Returns:

the direction the camera is facing.

See Also:

Camera.getDirection()

getLeft

public Vector3f getLeft()

getLeft retrieves the left axis of the camera.

Specified by:

getLeft in interface Camera

Returns:

the left axis of the camera.

See Also:

Camera.getLeft()

getUp

public Vector3f getUp()

getUp retrieves the up axis of the camera.

Specified by:

getUp in interface Camera

Returns:

the up axis of the camera.

See Also:

Camera.getUp()

setLocation

public void setLocation(Vector3f location)

setLocation sets the position of the camera.

Specified by:

setLocation in interface Camera

Parameters:

location - the position of the camera.

See Also:

Camera.setLocation(com.jme.math.Vector3f)

setDirection

public void setDirection(Vector3f direction)

setDirection sets the direction this camera is facing. In most cases, this changes the up and left vectors of the camera. If your left or up vectors change, you must updates those as well for correct culling.

Specified by:

setDirection in interface Camera

Parameters:

direction - the direction this camera is facing.

See Also:

Camera.setDirection(com.jme.math.Vector3f)

setLeft

public void setLeft(Vector3f left)

setLeft sets the left axis of this camera. In most cases, this changes the up and direction vectors of the camera. If your direction or up vectors change, you must updates those as well for correct culling.

Specified by:

setLeft in interface Camera

Parameters:

left - the left axis of this camera.

See Also:

Camera.setLeft(com.jme.math.Vector3f)

setUp

public void setUp(Vector3f up)

setUp sets the up axis of this camera. In most cases, this changes the direction and left vectors of the camera. If your left or up vectors change, you must updates those as well for correct culling.

Specified by:

setUp in interface Camera

Parameters:

up - the up axis of this camera.

See Also:

Camera.setUp(com.jme.math.Vector3f)

setAxes

public void setAxes(Vector3f left,
                    Vector3f up,
                    Vector3f direction)

setAxes sets the axes (left, up and direction) for this camera.

Specified by:

setAxes in interface Camera

Parameters:

left - the left axis of the camera.

up - the up axis of the camera.

direction - the direction the camera is facing.

See Also:

Camera.setAxes(com.jme.math.Vector3f,com.jme.math.Vector3f,com.jme.math.Vector3f)

setAxes

public void setAxes(Quaternion axes)

setAxes uses a rotational matrix to set the axes of the camera.

Specified by:

setAxes in interface Camera

Parameters:

axes - the matrix that defines the orientation of the camera.

setFrustum

public void setFrustum(float near,
                       float far,
                       float left,
                       float right,
                       float top,
                       float bottom)

setFrustum sets the frustum of this camera object.

Specified by:

setFrustum in interface Camera

Parameters:

near - the near plane.

far - the far plane.

left - the left plane.

right - the right plane.

top - the top plane.

bottom - the bottom plane.

See Also:

Camera.setFrustum(float, float, float, float, float, float)

setFrustumPerspective

public void setFrustumPerspective(float fovY,
                                  float aspect,
                                  float near,
                                  float far)

Description copied from interface: Camera

setFrustumPerspective defines the frustum for the camera. This frustum is defined by a viewing angle, aspect ratio, and near/far planes

Specified by:

setFrustumPerspective in interface Camera

Parameters:

fovY - Frame of view angle along the Y.

aspect - Width:Height ratio

near - Near view plane distance

far - Far view plane distance

setFrame

public void setFrame(Vector3f location,
                     Vector3f left,
                     Vector3f up,
                     Vector3f direction)

setFrame sets the orientation and location of the camera.

Specified by:

setFrame in interface Camera

Parameters:

location - the point position of the camera.

left - the left axis of the camera.

up - the up axis of the camera.

direction - the facing of the camera.

See Also:

Camera.setFrame(com.jme.math.Vector3f, com.jme.math.Vector3f, com.jme.math.Vector3f, com.jme.math.Vector3f)

lookAt

public void lookAt(Vector3f pos)

lookAt is a convienence method for auto-setting the frame. Unlike its name, this function doesn't totally "look at" a position mostly because left and up vectors are not updated.

Specified by:

lookAt in interface Camera

Parameters:

pos - Vector3f

setFrame

public void setFrame(Vector3f location,
                     Quaternion axes)

setFrame sets the orientation and location of the camera.

Specified by:

setFrame in interface Camera

Parameters:

location - the point position of the camera.

axes - the orientation of the camera.

update

public void update()

update updates the camera parameters by calling onFrustumChange,onViewPortChange and onFrameChange.

Specified by:

update in interface Camera

See Also:

Camera.update()

getPlaneState

public int getPlaneState()

getPlaneState returns the state of the frustum planes. So checks can be made as to which frustum plane has been examined for culling thus far.

Specified by:

getPlaneState in interface Camera

Returns:

the current plane state int.

setPlaneState

public void setPlaneState(int planeState)

setPlaneState sets the state to keep track of tested planes for culling.

Specified by:

setPlaneState in interface Camera

Parameters:

planeState - the updated state.

getViewPortLeft

public float getViewPortLeft()

getViewPortLeft gets the left boundary of the viewport

Specified by:

getViewPortLeft in interface Camera

Returns:

the left boundary of the viewport

setViewPortLeft

public void setViewPortLeft(float left)

setViewPortLeft sets the left boundary of the viewport

Specified by:

setViewPortLeft in interface Camera

Parameters:

left - the left boundary of the viewport

getViewPortRight

public float getViewPortRight()

getViewPortRight gets the right boundary of the viewport

Specified by:

getViewPortRight in interface Camera

Returns:

the right boundary of the viewport

setViewPortRight

public void setViewPortRight(float right)

setViewPortRight sets the right boundary of the viewport

Specified by:

setViewPortRight in interface Camera

Parameters:

right - the right boundary of the viewport

getViewPortTop

public float getViewPortTop()

getViewPortTop gets the top boundary of the viewport

Specified by:

getViewPortTop in interface Camera

Returns:

the top boundary of the viewport

setViewPortTop

public void setViewPortTop(float top)

setViewPortTop sets the top boundary of the viewport

Specified by:

setViewPortTop in interface Camera

Parameters:

top - the top boundary of the viewport

getViewPortBottom

public float getViewPortBottom()

getViewPortBottom gets the bottom boundary of the viewport

Specified by:

getViewPortBottom in interface Camera

Returns:

the bottom boundary of the viewport

setViewPortBottom

public void setViewPortBottom(float bottom)

setViewPortBottom sets the bottom boundary of the viewport

Specified by:

setViewPortBottom in interface Camera

Parameters:

bottom - the bottom boundary of the viewport

setViewPort

public void setViewPort(float left,
                        float right,
                        float bottom,
                        float top)

setViewPort sets the boundaries of the viewport

Specified by:

setViewPort in interface Camera

Parameters:

left - the left boundary of the viewport

right - the right boundary of the viewport

bottom - the bottom boundary of the viewport

top - the top boundary of the viewport

contains

public int contains(BoundingVolume bound)

culled tests a bounding volume against the planes of the camera's frustum. The frustums planes are set such that the normals all face in towards the viewable scene. Therefore, if the bounding volume is on the negative side of the plane is can be culled out. If the object should be culled (i.e. not rendered) true is returned, otherwise, false is returned. If bound is null, false is returned and the object will not be culled.

Specified by:

contains in interface Camera

Parameters:

bound - the bound to check for culling

Returns:

true if the bound should be culled, false otherwise.

onFrustumChange

public void onFrustumChange()

onFrustumChange updates the frustum to reflect any changes made to the planes. The new frustum values are kept in a temporary location for use when calculating the new frame. It should be noted that the abstract implementation of this class only updates the data, and does not make any rendering calls. As such, any impelmenting subclass should insure to override this method call it with super and then call the rendering specific code.

Specified by:

onFrustumChange in interface Camera

onFrameChange

public void onFrameChange()

onFrameChange updates the view frame of the camera. It should be noted that the abstract implementation of this class only updates the data, and does not make any rendering calls. As such, any implementing subclass should insure to override this method call it with super and then call the rendering specific code.

Specified by:

onFrameChange in interface Camera