com.sk89q.worldedit.regions

Class CuboidRegionSelector

java.lang.Object

com.sk89q.worldedit.regions.CuboidRegionSelector

All Implemented Interfaces:

CUIRegion, RegionSelector

Direct Known Subclasses:

ExtendingCuboidRegionSelector

public class CuboidRegionSelector
extends Object
implements RegionSelector, CUIRegion

Selector for cuboids.

Author:

sk89q

Field Summary

Fields

Modifier and Type	Field and Description
protected BlockVector	pos1
protected BlockVector	pos2
protected CuboidRegion	region

Constructor Summary

Constructors

Constructor and Description
CuboidRegionSelector()
CuboidRegionSelector(LocalWorld world)
CuboidRegionSelector(LocalWorld world, Vector pos1, Vector pos2)
CuboidRegionSelector(RegionSelector oldSelector)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear the selection.
void	describeCUI(LocalSession session, LocalPlayer 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, LocalPlayer player) Sends CUI events describing the region for versions of CUI smaller than the value supplied by getProtocolVersion().
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.
CuboidRegion	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.
CuboidRegion	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.
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.

Methods inherited from class java.lang.Object

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

Field Detail

pos1

protected BlockVector pos1

pos2

protected BlockVector pos2

region

protected CuboidRegion region

Constructor Detail

CuboidRegionSelector

public CuboidRegionSelector(LocalWorld world)

CuboidRegionSelector

public CuboidRegionSelector()

CuboidRegionSelector

public CuboidRegionSelector(RegionSelector oldSelector)

CuboidRegionSelector

public CuboidRegionSelector(LocalWorld world,
                    Vector pos1,
                    Vector pos2)

Method Detail

selectPrimary

public boolean selectPrimary(Vector pos)

Description copied from interface: RegionSelector

Called when the first point is selected.

Specified by:

selectPrimary in interface RegionSelector

Returns:

true if something changed

selectSecondary

public boolean selectSecondary(Vector pos)

Description copied from interface: RegionSelector

Called when the second point is selected.

Specified by:

selectSecondary in interface RegionSelector

Returns:

true if something changed

explainPrimarySelection

public void explainPrimarySelection(LocalPlayer 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

explainSecondarySelection

public void explainSecondarySelection(LocalPlayer 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

explainRegionAdjust

public void explainRegionAdjust(LocalPlayer 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

getPrimaryPosition

public BlockVector getPrimaryPosition()
                               throws IncompleteRegionException

Description copied from interface: RegionSelector

Get the primary position.

Specified by:

getPrimaryPosition in interface RegionSelector

Returns:

Throws:

IncompleteRegionException

isDefined

public boolean isDefined()

Description copied from interface: RegionSelector

Returns whether the region has been fully defined.

Specified by:

isDefined in interface RegionSelector

Returns:

getRegion

public CuboidRegion getRegion()
                       throws IncompleteRegionException

Description copied from interface: RegionSelector

Get the selection.

Specified by:

getRegion in interface RegionSelector

Returns:

Throws:

IncompleteRegionException

getIncompleteRegion

public CuboidRegion getIncompleteRegion()

Description copied from interface: RegionSelector

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

Specified by:

getIncompleteRegion in interface RegionSelector

Returns:

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:

getInformationLines

public List<String> getInformationLines()

Description copied from interface: RegionSelector

Get lines of information about the selection.

Specified by:

getInformationLines in interface RegionSelector

Returns:

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,
               LocalPlayer 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,
                     LocalPlayer 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:

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:

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: