net.dzzd.access
Interface IScene3DObjectAnimator

public interface IScene3DObjectAnimator

Used for accessing a Scene3DObjectAnimator.
Scene3DObjectAnimator is intended to animate a Scene3DObject.

Scene3DObjectAnimator enable time-based animation on Scene3DObject

Since:

1.0

Version:

1.0, 01/01/04

Author:

Bruno Augier

See Also:

IPoint3D, IScene3DObject, DzzD

Method Summary

int	addKeyPosition(int keyTime, IPoint3D position) Add position key.
int	addKeyRotation(int keyTime, IPoint3D rotation, IPoint3D axis, double angle) Add rotation key.
void	copy(IScene3DObjectAnimator source) Copy keys and tracks infos from a source Scene3DObjectAnimator.
IScene3DObjectAnimator	getClone() Gets a clone of this Scene3DObjectAnimator.
long	getPauseTime() Gets pause time for this Scene3DObjectAnimator.
IPoint3D	getPosition() Gets this Scene3DObjectAnimator current position (relative tolast play).
IPoint3D	getRotation() Gets this Scene3DObjectAnimator current rotation (relative tolast play).
long	getStartTime() Gets start time for this Scene3DObjectAnimator.
ITimer	getTimer() Gets current Timer for this this Scene3DObjectAnimator.
void	loopAt(long loopTime) Sets loop time for this Scene3DObjectAnimator.
void	pause() Pause this Scene3DObjectAnimator.
void	play() Play position and rotation track using its Timer.
void	playAt(int time) Play position and rotation track using the given time.
void	playPositionAt(int time) Play position track using the given time.
void	playRotationAt(int time) Play rotation track using the given time.
void	resume() Resume this Scene3DObjectAnimator at the last pause time (start time may be updated).
void	setTimer(ITimer t) Sets Timer to use for this Scene3DObjectAnimator.
void	start() Start this Scene3DObjectAnimator .
void	start(long start) Start this Scene3DObjectAnimator starting at the given time.
void	start(long start, long end) Start this Scene3DObjectAnimator and specify a time range to use.
void	stop() Stop this Scene3DObjectAnimator.

Method Detail

addKeyPosition

public int addKeyPosition(int keyTime,
                          IPoint3D position)

Add position key.

Parameters:

keyTime - time of the new key

position - 3D position for the new key

addKeyRotation

public int addKeyRotation(int keyTime,
                          IPoint3D rotation,
                          IPoint3D axis,
                          double angle)

Add rotation key.

Parameters:

keyTime - time of the new key

rotation - 3D rotation for the new key (performed in order rx,rz,ry)

axis - 3D axis used to reach rotation

angle - angle to turn around the given axis given in radian

playRotationAt

public void playRotationAt(int time)

Play rotation track using the given time.

Parameters:

time - time to play rotation track

playPositionAt

public void playPositionAt(int time)

Play position track using the given time.

Parameters:

time - time to play position track

playAt

public void playAt(int time)

Play position and rotation track using the given time.

Parameters:

time - time to play position and rotation track

getTimer

public ITimer getTimer()

Gets current Timer for this this Scene3DObjectAnimator.

Returns:

current timer

setTimer

public void setTimer(ITimer t)

Sets Timer to use for this Scene3DObjectAnimator.

Returns:

new Timer

getStartTime

public long getStartTime()

Gets start time for this Scene3DObjectAnimator.

Returns:

start time in ms or -1 if not started

getPauseTime

public long getPauseTime()

Gets pause time for this Scene3DObjectAnimator.

Returns:

pause time in ms or -1 if not paused

loopAt

public void loopAt(long loopTime)

Sets loop time for this Scene3DObjectAnimator.

Returns:

loop time in ms or -1 if loop not enabled

pause

public void pause()

Pause this Scene3DObjectAnimator.

resume

public void resume()

Resume this Scene3DObjectAnimator at the last pause time (start time may be updated).

start

public void start()

Start this Scene3DObjectAnimator .

start

public void start(long start)

Start this Scene3DObjectAnimator starting at the given time.

Parameters:

start - starting time to begin play in ms

start

public void start(long start,
                  long end)

Start this Scene3DObjectAnimator and specify a time range to use.

Parameters:

start - starting time to begin play in ms

end - maximum time to play in ms

play

public void play()

Play position and rotation track using its Timer.

stop

public void stop()

Stop this Scene3DObjectAnimator.

getClone

public IScene3DObjectAnimator getClone()

Gets a clone of this Scene3DObjectAnimator.

Returns:

clone of this Scene3DObjectAnimator

copy

public void copy(IScene3DObjectAnimator source)

Copy keys and tracks infos from a source Scene3DObjectAnimator.

Parameters:

source - source Scene3DObjectAnimator

getPosition

public IPoint3D getPosition()

Gets this Scene3DObjectAnimator current position (relative tolast play).

Returns:

position for last play

getRotation

public IPoint3D getRotation()

Gets this Scene3DObjectAnimator current rotation (relative tolast play).

Returns:

rotation for last play