com.sk89q.worldedit.regions

Interface RegionSelector

All Known Implementing Classes:

ConvexPolyhedralRegionSelector, CuboidRegionSelector, CylinderRegionSelector, EllipsoidRegionSelector, ExtendingCuboidRegionSelector, Polygonal2DRegionSelector, SphereRegionSelector

public interface RegionSelector

Region selection factory.

Author:

sk89q

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear the selection.
void	explainPrimarySelection(LocalPlayer player, LocalSession session, Vector pos) Tell the player information about his/her primary selection.
void	explainRegionAdjust(LocalPlayer player, LocalSession session) The the player information about the region's changes.
void	explainSecondarySelection(LocalPlayer player, LocalSession session, Vector pos) Tell the player information about his/her secondary selection.
int	getArea() Get the number of blocks inside the region.
Region	getIncompleteRegion() Get the region even if it's not fully defined.
List<String>	getInformationLines() Get lines of information about the selection.
BlockVector	getPrimaryPosition() Get the primary position.
Region	getRegion() Get the selection.
String	getTypeName() Get a lowercase name of this region selector type.
boolean	isDefined() Returns whether the region has been fully defined.
void	learnChanges() Update the selector with changes to the region.
boolean	selectPrimary(Vector pos) Called when the first point is selected.
boolean	selectSecondary(Vector pos) Called when the second point is selected.

Method Detail

selectPrimary

boolean selectPrimary(Vector pos)

Called when the first point is selected.

Parameters:

pos -

Returns:

true if something changed

selectSecondary

boolean selectSecondary(Vector pos)

Called when the second point is selected.

Parameters:

pos -

Returns:

true if something changed

explainPrimarySelection

void explainPrimarySelection(LocalPlayer player,
                           LocalSession session,
                           Vector pos)

Tell the player information about his/her primary selection.

Parameters:

player -

session -

pos -

explainSecondarySelection

void explainSecondarySelection(LocalPlayer player,
                             LocalSession session,
                             Vector pos)

Tell the player information about his/her secondary selection.

Parameters:

player -

session -

pos -

explainRegionAdjust

void explainRegionAdjust(LocalPlayer player,
                       LocalSession session)

The the player information about the region's changes. This may resend all the defining region information if needed.

Parameters:

player -

session -

getPrimaryPosition

BlockVector getPrimaryPosition()
                               throws IncompleteRegionException

Get the primary position.

Returns:

Throws:

IncompleteRegionException

getRegion

Region getRegion()
                 throws IncompleteRegionException

Get the selection.

Returns:

Throws:

IncompleteRegionException

getIncompleteRegion

Region getIncompleteRegion()

Get the region even if it's not fully defined.

Returns:

isDefined

boolean isDefined()

Returns whether the region has been fully defined.

Returns:

getArea

int getArea()

Get the number of blocks inside the region.

Returns:

number of blocks or -1 if undefined

learnChanges

void learnChanges()

Update the selector with changes to the region.

clear

void clear()

Clear the selection.

getTypeName

String getTypeName()

Get a lowercase name of this region selector type.

Returns:

getInformationLines

List<String> getInformationLines()

Get lines of information about the selection.

Returns: