com.sk89q.worldedit.regions

Interface RegionSelector

All Known Implementing Classes:

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

public interface RegionSelector

Region selectors create Regions from a series of "selected points." They are used, for example, to allow users to create a CuboidRegion by selecting two corners of the cuboid.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the selection.
void	explainPrimarySelection(Actor actor, LocalSession session, Vector position) Tell the player information about his/her primary selection.
void	explainRegionAdjust(Actor actor, LocalSession session) The the player information about the region's changes.
void	explainSecondarySelection(Actor actor, LocalSession session, Vector position) 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.
World	getWorld() Get the world for the region selector.
boolean	isDefined() Returns whether the region has been fully defined.
void	learnChanges() Update the selector with changes to the region.
boolean	selectPrimary(Vector position, SelectorLimits limits) Called when the first point is selected.
boolean	selectSecondary(Vector position, SelectorLimits limits) Called when the second point is selected.
void	setWorld(World world) Set the world for the region selector.

Method Detail

getWorld

@Nullable
World getWorld()

Get the world for the region selector.

Returns:

a world, which may be null

setWorld

void setWorld(@Nullable
              World world)

Set the world for the region selector.

Parameters:

world - the world, which may be null

selectPrimary

boolean selectPrimary(Vector position,
                      SelectorLimits limits)

Called when the first point is selected.

Parameters:

position - the position

Returns:

true if something changed

selectSecondary

boolean selectSecondary(Vector position,
                        SelectorLimits limits)

Called when the second point is selected.

Parameters:

position - the position

Returns:

true if something changed

explainPrimarySelection

void explainPrimarySelection(Actor actor,
                             LocalSession session,
                             Vector position)

Tell the player information about his/her primary selection.

Parameters:

actor - the actor

session - the session

position - position

explainSecondarySelection

void explainSecondarySelection(Actor actor,
                               LocalSession session,
                               Vector position)

Tell the player information about his/her secondary selection.

Parameters:

actor - the actor

session - the session

position - position

explainRegionAdjust

void explainRegionAdjust(Actor actor,
                         LocalSession session)

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

Parameters:

actor - the actor

session - the session

getPrimaryPosition

BlockVector getPrimaryPosition()
                        throws IncompleteRegionException

Get the primary position.

Returns:

the primary position

Throws:

IncompleteRegionException - thrown if a region has not been fully defined

getRegion

Region getRegion()
          throws IncompleteRegionException

Get the selection.

Returns:

the created region

Throws:

IncompleteRegionException - thrown if a region has not been fully defined

getIncompleteRegion

Region getIncompleteRegion()

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

Returns:

an incomplete region object that is incomplete

isDefined

boolean isDefined()

Returns whether the region has been fully defined.

Returns:

true if a selection is available

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:

a lower case name of the type

getInformationLines

List<String> getInformationLines()

Get lines of information about the selection.

Returns:

a list of lines describing the region