Coppercube API Documentation
Class AnimatorFlyStraight
Scene node animator making SceneNodes move along straight line between two points.
Extends
Animator.
Class Overview
AnimatorFlyStraight(start, end, timeForWay, loop, deleteMeAfterEndReached, animateCameraTargetInsteadOfPosition)
Scene node animator making SceneNodes move along straight line between two points.
- Parameters:
- start
- {Vect3d} Start 3d position of the line
- end
- {Vect3d} End 3d position of the line
- timeForWay
- {Number} Time for moving along the whole line in milliseconds. For example 2000 for 2 seconds.
- loop
- {Boolean} set to true for looping along the line, false for stopping movement when the end has been reached.
- deleteMeAfterEndReached
- {Boolean} set to true if the animator should delete itself after the end has been reached.
- animateCameraTargetInsteadOfPosition
- {Boolean} if the animated node is a camera, set to true to animate the camera target instead of the position of the camera.
Method Attributes | Method Name and Description |
---|---|
animateNode(n, timeMs)
Animates the scene node it is attached to and returns true if scene node was modified.
|
|
getType()
Returns the type of the animator.
|
- Methods borrowed from class Animator:
- onKeyDown, onKeyUp, onMouseDown, onMouseMove, onMouseUp, onMouseWheel
Method Detail
animateNode(n, timeMs)
Animates the scene node it is attached to and returns true if scene node was modified.
- Parameters:
- n
- The Scene node which needs to be animated this frame.
- timeMs
- The time in milliseconds since the start of the scene.
getType()
Returns the type of the animator.
For the AnimatorFlyStraight, this will return 'flystraight'.