Package com.ldtteam.structurize.placement

Class BlueprintIteratorDefault

java.lang.Object

com.ldtteam.structurize.placement.AbstractBlueprintIterator

com.ldtteam.structurize.placement.BlueprintIteratorDefault

All Implemented Interfaces:

IBlueprintIterator

public class BlueprintIteratorDefault
extends AbstractBlueprintIterator

This is the default blueprint iterator. It's a helper class used to track the progress of one iteration over the structure.

Nested Class Summary

Nested classes/interfaces inherited from class com.ldtteam.structurize.placement.AbstractBlueprintIterator

AbstractBlueprintIterator.Result

Field Summary

Fields inherited from class com.ldtteam.structurize.placement.AbstractBlueprintIterator

NULL_POS, prevProgressPos, progressPos, size

Constructor Summary

Constructors

Constructor	Description
BlueprintIteratorDefault(IStructureHandler structureHandler)	Initialize the blueprint iterator with the structure handler.

Method Summary

Modifier and Type	Method	Description
AbstractBlueprintIterator.Result	decrement()	Decrement method, create in implementation.
AbstractBlueprintIterator.Result	increment()	Increment progressPos.

Methods inherited from class com.ldtteam.structurize.placement.AbstractBlueprintIterator

decrement, getBluePrintPositionInfo, getPrevProgressPos, getProgressPos, getSize, getStructureHandler, hasEntities, includeEntities, increment, isRemoving, reset, setProgressPos, setRemoving

Methods inherited from class java.lang.Object

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

Constructor Details

BlueprintIteratorDefault

public BlueprintIteratorDefault(IStructureHandler structureHandler)

Initialize the blueprint iterator with the structure handler.

Parameters:

structureHandler - the structure handler.

Method Details

increment

public AbstractBlueprintIterator.Result increment()

Increment progressPos.

Returns:

false if the all the block have been incremented through.

decrement

public AbstractBlueprintIterator.Result decrement()

Description copied from interface: IBlueprintIterator

Decrement method, create in implementation.

Returns:

decrement the structure position (y--).