city.cs.engine

Class AttachedImage

java.lang.Object

city.cs.engine.AttachedImage

public class AttachedImage
extends Object

Instances of images. Each image instance can specify different scale, rotation, translation and reflection (flip) attributes.

Constructor Summary

Constructors

Constructor and Description
AttachedImage(Body body, BodyImage image, float scale, float rotation, Vec2 offset) Create a new instance of an image.

Method Summary

Modifier and Type	Method and Description
void	flipHorizontal() Flip the orientation of this image instance horizontally (reflect in a vertical axis passing through the origin).
void	flipVertical() Flip the orientation of this image instance vertically (reflect in a horizontal axis passing through the origin).
BodyImage	getBodyImage() The BodyImage of which this is an instance.
Vec2	getOffset() The offset for this image instance.
float	getRotation() The angle of rotation for this image instance.
float	getScale() The scale factor for this image instance.
boolean	isFlippedHorizontal() Is this image instance flipped horizontally relative to its original state?
boolean	isFlippedVertical() Is this image instance flipped vertically relative to its original state?
void	reset() Reset scale, rotation and offset to their original values.
void	setOffset(Vec2 offset) Set the offset for this image instance.
void	setRotation(float rotation) Set the angle of rotation for this image instance.
void	setScale(float scale) Set the scale factor for this image instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachedImage

public AttachedImage(Body body,
                     BodyImage image,
                     float scale,
                     float rotation,
                     Vec2 offset)

Create a new instance of an image. The same image can be instantiated multiple times but each instance is attached to exactly one body. Each image instance is independently scaled, rotated, translated and flipped (in that order).

Parameters:

body - the body to which this instance will be attached

image - the image

scale - the scale at which to draw this instance (1.0 is full size)

rotation - the angle (in radians) by which to rotate around the body's origin

offset - the offset from the body's origin at which to draw this instance

Method Detail

getBodyImage

public BodyImage getBodyImage()

The BodyImage of which this is an instance.

Returns:

the BodyImage

reset

public void reset()

Reset scale, rotation and offset to their original values. Note: does not reset the flip attributes.

flipHorizontal

public void flipHorizontal()

Flip the orientation of this image instance horizontally (reflect in a vertical axis passing through the origin). The flip is applied after scaling, rotation and translation.

flipVertical

public void flipVertical()

Flip the orientation of this image instance vertically (reflect in a horizontal axis passing through the origin). The flip is applied after scaling, rotation and translation.

getScale

public float getScale()

The scale factor for this image instance.

Returns:

the scale factor

setScale

public void setScale(float scale)

Set the scale factor for this image instance.

Parameters:

scale - the new scale factor

getRotation

public float getRotation()

The angle of rotation for this image instance.

Returns:

the angle of rotation (in radians)

setRotation

public void setRotation(float rotation)

Set the angle of rotation for this image instance.

Parameters:

rotation - the new angle (in radians)

getOffset

public Vec2 getOffset()

The offset for this image instance.

Returns:

a copy of the offset

setOffset

public void setOffset(Vec2 offset)

Set the offset for this image instance.

Parameters:

offset - the new offset

isFlippedHorizontal

public boolean isFlippedHorizontal()

Is this image instance flipped horizontally relative to its original state?

Returns:

true if this image instance is flipped horizontally relative to its original state, false otherwise

isFlippedVertical

public boolean isFlippedVertical()

Is this image instance flipped vertically relative to its original state?

Returns:

true if this image instance is flipped vertically relative to its original state, false otherwise