Plex-FAWE/worldedit-core/src/main/java/com/sk89q/worldedit/session/ClipboardHolder.java
2019-03-26 13:27:09 -04:00

123 lines
3.3 KiB
Java

/*
* WorldEdit, a Minecraft world manipulation toolkit
* Copyright (C) sk89q <http://www.sk89q.com>
* Copyright (C) WorldEdit team and contributors
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by the
* Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package com.sk89q.worldedit.session;
import static com.google.common.base.Preconditions.checkNotNull;
import com.sk89q.worldedit.extent.Extent;
import com.sk89q.worldedit.extent.clipboard.BlockArrayClipboard;
import com.sk89q.worldedit.extent.clipboard.Clipboard;
import com.sk89q.worldedit.math.transform.Identity;
import com.sk89q.worldedit.math.transform.Transform;
import java.util.Collections;
import java.util.List;
/**
* Holds the clipboard and the current transform on the clipboard.
*/
public class ClipboardHolder {
private Clipboard clipboard;
private Transform transform = new Identity();
/**
* Create a new instance with the given clipboard.
*
* @param clipboard the clipboard
*/
public ClipboardHolder(Clipboard clipboard) {
checkNotNull(clipboard);
this.clipboard = clipboard;
}
/**
* Get the clipboard.
* <p>
* If there is a transformation applied, the returned clipboard will
* not contain its effect.
*
* @deprecated FAWE supports multiple loaded schematics {@link #getClipboards()}
* @return the clipboard
*/
@Deprecated
public Clipboard getClipboard() {
return clipboard;
}
/**
* Get all currently held clipboards
* @return
*/
public List<Clipboard> getClipboards() {
return Collections.singletonList(getClipboard());
}
public boolean contains(Clipboard clipboard) {
return this.clipboard == clipboard;
}
/**
* Get all end ClipboardHolders<br/>
* - Usually this will return itself.<br/>
* - If this is a multi clipboard, it will return the children
* @return Set of end ClipboardHolders
*/
public List<ClipboardHolder> getHolders() {
return Collections.singletonList(this);
}
/**
* Set the transform.
*
* @param transform the transform
*/
public void setTransform(Transform transform) {
checkNotNull(transform);
this.transform = transform;
}
/**
* Get the transform.
*
* @return the transform
*/
public Transform getTransform() {
return transform;
}
/**
* Create a builder for an operation to paste this clipboard.
*
* @return a builder
*/
public PasteBuilder createPaste(Extent targetExtent) {
return new PasteBuilder(this, targetExtent);
}
public void close() {
if (clipboard instanceof BlockArrayClipboard) {
((BlockArrayClipboard) clipboard).close();
}
clipboard = null;
}
}