model.component.visual

Class ImagePath

java.lang.Object

model.component.visual.ImagePath

All Implemented Interfaces:

IComponent, ISerializable, java.io.Serializable

public class ImagePath
extends java.lang.Object
implements IComponent

Component to hold an imagePath.

Author:

Rhondu Smithwick

See Also:

Serialized Form

Property Summary

Type	Property and Description
javafx.beans.property.SimpleObjectProperty<java.lang.Double>	imageHeight
javafx.beans.property.SimpleObjectProperty<java.lang.String>	imagePath Get the imagePath property.
javafx.beans.property.SimpleObjectProperty<java.lang.Double>	imageWidth

Constructor Summary

Constructors

Constructor and Description
ImagePath()
ImagePath(java.lang.String imagePath) Construct with no animation.
ImagePath(java.lang.String spriteName, java.lang.String imagePath, double imageWidth, double imageHeight, javafx.geometry.Rectangle2D viewport, boolean isAnimated, double frameDurationMillis, double totalDurationMillis, int maxFrameIndex) Construct with starting values.

Method Summary

Modifier and Type	Method and Description
double	getDuration()
double	getElapsedTime()
double	getFrameDuration()
int	getFrameIndex()
double	getImageHeight() Gets the value of the property imageHeight.
java.lang.String	getImagePath() Gets the value of the property imagePath.
javafx.scene.image.ImageView	getImageView()
double	getImageWidth() Gets the value of the property imageWidth.
java.util.List<javafx.beans.property.SimpleObjectProperty<?>>	getProperties() Gets any properties this component holds.
java.lang.String	getSpriteProperties()
double	getTimeSinceLastFrame()
javafx.geometry.Rectangle2D	getViewport()
int	getZLevel() Gets the z-layer order.
javafx.beans.property.SimpleObjectProperty<java.lang.Double>	imageHeightProperty()
javafx.beans.property.SimpleObjectProperty<java.lang.String>	imagePathProperty() Get the imagePath property.
javafx.beans.property.SimpleObjectProperty<java.lang.Double>	imageWidthProperty()
void	incrementFrameIndex()
void	reset()
void	resetTimeSinceLastFrame()
void	setFrameIndex(int frameIndex)
void	setImageHeight(double imageHeight) Sets the value of the property imageHeight.
void	setImagePath(java.lang.String imagePath) Sets the value of the property imagePath.
void	setImageWidth(double imageWidth) Sets the value of the property imageWidth.
void	setZLevel(int z) Sets the z-layer order.
void	updateTime(double dt)

Methods inherited from class java.lang.Object

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

Methods inherited from interface api.IComponent

getClassForComponentMap, getProperty, getProperty, getPropertyNamesAndClasses, removeBindings

Methods inherited from interface api.ISerializable

clone, serialize, serializeToString

Property Detail

imagePath

public javafx.beans.property.SimpleObjectProperty<java.lang.String> imagePathProperty

Get the imagePath property.

See Also:

getImagePath(), setImagePath(String)

imageWidth

public javafx.beans.property.SimpleObjectProperty<java.lang.Double> imageWidthProperty

See Also:

getImageWidth(), setImageWidth(double)

imageHeight

public javafx.beans.property.SimpleObjectProperty<java.lang.Double> imageHeightProperty

See Also:

getImageHeight(), setImageHeight(double)

Constructor Detail

ImagePath

public ImagePath()

ImagePath

public ImagePath(java.lang.String imagePath)

Construct with no animation.

Parameters:

imagePath - starting value

ImagePath

public ImagePath(java.lang.String spriteName,
                 java.lang.String imagePath,
                 double imageWidth,
                 double imageHeight,
                 javafx.geometry.Rectangle2D viewport,
                 boolean isAnimated,
                 double frameDurationMillis,
                 double totalDurationMillis,
                 int maxFrameIndex)

Construct with starting values.

Parameters:

imagePath - String path to image

imageWidth - width of image

imageHeight - height of image

imagePath - String path to spritesheet

Method Detail

imagePathProperty

public javafx.beans.property.SimpleObjectProperty<java.lang.String> imagePathProperty()

Get the imagePath property.

See Also:

getImagePath(), setImagePath(String)

getImagePath

public java.lang.String getImagePath()

Gets the value of the property imagePath.

setImagePath

public void setImagePath(java.lang.String imagePath)

Sets the value of the property imagePath.

imageWidthProperty

public javafx.beans.property.SimpleObjectProperty<java.lang.Double> imageWidthProperty()

See Also:

getImageWidth(), setImageWidth(double)

imageHeightProperty

public javafx.beans.property.SimpleObjectProperty<java.lang.Double> imageHeightProperty()

See Also:

getImageHeight(), setImageHeight(double)

getImageWidth

public double getImageWidth()

Gets the value of the property imageWidth.

setImageWidth

public void setImageWidth(double imageWidth)

Sets the value of the property imageWidth.

getImageHeight

public double getImageHeight()

Gets the value of the property imageHeight.

setImageHeight

public void setImageHeight(double imageHeight)

Sets the value of the property imageHeight.

getProperties

public java.util.List<javafx.beans.property.SimpleObjectProperty<?>> getProperties()

Description copied from interface: IComponent

Gets any properties this component holds.

Specified by:

getProperties in interface IComponent

Returns:

all the properties this component holds

getViewport

public javafx.geometry.Rectangle2D getViewport()

getImageView

public javafx.scene.image.ImageView getImageView()

setFrameIndex

public void setFrameIndex(int frameIndex)

updateTime

public void updateTime(double dt)

getElapsedTime

public double getElapsedTime()

getTimeSinceLastFrame

public double getTimeSinceLastFrame()

getFrameDuration

public double getFrameDuration()

resetTimeSinceLastFrame

public void resetTimeSinceLastFrame()

reset

public void reset()

getDuration

public double getDuration()

getFrameIndex

public int getFrameIndex()

incrementFrameIndex

public void incrementFrameIndex()

setZLevel

public void setZLevel(int z)

Sets the z-layer order.

Parameters:

z - the z-layer order (1=>send to back, 1=>send to front)

getZLevel

public int getZLevel()

Gets the z-layer order.

Returns:

the z-layer order (1=>send to back, 1=>send to front)

getSpriteProperties

public java.lang.String getSpriteProperties()