/**********************************************
* Copyright (C) 2010 Lukas Laag
* This file is part of lib-gwt-svg.
*
* libgwtsvg 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.
*
* libgwtsvg 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 libgwtsvg. If not, see http://www.gnu.org/licenses/
**********************************************/
/*
* Copyright (c) 2004 World Wide Web Consortium,
*
* (Massachusetts Institute of Technology, European Research Consortium for
* Informatics and Mathematics, Keio University). All Rights Reserved. This
* work is distributed under the W3C(r) Software License [1] 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.
*
* [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
*/
package org.vectomatic.dom.svg.impl;
import org.vectomatic.dom.svg.OMSVGAnimatedBoolean;
import org.vectomatic.dom.svg.OMSVGAnimatedLength;
import org.vectomatic.dom.svg.OMSVGAnimatedTransformList;
import org.vectomatic.dom.svg.OMSVGMatrix;
import org.vectomatic.dom.svg.OMSVGPoint;
import org.vectomatic.dom.svg.OMSVGRect;
import org.vectomatic.dom.svg.OMSVGStringList;
import com.google.gwt.core.client.JavaScriptException;
/**
* The {@link org.vectomatic.dom.svg.impl.SVGLineElement} interface corresponds
* to the <a href='http://www.w3.org/TR/SVG11/shapes.html#LineElement' title='line
* element specification'>line</a> element.
*/
public class SVGLineElement extends SVGElement {
protected SVGLineElement() {
}
// Implementation of the svg::SVGLineElement W3C IDL interface
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.impl.SVGLineElement#getX1()}
* on the given <a href='http://www.w3.org/TR/SVG11/shapes.html#LineElement'
* title='line element specification'>line</a> element.
*/
public final native OMSVGAnimatedLength getX1() /*-{
return this.x1;
}-*/;
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.impl.SVGLineElement#getY1()}
* on the given <a href='http://www.w3.org/TR/SVG11/shapes.html#LineElement'
* title='line element specification'>line</a> element.
*/
public final native OMSVGAnimatedLength getY1() /*-{
return this.y1;
}-*/;
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.impl.SVGLineElement#getX2()}
* on the given <a href='http://www.w3.org/TR/SVG11/shapes.html#LineElement'
* title='line element specification'>line</a> element.
*/
public final native OMSVGAnimatedLength getX2() /*-{
return this.x2;
}-*/;
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.impl.SVGLineElement#getY2()}
* on the given <a href='http://www.w3.org/TR/SVG11/shapes.html#LineElement'
* title='line element specification'>line</a> element.
*/
public final native OMSVGAnimatedLength getY2() /*-{
return this.y2;
}-*/;
// Implementation of the svg::SVGExternalResourcesRequired W3C IDL interface
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
* on the given element. Note that the SVG DOM defines the attribute {@link
* org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
* as being of type {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean}, whereas
* the SVG language definition says that {@link org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
* is not animated. Because the SVG language definition states that {@link
* org.vectomatic.dom.svg.itf.ISVGExternalResourcesRequired#getExternalResourcesRequired()}
* cannot be animated, the {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean#getAnimVal()}
* will always be the same as the {@link org.vectomatic.dom.svg.OMSVGAnimatedBoolean#getBaseVal()}.
*/
public final native OMSVGAnimatedBoolean getExternalResourcesRequired() /*-{
return this.externalResourcesRequired;
}-*/;
// Implementation of the svg::SVGLangSpace W3C IDL interface
/**
* Corresponds to attribute <code>xml:lang</code> on the given element.
*/
public final native String getXmllang() /*-{
return this.xmllang;
}-*/;
/**
* Corresponds to attribute <code>xml:lang</code> on the given element.
* @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) Raised on an attempt
* to change the value of a <a href="svgdom.html#ReadOnlyNodes">read only
* attribute</a>.
*/
public final native void setXmllang(String value) throws JavaScriptException /*-{
this.xmllang = value;
}-*/;
/**
* Corresponds to attribute <code>xml:space</code> on the given element.
*/
public final native String getXmlspace() /*-{
return this.xmlspace;
}-*/;
/**
* Corresponds to attribute <code>xml:space</code> on the given element.
* @throws DOMException(NO_MODIFICATION_ALLOWED_ERR) Raised on an attempt
* to change the value of a <a href="svgdom.html#ReadOnlyNodes">read only
* attribute</a>.
*/
public final native void setXmlspace(String value) throws JavaScriptException /*-{
this.xmlspace = value;
}-*/;
// Implementation of the svg::SVGLocatable W3C IDL interface
/**
* The element which established the current viewport. Often, the nearest
* ancestor <a href='http://www.w3.org/TR/SVG11/struct.html#SVGElement' title='svg
* element specification'>svg</a> element. Null if the current element is
* the outermost <a href='http://www.w3.org/TR/SVG11/struct.html#SVGElement'
* title='svg element specification'>svg</a> element.
*/
public final native SVGElement getNearestViewportElement() /*-{
return this.nearestViewportElement;
}-*/;
/**
* The farthest ancestor <a href='http://www.w3.org/TR/SVG11/struct.html#SVGElement'
* title='svg element specification'>svg</a> element. Null if the current
* element is the outermost <a href='http://www.w3.org/TR/SVG11/struct.html#SVGElement'
* title='svg element specification'>svg</a> element.
*/
public final native SVGElement getFarthestViewportElement() /*-{
return this.farthestViewportElement;
}-*/;
/**
* Returns the tight bounding box in current user space (i.e., after application
* of the <code>transform</code> attribute, if any) on the geometry of all
* contained graphics elements, exclusive of stroking, clipping, masking and
* filter effects). Note that getBBox must return the actual bounding box
* at the time the method was called, even in case the element has not yet
* been rendered.
* @return An {@link org.vectomatic.dom.svg.OMSVGRect} object that defines
* the bounding box.
*/
public final native OMSVGRect getBBox() /*-{
return this.getBBox();
}-*/;
/**
* Returns the transformation matrix from current user units (i.e., after
* application of the <code>transform</code> attribute, if any) to the viewport
* coordinate system for the {@link org.vectomatic.dom.svg.itf.ISVGLocatable#getNearestViewportElement()}.
* @return An {@link org.vectomatic.dom.svg.OMSVGMatrix} object that defines
* the CTM.
*/
public final native OMSVGMatrix getCTM() /*-{
return this.getCTM();
}-*/;
/**
* Returns the transformation matrix from current user units (i.e., after
* application of the <code>transform</code> attribute, if any) to the parent
* user agent's notice of a "pixel". For display devices, ideally this represents
* a physical screen pixel. For other devices or environments where physical
* pixel sizes are not known, then an algorithm similar to the CSS2 definition
* of a "pixel" can be used instead. Note that null is returned if this element
* is not hooked into the document tree. This method would have been more
* aptly named as <code>getClientCTM</code>, but the name <code>getScreenCTM</code>
* is kept for historical reasons.
* @return An {@link org.vectomatic.dom.svg.OMSVGMatrix} object that defines
* the given transformation matrix.
*/
public final native OMSVGMatrix getScreenCTM() /*-{
return this.getScreenCTM();
}-*/;
/**
* Returns the transformation matrix from the user coordinate system on the
* current element (after application of the <code>transform</code> attribute,
* if any) to the user coordinate system on parameter <var>element</var> (after
* application of its <code>transform</code> attribute, if any).
* @param element The target element.
* @return An {@link org.vectomatic.dom.svg.OMSVGMatrix} object that defines
* the transformation.
* @throws SVGException(SVG_MATRIX_NOT_INVERTABLE) Raised if the currently
* defined transformation matrices make it impossible to compute the given
* matrix (e.g., because one of the transformations is singular).
*/
public final native OMSVGMatrix getTransformToElement(SVGElement element) throws JavaScriptException /*-{
return this.getTransformToElement(element);
}-*/;
// Implementation of the svg::SVGTests W3C IDL interface
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTests#getRequiredFeatures()}
* on the given element.
*/
public final native OMSVGStringList getRequiredFeatures() /*-{
return @org.vectomatic.dom.svg.OMNode::convertList(Lcom/google/gwt/core/client/JavaScriptObject;)(this.requiredFeatures);
}-*/;
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTests#getRequiredExtensions()}
* on the given element.
*/
public final native OMSVGStringList getRequiredExtensions() /*-{
return @org.vectomatic.dom.svg.OMNode::convertList(Lcom/google/gwt/core/client/JavaScriptObject;)(this.requiredExtensions);
}-*/;
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTests#getSystemLanguage()}
* on the given element.
*/
public final native OMSVGStringList getSystemLanguage() /*-{
return @org.vectomatic.dom.svg.OMNode::convertList(Lcom/google/gwt/core/client/JavaScriptObject;)(this.systemLanguage);
}-*/;
/**
* Returns true if the user agent supports the given extension, specified
* by a URI.
* @param extension The name of the extension, expressed as a URI.
* @return True or false, depending on whether the given extension is supported.
*/
public final native boolean hasExtension(String extension) /*-{
return this.hasExtension(extension);
}-*/;
// Implementation of the svg::SVGTransformable W3C IDL interface
/**
* Corresponds to attribute {@link org.vectomatic.dom.svg.itf.ISVGTransformable#getTransform()}
* on the given element.
*/
public final native OMSVGAnimatedTransformList getTransform() /*-{
return this.transform;
}-*/;
// Helper methods
/**
* Computes the intersection point between this line and the tangent
* perpendicular to this line through p. The intersection is
* returned in parametric form. If one considers the parametric
* equation of this line to be:
* <pre>P = P1 + t * (P2 - P1)</pre>
* then this method returns the value of t at the intersection point.
* @param p The point which defines the tangent.
* @return the parametric value of the intersection point.
*/
public final native float parametricIntersection(OMSVGPoint p) /*-{
var x1 = this.x1.baseVal.value;
var y1 = this.y1.baseVal.value;
var x2 = this.x2.baseVal.value;
var y2 = this.y2.baseVal.value;
var dx = x2 - x1;
var dy = y2 - y1;
return ((p.x - x1)*(x2 - x1) + (p.y - y1)*(y2 - y1))/(dx * dx + dy * dy);
}-*/;
/**
* Computes the intersection point between this line and the tangent
* perpendicular to this line through p.
* @param p The point which defines the tangent.
* @return the intersection point.
*/
public final OMSVGPoint intersectionPoint(OMSVGPoint p) {
OMSVGPoint destination = getOwnerSVGElement().createSVGPoint();
return intersectionPoint(p,destination);
}
/**
* Computes the intersection point between this line and the tangent
* perpendicular to this line through p and puts the
* result in the specified destination point.
* @param p The point which defines the tangent.
* @param destination The point where to store the result.
* @return the intersection point.
*/
public final OMSVGPoint intersectionPoint(OMSVGPoint p, OMSVGPoint destination) {
float u = parametricIntersection(p);
float x1 = getX1().getBaseVal().getValue();
float y1 = getY1().getBaseVal().getValue();
float x2 = getX2().getBaseVal().getValue();
float y2 = getY2().getBaseVal().getValue();
float dx = x2 - x1;
float dy = y2 - y1;
destination.setX(x1 + u * dx);
destination.setY(y1 + u * dy);
return destination;
}
/**
* Computes the distance from the specified point to this line.
* @param p A point in the plane
* @return the distance to this line.
*/
public final float distanceToLine(OMSVGPoint p) {
return p.distance(intersectionPoint(p));
}
}