TrakEM2_/src/main/java/ini/trakem2/display/ZDisplayable.java

   1 /**
   2
   3 TrakEM2 plugin for ImageJ(C).
   4 Copyright (C) 2005-2009 Albert Cardona and Rodney Douglas.
   5
   6 This program is free software; you can redistribute it and/or
   7 modify it under the terms of the GNU General Public License
   8 as published by the Free Software Foundation (http://www.gnu.org/licenses/gpl.txt )
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18
  19 You may contact Albert Cardona at acardona at ini.phys.ethz.ch
  20 Institute of Neuroinformatics, University of Zurich / ETH, Switzerland.
  21 **/
  22
  23 package ini.trakem2.display;
  24
  25 import ini.trakem2.Project;
  26 import ini.trakem2.persistence.XMLOptions;
  27 import ini.trakem2.utils.Search;
  28 import ini.trakem2.utils.Utils;
  29
  30 import java.awt.Color;
  31 import java.awt.geom.AffineTransform;
  32 import java.awt.geom.Area;
  33 import java.util.ArrayList;
  34 import java.util.Collection;
  35 import java.util.HashMap;
  36 import java.util.HashSet;
  37 import java.util.List;
  38
  39 /** For Pipes and other objects that must be shown in all Layers of a LayerSet. */
  40
  41 public abstract class ZDisplayable extends Displayable {
  42
  43         protected LayerSet layer_set;
  44
  45         public ZDisplayable(Project project, String title, double x, double y) {
  46                 super(project, title, x, y);
  47         }
  48
  49         /** For reconstruction from the database. */
  50         public ZDisplayable(Project project, long id, String title, boolean locked, AffineTransform at, float width, float height) {
  51                 super(project, id, title, locked, at, width, height);
  52         }
  53
  54         /** For reconstruction from an XML file. */
  55         public ZDisplayable(Project project, long id, HashMap<String,String> ht, HashMap<Displayable,String> ht_links) {
  56                 super(project, id, ht, ht_links);
  57                 Object data = ht.get("layer_set_id");
  58                 if (null != data) {
  59                         // construct a dummy layerset
  60                         this.layer_set = new LayerSet(project, Long.parseLong((String)data));
  61                         // TODO fix this hack
  62                         //  -- one year later: seems like it will stay.
  63                 }
  64         }
  65
  66         public void setLayerSet(LayerSet layer_set) {
  67                 setLayerSet(layer_set, true); // should check that the new LayerSet belongs to the same project
  68         }
  69
  70         public void setLayerSet(LayerSet layer_set, boolean update_db) {
  71                 if (layer_set == this.layer_set) return;
  72                 this.layer_set = layer_set;
  73                 if (update_db) updateInDatabase("layer_set_id");
  74         }
  75
  76         public LayerSet getLayerSet() { return layer_set; }
  77
  78         // Overriding, for repainting the proper part, without updating the database
  79         public void setLayer(Layer layer) { this.layer = layer; }
  80
  81         /** Link the Patch objects that lay underneath the part of the bounding box of this profile that shows in the current layer, so that they cannot be dragged independently. */
  82         abstract public boolean linkPatches();
  83
  84         /** Returns the layer of lowest Z coordinate where this ZDisplayable has a point in. */
  85         abstract public Layer getFirstLayer();
  86
  87         public void exportXML(StringBuilder sb_body, String indent, XMLOptions options) {
  88                 super.exportXML(sb_body, indent, options);
  89                 sb_body.append(indent).append("layer_set_id=\"").append(layer_set.getId()).append("\"\n");
  90         }
  91         static public void exportDTD(final String type, final StringBuilder sb_header, final HashSet<String> hs, final String indent) {
  92                 if (hs.contains(type)) return;
  93                 Displayable.exportDTD(type, sb_header, hs, indent);
  94                 sb_header.append(indent).append(TAG_ATTR1).append(type).append(" layer_set_id").append(TAG_ATTR2)
  95                 ;
  96         }
  97
  98         /** Transform points falling within the given layer; translate by dx,dy and rotate by rot relative to origin xo,yo*/
  99         @Deprecated
 100         public void transformPoints(Layer layer, double dx, double dy, double rot, double xo, double yo) {}
 101
 102         @Override
 103         protected boolean remove2(boolean check) {
 104                 return project.getProjectTree().remove(check, project.findProjectThing(this), null); // will call remove(check) here
 105         }
 106
 107         @Override
 108         public boolean remove(boolean check) {
 109                 if (check && !Utils.check("Really remove " + this.toString() + " ?")) return false;
 110                 if (layer_set.remove(this) && removeFromDatabase()) {
 111                         unlink();
 112                         removeLinkedPropertiesFromOrigins();
 113                         Search.remove(this); // duplication of code from Displayable.remove, because there isn't a proper hierarchy of classes
 114                         Display.flush(this);
 115                         project.decache(this);
 116                         return true;
 117                 }
 118                 return false;
 119         }
 120
 121         /** Does not remove from the LayerSet. */
 122         @Override
 123         public boolean softRemove() {
 124                 if (removeFromDatabase()) {
 125                         unlink();
 126                         removeLinkedPropertiesFromOrigins();
 127                         Search.remove(this); // duplication of code from Displayable.remove, because there isn't a proper hierarchy of classes
 128                         Display.flush(this);
 129                         return true;
 130                 }
 131                 return false;
 132         }
 133
 134         /** Check if this instance will paint anything at the level of the given Layer. */
 135         public boolean paintsAt(final Layer layer) {
 136                 if (null == layer || layer_set != layer.getParent()) return false;
 137                 return true;
 138         }
 139
 140         /** Get the list of Layer ids on which this ZDisplayable has data on.*/
 141         @Override
 142         public Collection<Long> getLayerIds() {
 143                 // Unless overriden, return all
 144                 final ArrayList<Long> l = new ArrayList<Long>();
 145                 for (final Layer la : layer_set.getLayers()) l.add(la.getId());
 146                 return l;
 147         }
 148
 149         public void setColor(Color color) {
 150                 if (null == color || color.equals(this.color)) return;
 151                 this.color = color;
 152                 Displayable.last_color = color;
 153                 updateInDatabase("color");
 154                 Display.repaint(layer_set, this, 5);
 155                 Display3D.setColor(this, color);
 156         }
 157
 158         abstract public boolean intersects(Area area, double z_first, double z_last);
 159
 160         public void setVisible(final boolean visible, final boolean repaint) {
 161                 if (visible == this.visible) {
 162                         // patching synch error
 163                         //Display.updateVisibilityCheckbox(layer, this, null);
 164                         return;
 165                 }
 166                 this.visible = visible;
 167                 if (repaint) {
 168                         Display.repaint(layer_set, null, getBoundingBox(), 5, true);
 169                 }
 170                 updateInDatabase("visible");
 171         }
 172
 173         public Bucketable getBucketable() {
 174                 return this.layer_set;
 175         }
 176
 177         /** Retain the data within the layer range, and through out all the rest. */
 178         public boolean crop(List<Layer> range) {
 179                 return true;
 180         }
 181
 182         /** Update internal datastructures to reflect the fact that @param layer has been removed from the containing LayerSet.*/
 183         protected boolean layerRemoved(Layer la) {
 184                 if (null != hs_linked) {
 185                         for (final Displayable d : hs_linked) if (d.layer == la) unlink(d);
 186                 }
 187                 return true;
 188         }
 189
 190         public void updateBucket(final Layer la) {
 191                 if (null == la) updateBucket(); // for all layers
 192                 else if (null != getBucketable()) getBucketable().updateBucket(this, la);
 193         }
 194
 195         /** Update buckets for all Layers. */
 196         @Override
 197         public void updateBucket() {
 198                 if (null == getBucketable()) return;
 199                 for (final Layer layer : getLayersWithData()) {
 200                         getBucketable().updateBucket(this, layer);
 201                 }
 202         }
 203
 204         abstract protected boolean calculateBoundingBox(final Layer la);
 205 }