com.sk89q.worldedit.regions.selector

Class CylinderRegionSelector

java.lang.Object

com.sk89q.worldedit.regions.CylinderRegionSelector

com.sk89q.worldedit.regions.selector.CylinderRegionSelector

All Implemented Interfaces:

CUIRegion, RegionSelector

public class CylinderRegionSelector
extends CylinderRegionSelector
implements RegionSelector, CUIRegion

Creates a CylinderRegionSelector from a user's selections.

Field Summary

Fields

Modifier and Type	Field and Description
protected static NumberFormat	NUMBER_FORMAT
protected CylinderRegion	region

Constructor Summary

Constructors

Constructor and Description
CylinderRegionSelector() Create a new region selector with a null world.
CylinderRegionSelector(RegionSelector oldSelector) Create a new selector from the given one.
CylinderRegionSelector(World world) Create a new region selector.
CylinderRegionSelector(World world, Vector2D center, Vector2D radius, int minY, int maxY) Create a new selector.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the selection.
void	describeCUI(LocalSession session, Actor player) Sends CUI events describing the region for versions of CUI equal to or greater than the value supplied by getProtocolVersion().
void	describeLegacyCUI(LocalSession session, Actor player) Sends CUI events describing the region for versions of CUI smaller than the value supplied by getProtocolVersion().
void	explainPrimarySelection(Actor player, LocalSession session, Vector pos) Tell the player information about his/her primary selection.
void	explainPrimarySelection(LocalPlayer player, LocalSession session, Vector position) Deprecated.
void	explainRegionAdjust(Actor player, LocalSession session) The the player information about the region's changes.
void	explainRegionAdjust(LocalPlayer player, LocalSession session) Deprecated.
void	explainSecondarySelection(Actor player, LocalSession session, Vector pos) Tell the player information about his/her secondary selection.
void	explainSecondarySelection(LocalPlayer player, LocalSession session, Vector position) Deprecated.
int	getArea() Get the number of blocks inside the region.
CylinderRegion	getIncompleteRegion() Get the region even if it's not fully defined.
List<String>	getInformationLines() Get lines of information about the selection.
String	getLegacyTypeID() Returns the type ID to send to CUI in the selection event if the CUI is in legacy mode.
BlockVector	getPrimaryPosition() Get the primary position.
int	getProtocolVersion() Returns the CUI version that is required to send up-to-date data.
CylinderRegion	getRegion() Get the selection.
String	getTypeID() Returns the type ID to send to CUI in the selection event.
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.

Methods inherited from class java.lang.Object

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

Field Detail

NUMBER_FORMAT

protected static final transient NumberFormat NUMBER_FORMAT

region

protected transient CylinderRegion region

Constructor Detail

CylinderRegionSelector

public CylinderRegionSelector()

Create a new region selector with a null world.

CylinderRegionSelector

public CylinderRegionSelector(@Nullable
                              World world)

Create a new region selector.

Parameters:

world - the world, which may be null

CylinderRegionSelector

public CylinderRegionSelector(RegionSelector oldSelector)

Create a new selector from the given one.

Parameters:

oldSelector - the old selector

CylinderRegionSelector

public CylinderRegionSelector(@Nullable
                              World world,
                              Vector2D center,
                              Vector2D radius,
                              int minY,
                              int maxY)

Create a new selector.

Parameters:

world - the world

center - the center

radius - the radius

minY - the minimum Y

maxY - the maximum Y

Method Detail

getWorld

@Nullable
public World getWorld()

Description copied from interface: RegionSelector

Get the world for the region selector.

Specified by:

getWorld in interface RegionSelector

Returns:

a world, which may be null

setWorld

public void setWorld(@Nullable
                     World world)

Description copied from interface: RegionSelector

Set the world for the region selector.

Specified by:

setWorld in interface RegionSelector

Parameters:

world - the world, which may be null

selectPrimary

public boolean selectPrimary(Vector position,
                             SelectorLimits limits)

Description copied from interface: RegionSelector

Called when the first point is selected.

Specified by:

selectPrimary in interface RegionSelector

Parameters:

position - the position

Returns:

true if something changed

selectSecondary

public boolean selectSecondary(Vector position,
                               SelectorLimits limits)

Description copied from interface: RegionSelector

Called when the second point is selected.

Specified by:

selectSecondary in interface RegionSelector

Parameters:

position - the position

Returns:

true if something changed

explainPrimarySelection

public void explainPrimarySelection(Actor player,
                                    LocalSession session,
                                    Vector pos)

Description copied from interface: RegionSelector

Tell the player information about his/her primary selection.

Specified by:

explainPrimarySelection in interface RegionSelector

Parameters:

player - the actor

session - the session

pos - position

explainSecondarySelection

public void explainSecondarySelection(Actor player,
                                      LocalSession session,
                                      Vector pos)

Description copied from interface: RegionSelector

Tell the player information about his/her secondary selection.

Specified by:

explainSecondarySelection in interface RegionSelector

Parameters:

player - the actor

session - the session

pos - position

explainRegionAdjust

public void explainRegionAdjust(Actor player,
                                LocalSession session)

Description copied from interface: RegionSelector

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

Specified by:

explainRegionAdjust in interface RegionSelector

Parameters:

player - the actor

session - the session

getPrimaryPosition

public BlockVector getPrimaryPosition()
                               throws IncompleteRegionException

Description copied from interface: RegionSelector

Get the primary position.

Specified by:

getPrimaryPosition in interface RegionSelector

Returns:

the primary position

Throws:

IncompleteRegionException - thrown if a region has not been fully defined

getRegion

public CylinderRegion getRegion()
                         throws IncompleteRegionException

Description copied from interface: RegionSelector

Get the selection.

Specified by:

getRegion in interface RegionSelector

Returns:

the created region

Throws:

IncompleteRegionException - thrown if a region has not been fully defined

getIncompleteRegion

public CylinderRegion getIncompleteRegion()

Description copied from interface: RegionSelector

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

Specified by:

getIncompleteRegion in interface RegionSelector

Returns:

an incomplete region object that is incomplete

isDefined

public boolean isDefined()

Description copied from interface: RegionSelector

Returns whether the region has been fully defined.

Specified by:

isDefined in interface RegionSelector

Returns:

true if a selection is available

learnChanges

public void learnChanges()

Description copied from interface: RegionSelector

Update the selector with changes to the region.

Specified by:

learnChanges in interface RegionSelector

clear

public void clear()

Description copied from interface: RegionSelector

Clear the selection.

Specified by:

clear in interface RegionSelector

getTypeName

public String getTypeName()

Description copied from interface: RegionSelector

Get a lowercase name of this region selector type.

Specified by:

getTypeName in interface RegionSelector

Returns:

a lower case name of the type

getInformationLines

public List<String> getInformationLines()

Description copied from interface: RegionSelector

Get lines of information about the selection.

Specified by:

getInformationLines in interface RegionSelector

Returns:

a list of lines describing the region

getArea

public int getArea()

Description copied from interface: RegionSelector

Get the number of blocks inside the region.

Specified by:

getArea in interface RegionSelector

Returns:

number of blocks, or -1 if undefined

describeCUI

public void describeCUI(LocalSession session,
                        Actor player)

Description copied from interface: CUIRegion

Sends CUI events describing the region for versions of CUI equal to or greater than the value supplied by getProtocolVersion().

Specified by:

describeCUI in interface CUIRegion

describeLegacyCUI

public void describeLegacyCUI(LocalSession session,
                              Actor player)

Description copied from interface: CUIRegion

Sends CUI events describing the region for versions of CUI smaller than the value supplied by getProtocolVersion().

Specified by:

describeLegacyCUI in interface CUIRegion

getProtocolVersion

public int getProtocolVersion()

Description copied from interface: CUIRegion

Returns the CUI version that is required to send up-to-date data. If the CUI version is smaller than this value, the legacy methods will be called.

Specified by:

getProtocolVersion in interface CUIRegion

Returns:

the protocol version

getTypeID

public String getTypeID()

Description copied from interface: CUIRegion

Returns the type ID to send to CUI in the selection event.

Specified by:

getTypeID in interface CUIRegion

Returns:

the type ID

getLegacyTypeID

public String getLegacyTypeID()

Description copied from interface: CUIRegion

Returns the type ID to send to CUI in the selection event if the CUI is in legacy mode.

Specified by:

getLegacyTypeID in interface CUIRegion

Returns:

the legacy type ID

explainPrimarySelection

@Deprecated
public final void explainPrimarySelection(LocalPlayer player,
                                                      LocalSession session,
                                                      Vector position)

Deprecated.

explainSecondarySelection

@Deprecated
public final void explainSecondarySelection(LocalPlayer player,
                                                        LocalSession session,
                                                        Vector position)

Deprecated.

explainRegionAdjust

@Deprecated
public final void explainRegionAdjust(LocalPlayer player,
                                                  LocalSession session)

Deprecated.