com.biodigital.humansdk

Class HKCamera

java.lang.Object

com.biodigital.humansdk.HKCamera

public class HKCamera
extends java.lang.Object

Camera object camInfo has fields: eye, look, and up of type float[] zoom should be between 0 and 1

Field Summary

Fields

Modifier and Type	Field and Description
float[]	eye Eye vector [x,y,z]
float[]	look Look vector [x,y,z]
float[]	up Up vector [x,y,z]
double	zoom Zoom factor

Constructor Summary

Constructors

Constructor and Description
HKCamera()
HKCamera(java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.Float>> camInfo, double zoom)

Method Summary

Modifier and Type	Method and Description
void	animateTo(java.lang.String objectID) Animates camera to object specified by its id.
void	getCameraInfo() Get current camera information.
void	getChapterCameraInfo() Get current Chapter's initial camera information.
void	getModuleCameraInfo(java.lang.String moduleID) Get module's initial camera information.
void	lockCamera(java.lang.Boolean lock) Lock or unlock the camera rotation around the Y axis
void	orbit(float yaw, float pitch) Orbit around camera's current point of focus.
void	orbit(float yaw, float pitch, float duration) Orbit around camera's current point of focus.
void	pan(float x, float y, float z) Pan camera by offset in world space.
void	updateCamera(float[] eyeIn, float[] lookIn, float[] upIn, boolean animated) Updates camera position.
void	zoom(float factor) Zoom the camera in and out of its point of focus.

Methods inherited from class java.lang.Object

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

Field Detail

eye

public float[] eye

Eye vector [x,y,z]

look

public float[] look

Look vector [x,y,z]

up

public float[] up

Up vector [x,y,z]

zoom

public double zoom

Zoom factor

Constructor Detail

HKCamera

public HKCamera(java.util.HashMap<java.lang.String,java.util.HashMap<java.lang.String,java.lang.Float>> camInfo,
                double zoom)

HKCamera

public HKCamera()

Method Detail

getModuleCameraInfo

public void getModuleCameraInfo(java.lang.String moduleID)

Get module's initial camera information.

Parameters:

moduleID - the ID of the module Sets local float arrays with camera information (eye, look, and up vectors)

getChapterCameraInfo

public void getChapterCameraInfo()

Get current Chapter's initial camera information. Sets local float arrays with camera information (eye, look, and up vectors)

getCameraInfo

public void getCameraInfo()

Get current camera information. Sets local float arrays with current camera information (eye, look, and up vectors, and zoom factor)

pan

public void pan(float x,
                float y,
                float z)

Pan camera by offset in world space.

Parameters:

x - offset on x axis

y - offset on y axis

z - offset on z axis

zoom

public void zoom(float factor)

Zoom the camera in and out of its point of focus.

Parameters:

factor - Zoom factor between 0 and 1

updateCamera

public void updateCamera(float[] eyeIn,
                         float[] lookIn,
                         float[] upIn,
                         boolean animated)

Updates camera position.

Parameters:

eyeIn - The new camera eye vector.

lookIn - The new camera look vector.

upIn - The new camera up vector.

animated - If true, camera will animate from current position to new position

lockCamera

public void lockCamera(java.lang.Boolean lock)

Lock or unlock the camera rotation around the Y axis

Parameters:

lock - boolean

orbit

public void orbit(float yaw,
                  float pitch)

Orbit around camera's current point of focus. Default is 1 second animation.

Parameters:

yaw - Yaw angle (degrees)

pitch - Pitch angle (degrees)

orbit

public void orbit(float yaw,
                  float pitch,
                  float duration)

Orbit around camera's current point of focus.

Parameters:

yaw - Yaw angle (degrees)

pitch - Pitch angle (degrees)

duration - time of animation (seconds) Default is 1 second

animateTo

public void animateTo(java.lang.String objectID)

Animates camera to object specified by its id.

Parameters:

objectID - Object id specified by string