boofcv.io.wrapper.images

Class BufferedFileImageSequence<T extends ImageBase>

java.lang.Object

boofcv.io.wrapper.images.BufferedFileImageSequence<T>

All Implemented Interfaces:

SimpleImageSequence<T>

public class BufferedFileImageSequence<T extends ImageBase>
extends java.lang.Object
implements SimpleImageSequence<T>

Loads or plays a sequence of buffered images.

Constructor Summary

Constructors

Constructor and Description
BufferedFileImageSequence(ImageType<T> type, java.awt.image.BufferedImage[] orig)
BufferedFileImageSequence(ImageType<T> type, java.io.File directory, java.lang.String suffix) Will load an image sequence with no modification.

Method Summary

Modifier and Type	Method and Description
void	close() Call when done reading the image sequence.
int	getFrameNumber() Returns the number of the current frame in the sequence.
java.awt.image.BufferedImage	getGuiImage() Returns the image in the original format that it was read in as.
ImageType<T>	getImageType() Returns the type of class used to store the output image
int	getNextHeight() Returns the height of the next image
int	getNextWidth() Returns the width of the next image
boolean	hasNext() True if there is another image to read and false if there are no more.
T	next() Loads the next image into a BufferedImage and returns it.
void	reset() Start reading the sequence from the start
void	setLoop(boolean loop) Sets if the video should loop or not

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedFileImageSequence

public BufferedFileImageSequence(ImageType<T> type,
                                 java.io.File directory,
                                 java.lang.String suffix)

Will load an image sequence with no modification.

Parameters:

directory - The directory containing the images.

suffix - The suffix that the images have.

BufferedFileImageSequence

public BufferedFileImageSequence(ImageType<T> type,
                                 java.awt.image.BufferedImage[] orig)

Method Detail

setLoop

public void setLoop(boolean loop)

Description copied from interface: SimpleImageSequence

Sets if the video should loop or not

Specified by:

setLoop in interface SimpleImageSequence<T extends ImageBase>

Parameters:

loop - true for looping forever, false for once

getNextWidth

public int getNextWidth()

Description copied from interface: SimpleImageSequence

Returns the width of the next image

Specified by:

getNextWidth in interface SimpleImageSequence<T extends ImageBase>

getNextHeight

public int getNextHeight()

Description copied from interface: SimpleImageSequence

Returns the height of the next image

Specified by:

getNextHeight in interface SimpleImageSequence<T extends ImageBase>

hasNext

public boolean hasNext()

True if there is another image to read and false if there are no more.

Specified by:

hasNext in interface SimpleImageSequence<T extends ImageBase>

Returns:

true if a new image is available.

next

public T next()

Loads the next image into a BufferedImage and returns it. The same instance or a new instance of a BufferedImage might be returned each time. Don't rely on either behavior being consistent.

Specified by:

next in interface SimpleImageSequence<T extends ImageBase>

Returns:

A BufferedImage containing the next image.

getGuiImage

public java.awt.image.BufferedImage getGuiImage()

Description copied from interface: SimpleImageSequence

Returns the image in the original format that it was read in as. When dealing with swing or any standard Java SE environment this will almost always be BufferedImage. The type has been abstracted out to provide better Android support.

Specified by:

getGuiImage in interface SimpleImageSequence<T extends ImageBase>

Returns:

getImageType

public ImageType<T> getImageType()

Description copied from interface: SimpleImageSequence

Returns the type of class used to store the output image

Specified by:

getImageType in interface SimpleImageSequence<T extends ImageBase>

getFrameNumber

public int getFrameNumber()

Description copied from interface: SimpleImageSequence

Returns the number of the current frame in the sequence.

Specified by:

getFrameNumber in interface SimpleImageSequence<T extends ImageBase>

Returns:

Frame ID number.

close

public void close()

Description copied from interface: SimpleImageSequence

Call when done reading the image sequence.

Specified by:

close in interface SimpleImageSequence<T extends ImageBase>

reset

public void reset()

Description copied from interface: SimpleImageSequence

Start reading the sequence from the start

Specified by:

reset in interface SimpleImageSequence<T extends ImageBase>