Package nl.pim16aap2.animatedarchitecture.structures.flag

Class Flag

java.lang.Object

nl.pim16aap2.animatedarchitecture.structures.flag.Flag

All Implemented Interfaces:

IStructureComponent

public class Flag
extends Object
implements IStructureComponent

Represents a Flag structure type.

Nested Class Summary

Nested classes/interfaces inherited from interface nl.pim16aap2.animatedarchitecture.core.structures.IStructureComponent

IStructureComponent.LogHolder

Constructor Summary

Constructors

Constructor	Description
Flag()

Method Summary

Modifier and Type	Method	Description
double	calculateAnimationCycleDistance(IStructureConst structure)	Calculate the animation cycle distance for this structure.
Rectangle	calculateAnimationRange(IStructureConst structure)	Calculate the animation range for this structure.
protected boolean	canEqual(Object other)
boolean	canMovePerpetually(IStructureConst structure)	Checks if the structure can move perpetually.
IAnimationComponent	constructAnimationComponent(IStructureConst structure, AnimationRequestData data)	Creates a new IAnimationComponent for the provided structure and data for this structure component.
boolean	equals(Object o)
MovementDirection	getCycledOpenDirection(IStructureConst structure)	Cycle the toggle direction.
Optional<Cuboid>	getPotentialNewCoordinates(IStructureConst structure)	Finds the new minimum and maximum coordinates (represented by a Cuboid) of this structure that would be the result of toggling it.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface nl.pim16aap2.animatedarchitecture.core.structures.IStructureComponent

calculateAnimationTime, canSkipAnimation, getCurrentToggleDirection, isNorthSouthAnimated

Constructor Details

Flag

public Flag()

Method Details

canMovePerpetually

public boolean canMovePerpetually(IStructureConst structure)

Description copied from interface: IStructureComponent

Checks if the structure can move perpetually.

This applies to structure types that have no end state, such as a flag, a clock, or a windmill.

This method defaults to false.

Specified by:

canMovePerpetually in interface IStructureComponent

Parameters:

structure - The structure to check.

Returns:

true if the structure can move perpetually, false otherwise.

calculateAnimationCycleDistance

public double calculateAnimationCycleDistance(IStructureConst structure)

Description copied from interface: IStructureComponent

Calculate the animation cycle distance for this structure.

This method should not be called directly. Instead, use Structure.getAnimationCycleDistance(). See the documentation for that method for more information.

Specified by:

calculateAnimationCycleDistance in interface IStructureComponent

Parameters:

structure - The structure to calculate the animation cycle distance for.

Returns:

The distance traveled per animation cycle by the block that travels the furthest.

calculateAnimationRange

public Rectangle calculateAnimationRange(IStructureConst structure)

Description copied from interface: IStructureComponent

Calculate the animation range for this structure.

This method should not be called directly. Instead, use Structure.getAnimationRange(). See the documentation for that method for more information.

Specified by:

calculateAnimationRange in interface IStructureComponent

Parameters:

structure - The structure to calculate the animation range for.

Returns:

The animation range for this structure.

getCycledOpenDirection

public MovementDirection getCycledOpenDirection(IStructureConst structure)

Cycle the toggle direction.

See Structure.getCycledOpenDirection() for more information.

Because flags do not actually open in any direction, cycling the openDirection does not do anything.

Specified by:

getCycledOpenDirection in interface IStructureComponent

Parameters:

structure - The structure to get the cycled open direction for.

Returns:

The current open direction.

constructAnimationComponent

public IAnimationComponent constructAnimationComponent(IStructureConst structure,
 AnimationRequestData data)

Description copied from interface: IStructureComponent

Creates a new IAnimationComponent for the provided structure and data for this structure component.

Specified by:

constructAnimationComponent in interface IStructureComponent

Parameters:

structure - The structure to calculate the animation range for.

data - The data for the toggle request.

Returns:

A new Animator for this type of structure.

getPotentialNewCoordinates

public Optional<Cuboid> getPotentialNewCoordinates(IStructureConst structure)

Description copied from interface: IStructureComponent

Finds the new minimum and maximum coordinates (represented by a Cuboid) of this structure that would be the result of toggling it.

Specified by:

getPotentialNewCoordinates in interface IStructureComponent

Parameters:

structure - The structure to calculate the animation range for.

Returns:

The Cuboid that would represent the structure if it was toggled right now.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object