001/*
002 * SVG Salamander
003 * Copyright (c) 2004, Mark McKay
004 * All rights reserved.
005 *
006 * Redistribution and use in source and binary forms, with or 
007 * without modification, are permitted provided that the following
008 * conditions are met:
009 *
010 *   - Redistributions of source code must retain the above 
011 *     copyright notice, this list of conditions and the following
012 *     disclaimer.
013 *   - Redistributions in binary form must reproduce the above
014 *     copyright notice, this list of conditions and the following
015 *     disclaimer in the documentation and/or other materials 
016 *     provided with the distribution.
017 *
018 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
019 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
020 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
021 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
022 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
023 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
025 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
026 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
027 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
028 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
029 * OF THE POSSIBILITY OF SUCH DAMAGE. 
030 * 
031 * Mark McKay can be contacted at mark@kitfox.com.  Salamander and other
032 * projects can be found at http://www.kitfox.com
033 *
034 * Created on January 26, 2004, 9:00 AM
035 */
036package com.kitfox.svg;
037
038import com.kitfox.svg.xml.StyleAttribute;
039import java.awt.Shape;
040import java.awt.geom.AffineTransform;
041import java.awt.geom.Rectangle2D;
042
043/**
044 * Maintains bounding box for this element
045 *
046 * @author Mark McKay
047 * @author <a href="mailto:mark@kitfox.com">Mark McKay</a>
048 */
049abstract public class TransformableElement extends SVGElement
050{
051    AffineTransform xform = null;
052
053    /**
054     * Creates a new instance of BoundedElement
055     */
056    public TransformableElement()
057    {
058    }
059
060    public TransformableElement(String id, SVGElement parent)
061    {
062        super(id, parent);
063    }
064
065    /**
066     * Fetches a copy of the cached AffineTransform. Note that this value will
067     * only be valid after the node has been updated.
068     *
069     * @return
070     */
071    public AffineTransform getXForm()
072    {
073        return xform == null ? null : new AffineTransform(xform);
074    }
075    /*
076     public void loaderStartElement(SVGLoaderHelper helper, Attributes attrs, SVGElement parent)
077     {
078     //Load style string
079     super.loaderStartElement(helper, attrs, parent);
080
081     String transform = attrs.getValue("transform");
082     if (transform != null)
083     {
084     xform = parseTransform(transform);
085     }
086     }
087     */
088
089    protected void build() throws SVGException
090    {
091        super.build();
092
093        StyleAttribute sty = new StyleAttribute();
094
095        if (getPres(sty.setName("transform")))
096        {
097            xform = parseTransform(sty.getStringValue());
098        }
099    }
100
101    protected Shape shapeToParent(Shape shape)
102    {
103        if (xform == null)
104        {
105            return shape;
106        }
107        return xform.createTransformedShape(shape);
108    }
109
110    protected Rectangle2D boundsToParent(Rectangle2D rect)
111    {
112        if (xform == null)
113        {
114            return rect;
115        }
116        return xform.createTransformedShape(rect).getBounds2D();
117    }
118
119    /**
120     * Updates all attributes in this diagram associated with a time event. Ie,
121     * all attributes with track information.
122     *
123     * @return - true if this node has changed state as a result of the time
124     * update
125     */
126    public boolean updateTime(double curTime) throws SVGException
127    {
128        StyleAttribute sty = new StyleAttribute();
129
130        if (getPres(sty.setName("transform")))
131        {
132            AffineTransform newXform = parseTransform(sty.getStringValue());
133            if (!newXform.equals(xform))
134            {
135                xform = newXform;
136                return true;
137            }
138        }
139
140        return false;
141    }
142}