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, 1:56 AM
035 */
036package com.kitfox.svg;
037
038import com.kitfox.svg.xml.StyleAttribute;
039import java.awt.Color;
040
041/**
042 * @author Mark McKay
043 * @author <a href="mailto:mark@kitfox.com">Mark McKay</a>
044 */
045public class Stop extends SVGElement
046{
047
048    public static final String TAG_NAME = "stop";
049    float offset = 0f;
050    float opacity = 1f;
051    Color color = Color.black;
052
053    /**
054     * Creates a new instance of Stop
055     */
056    public Stop()
057    {
058    }
059
060    public String getTagName()
061    {
062        return TAG_NAME;
063    }
064
065    protected void build() throws SVGException
066    {
067        super.build();
068
069        StyleAttribute sty = new StyleAttribute();
070
071        if (getPres(sty.setName("offset")))
072        {
073            offset = sty.getFloatValue();
074            String units = sty.getUnits();
075            if (units != null && units.equals("%"))
076            {
077                offset /= 100f;
078            }
079            if (offset > 1)
080            {
081                offset = 1;
082            }
083            if (offset < 0)
084            {
085                offset = 0;
086            }
087        }
088
089        if (getStyle(sty.setName("stop-color")))
090        {
091            color = sty.getColorValue();
092        }
093
094        if (getStyle(sty.setName("stop-opacity")))
095        {
096            opacity = sty.getRatioValue();
097        }
098    }
099
100    /**
101     * Updates all attributes in this diagram associated with a time event. Ie,
102     * all attributes with track information.
103     *
104     * @return - true if this node has changed state as a result of the time
105     * update
106     */
107    public boolean updateTime(double curTime) throws SVGException
108    {
109//        if (trackManager.getNumTracks() == 0) return false;
110
111        //Get current values for parameters
112        StyleAttribute sty = new StyleAttribute();
113        boolean shapeChange = false;
114
115        if (getPres(sty.setName("offset")))
116        {
117            float newVal = sty.getFloatValue();
118            if (newVal != offset)
119            {
120                offset = newVal;
121                shapeChange = true;
122            }
123        }
124
125        if (getStyle(sty.setName("stop-color")))
126        {
127            Color newVal = sty.getColorValue();
128            if (newVal != color)
129            {
130                color = newVal;
131                shapeChange = true;
132            }
133        }
134
135        if (getStyle(sty.setName("stop-opacity")))
136        {
137            float newVal = sty.getFloatValue();
138            if (newVal != opacity)
139            {
140                opacity = newVal;
141                shapeChange = true;
142            }
143        }
144
145        return shapeChange;
146    }
147}