ilog.views.maps.defense.terrain3d.view

Class Ilv3DCamera

java.lang.Object

ilog.views.maps.defense.terrain3d.view.Ilv3DCamera

public class Ilv3DCamera
extends Object

The camera class maintains a viewpoint as well as an orientation in 3D model space. It is used by the Ilv3DView class to display the terrain using these parameters.

Since:

JViews 7.5

Constructor Summary

Constructors

Constructor and Description
Ilv3DCamera() Default constructor

Method Summary

Modifier and Type	Method and Description
double	getAspectRatio() Returns the aspect ratio of this camera, as used in OpenGL.
double	getFarClip() Returns the far clipping plane distance of this camera, as used in OpenGL.
double	getFovY() Returns the vertical field of view of this camera, as used in OpenGL.
Ilv3DDoubleVector	getLookAtPoint() Returns the target point of this camera.
void	getMatrix(Ilv3DDoubleVector localOrigin, Ilv3DFloatMatrix dest) Takes the local origin in double-precision coordinates and returns a camera (or "modelview") matrix containing the orientation and the position in single-precision coordinates.
double	getNearClip() Returns the near clipping plane distance of this camera, as used in OpenGL.
Ilv3DRotation	getOrientation() Returns the current rotation matrix of this camera.
Ilv3DDoubleVector	getPosition() Returns the position of the camera
Ilv3DFloatMatrix	getProjMat() Returns the camera matrix.
void	getViewingMatrix(Ilv3DDoubleVector localOrigin, Ilv3DFloatMatrix dest) Takes a local origin in double-precision coordinates (specifying the origin for a world-coordinate matrix) and returns a full viewing matrix (including the projection and modelview matrices) in single-precision coordinates.
void	lookAt(Ilv3DDoubleVector lookAtPoint1, Ilv3DFloatVector upVector) Modifies the camera orientation so that it faces the specified point.
void	setAspectRatio(double aspect) Sets the aspect ratio of this camera, as used in OpenGL.
void	setFarClip(double farClip) Sets the far clipping plane distance of this camera, as used in OpenGL.
void	setFovY(double fov) Sets the vertical field of view of this camera, as used in OpenGL.
void	setNearClip(double nearClip) Sets the near clipping plane distance of this camera, as used in OpenGL.
void	setPosition(Ilv3DDoubleVector position) Sets the position of the camera

Methods inherited from class java.lang.Object

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

Constructor Detail

Ilv3DCamera

public Ilv3DCamera()

Default constructor

Method Detail

getOrientation

public Ilv3DRotation getOrientation()

Returns the current rotation matrix of this camera.

Returns:

The rotation matrix.

Since:

JViews 8.1

setPosition

public void setPosition(Ilv3DDoubleVector position)

Sets the position of the camera

Parameters:

position - The position of this camera in 3D model space.

Since:

JViews 8.1

getPosition

public Ilv3DDoubleVector getPosition()

Returns the position of the camera

Returns:

The position of this camera in 3D model space.

Since:

JViews 8.1

setFovY

public void setFovY(double fov)

Sets the vertical field of view of this camera, as used in OpenGL. Please refer to OpenGL reference documentation to learn about the field of view.

Parameters:

fov - The field of view of the camera.

getFovY

public double getFovY()

Returns the vertical field of view of this camera, as used in OpenGL. Please refer to OpenGL reference documentation to learn about the field of view.

Returns:

The field of view of the camera.

setAspectRatio

public void setAspectRatio(double aspect)

Sets the aspect ratio of this camera, as used in OpenGL. Please refer to OpenGL reference documentation to learn about aspect ratio.

Parameters:

aspect - The aspect ratio of the camera in degrees.

getAspectRatio

public double getAspectRatio()

Returns the aspect ratio of this camera, as used in OpenGL. Please refer to OpenGL reference documentation to learn about the aspect ratio.

Returns:

The aspect ratio of the camera in degrees.

setNearClip

public void setNearClip(double nearClip)

Sets the near clipping plane distance of this camera, as used in OpenGL. All objects between camera and near clipping plane will not be rendered. Please refer to OpenGL reference documentation to learn about near clipping plane.

Parameters:

nearClip - The near clipping plane distance of the camera (in 3D model space).

getNearClip

public double getNearClip()

Returns the near clipping plane distance of this camera, as used in OpenGL. All objects between camera and near clipping plane will not be rendered. Please refer to OpenGL reference documentation to learn about near clipping plane.

Returns:

The near clipping plane distance (in 3D model space).

setFarClip

public void setFarClip(double farClip)

Sets the far clipping plane distance of this camera, as used in OpenGL. All objects beyond far clipping plane will not be rendered. Please refer to OpenGL reference documentation to learn about far clipping plane.

Parameters:

farClip - The far clipping plane distance of the camera (in 3D model space).

getFarClip

public double getFarClip()

Returns the far clipping plane distance of this camera, as used in OpenGL. All objects beyond far clipping plane will not be rendered. Please refer to OpenGL reference documentation to learn about far clipping plane.

Returns:

The far clipping plane distance of the camera (in 3D model space).

lookAt

public void lookAt(Ilv3DDoubleVector lookAtPoint1,
                   Ilv3DFloatVector upVector)

Modifies the camera orientation so that it faces the specified point. Note that this method must be called after a call to setPosition to ensure that the camera is facing the specified point. The second parameter defines the camera roll, so that the specified up vector lies in the plane formed by the 3D space up vector and the vector from the camera to the target point.

Parameters:

lookAtPoint1 - The target point to look at.

upVector - The vector defining the camera roll.

Since:

JViews 8.1

getMatrix

public void getMatrix(Ilv3DDoubleVector localOrigin,
                      Ilv3DFloatMatrix dest)

Takes the local origin in double-precision coordinates and returns a camera (or "modelview") matrix containing the orientation and the position in single-precision coordinates.

Parameters:

localOrigin - The local origin (double-precision coordinates).

dest - The camera (or "modelview") matrix.

Internal: do not use!

getViewingMatrix

public void getViewingMatrix(Ilv3DDoubleVector localOrigin,
                             Ilv3DFloatMatrix dest)

Takes a local origin in double-precision coordinates (specifying the origin for a world-coordinate matrix) and returns a full viewing matrix (including the projection and modelview matrices) in single-precision coordinates.

Parameters:

localOrigin - The local origin (double-precision coordinates).

dest - The camera (or "modelview") matrix

Internal: do not use!

getProjMat

public Ilv3DFloatMatrix getProjMat()

Returns the camera matrix.

Returns:

The camera matrix

Internal: do not use!

getLookAtPoint

public Ilv3DDoubleVector getLookAtPoint()

Returns the target point of this camera.

Returns:

The point at which this camera is facing.

Since:

JViews 8.1