|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectplayer.AnimationScan
public class AnimationScan
A state descriptor for a scan of an animation data-set, which
may be represented by a full SiGMLAnimation
data-set, or
alternatively by a CASFrame
sequence.
Constructor Summary | |
---|---|
AnimationScan(SiGMLAnimation animdata,
PlayerFlags flags)
Constructs a scan for the given full animation data-set. |
Method Summary | |
---|---|
void |
advanceFrame()
Advances this scan to the next frame index, unless it is not initially in range. |
SiGMLAnimation |
animation()
Returns this scan's underlying animation if any, otherwise null. |
boolean |
animationIsIncomplete()
Indicates whether this scan is backed by an animation for which there are (or at least may be) yet further frames to be generated. |
void |
checkForAnimationUpdate()
If the animation is not yet complete and this scan is at a sign boundary then this method attempts to update the scan's signs-array. |
int |
f()
Returns the current frame index. |
int |
fCount()
Returns the current frame count. |
CASFrame |
frame()
Returns the current frame if any, or null otherwise. |
boolean |
frameExists(int f)
Indicates whether or not f is a currently valid frame index. |
FrameIndexScanAccess |
getFrameIndexAccess()
Returns a new FrameIndexScanAccess implementation bound to
this scanner. |
boolean |
hasSigns()
Indicates whether this scan is based on a full SiGMLAnimation object, or merely on a sequence
of CASFrame s. |
void |
resetForSequencePlay()
|
int |
s()
Returns the current sign index if any, otherwise -1. |
boolean |
scanIsAtLastFrame()
Indicates whether or not the frame index has now reached the scan's last frame, that is, if the next frame is the current limit. |
boolean |
scanIsAtLastFrameInSign()
Indicates whether or not the current frame is the last one in its sign, assuming both frame and sign exist. |
boolean |
scanIsAtLimit()
Indicates whether or not the frame index has now reached the scan's current limit. |
boolean |
scanIsAtNewSign()
Indicates whether or not the most recent frame setting also necessitates a change of sign setting. |
boolean |
scanIsOneSign()
Indicates whether or not the current scan is for a single sign. |
int |
scanLimit()
Returns this scan's limit frame index. |
int |
sCount()
Returns the current sign count if any, otherwise -1. |
void |
setFrame(int f)
Moves the scan to the given frame index, aligning the sign index with it. |
void |
setSingleSignPlay(boolean single)
Updates the single-sign play flag, and adjusts this scanner's limit settings accordingly. |
AnimatedSign |
sign()
Returns the current sign if any, otherwise null. |
AnimatedSign |
sign(int s)
Returns the sign with the given index, assuming this scan has signs, and the index is valid. |
boolean |
signExists(int s)
Indicates whether or not s is a valid (animated) sign index,
assuming as a precondition that this scanner has animation data. |
int |
signIndex(int f)
Returns the sign index for the given frame in this animation, assuming the animation has signs and the frame index is valid. |
void |
tryWaitForFrames(int nf,
java.lang.String tag)
Like waitForFrames(int) , but this method catches and
reports any InterruptedException . |
void |
waitForFrameIfNeeded()
Waits if necessary until the current frame is available or until the animation is known to be complete, in which case the frame may not exist indicating that the scan is at its limit. |
void |
waitForFrames(int nf)
Waits if necessary until the number of available animation frames is at least the given threshold value, or until the animation is known to be complete (possibly with fewer frames than the threshold value); assumes that the animation has signs. |
void |
waitForFullAnimation()
Waits if necessary until the animation is known to be complete. |
void |
waitForSigns(int ns)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AnimationScan(SiGMLAnimation animdata, PlayerFlags flags)
Method Detail |
---|
public void setSingleSignPlay(boolean single)
public boolean animationIsIncomplete()
public void checkForAnimationUpdate()
public void waitForFrames(int nf) throws java.lang.InterruptedException
java.lang.InterruptedException
public void waitForSigns(int ns) throws java.lang.InterruptedException
java.lang.InterruptedException
public void tryWaitForFrames(int nf, java.lang.String tag)
waitForFrames(int)
, but this method catches and
reports any InterruptedException
.
public void waitForFrameIfNeeded() throws java.lang.InterruptedException
java.lang.InterruptedException
public void waitForFullAnimation() throws java.lang.InterruptedException
java.lang.InterruptedException
public void resetForSequencePlay() throws java.lang.InterruptedException
java.lang.InterruptedException
public void advanceFrame()
public void setFrame(int f)
public boolean hasSigns()
SiGMLAnimation
object, or merely on a sequence
of CASFrame
s.
public boolean scanIsOneSign()
public int scanLimit()
public boolean scanIsAtLimit()
public boolean scanIsAtLastFrame()
public boolean scanIsAtLastFrameInSign()
public SiGMLAnimation animation()
public int sCount()
public int fCount()
public int s()
public int f()
public boolean frameExists(int f)
f
is a currently valid frame index.
public boolean signExists(int s)
s
is a valid (animated) sign index,
assuming as a precondition that this scanner has animation data.
public boolean scanIsAtNewSign()
public AnimatedSign sign(int s)
public AnimatedSign sign()
public CASFrame frame()
public int signIndex(int f)
public FrameIndexScanAccess getFrameIndexAccess()
FrameIndexScanAccess
implementation bound to
this scanner.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |