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    @Override
061    public String getTagName()
062    {
063        return TAG_NAME;
064    }
065
066    @Override
067    protected void build() throws SVGException
068    {
069        super.build();
070
071        StyleAttribute sty = new StyleAttribute();
072
073        if (getPres(sty.setName("offset")))
074        {
075            offset = sty.getFloatValue();
076            String units = sty.getUnits();
077            if (units != null && units.equals("%"))
078            {
079                offset /= 100f;
080            }
081            if (offset > 1)
082            {
083                offset = 1;
084            }
085            if (offset < 0)
086            {
087                offset = 0;
088            }
089        }
090
091        if (getStyle(sty.setName("stop-color")))
092        {
093            color = sty.getColorValue();
094        }
095
096        if (getStyle(sty.setName("stop-opacity")))
097        {
098            opacity = sty.getRatioValue();
099        }
100    }
101
102    /**
103     * Updates all attributes in this diagram associated with a time event. Ie,
104     * all attributes with track information.
105     *
106     * @return - true if this node has changed state as a result of the time
107     * update
108     */
109    @Override
110    public boolean updateTime(double curTime) throws SVGException
111    {
112//        if (trackManager.getNumTracks() == 0) return false;
113
114        //Get current values for parameters
115        StyleAttribute sty = new StyleAttribute();
116        boolean shapeChange = false;
117
118        if (getPres(sty.setName("offset")))
119        {
120            float newVal = sty.getFloatValue();
121            if (newVal != offset)
122            {
123                offset = newVal;
124                shapeChange = true;
125            }
126        }
127
128        if (getStyle(sty.setName("stop-color")))
129        {
130            Color newVal = sty.getColorValue();
131            if (newVal != color)
132            {
133                color = newVal;
134                shapeChange = true;
135            }
136        }
137
138        if (getStyle(sty.setName("stop-opacity")))
139        {
140            float newVal = sty.getFloatValue();
141            if (newVal != opacity)
142            {
143                opacity = newVal;
144                shapeChange = true;
145            }
146        }
147
148        return shapeChange;
149    }
150}