Skip to content

Latest commit

 

History

History
142 lines (108 loc) · 6.66 KB

README-Trident.md

File metadata and controls

142 lines (108 loc) · 6.66 KB
Raw

About Trident

Trident is pretty much the only mature open-source Java animation library out there that isn't part of a much larger framework.

It's also inactive as of August 2010 (version 1.3). This isn't necessarily a bad thing: the project was already fairly mature and robust. Kirill Grouchnikov, Trident's author, did an excellent job. And hey, it's open-source; nothing's stopping anyone from running with a fork should the need arise.

Documentation, full source code, and releases are available in several places: the Trident author's blog, the kenai.com project, and the GitHub snapshot.

Usage in LibShapeDraw

Rather than reinvent the wheel, LibShapeDraw includes Trident 1.3 to assist client code in animating its shapes.

See projects/demos/src/main/java/LSDDemoTrident*.java for sample usage.

For ease of distribution, LibShapeDraw includes a built-in version of Trident. It has been modified in several ways:

  • Repackaged as libshapedraw.animation.trident.

  • Removed Android/Swing/SWT subpackages as they're not relevant to a Minecraft environment.

  • Removed support for loading META-INF/trident-plugin.properties, as this directory is often nuked for Minecraft client modding purposes. Core property interpolators are now hard-coded.

  • Added support for fluent property setters, e.g.:

    // POJO that doesn't support method chaining ("fluent interfacing").
// Trident can access the "x" property, e.g.:
// new Timeline(new Foo()).addPropertyToInterpolate("x", 0.0, 1.0);
public class Foo {
    private double x;
    public void setX(double x) { this.x = x; }
}

// Fluent interfacing: x's setter supports method chaining.
// Without the patch to add support, trying to interpolate the "x"
// property would throw an exception.
public class Bar {
    private double x;
    public Bar setX(double x) { this.x = x; return this; }
}

  • Added Timeline.playLoop(boolean reverse) convenience method, equivalent to Timeline.playLoop(reverse ? RepeatBehavior.REVERSE : RepeatBehavior.LOOP). This provides a workaround for internal class name munging (e.g., RepeatBehavior$REVERSE) that can occur when decompiling, a frequent thing in Minecraft development.

    There shouldn't be any need for mod authors to decompile LibShapeDraw or Trident as the source jar is freely available, but better safe than sorry.

  • Fixed a few invalid @links so Javadocs can be generated without error.

With those patches in place, LibShapeDraw also provides the following for integration:

  • Register custom property interpolators for Color, LineStyle, and Vector3.

  • Define the Animates<T> interface and implement it for various types, including Color, Vector3, and ShapeTransforms. Using this interface, developers don't have to manually set up a Timeline object.

    This simplified interface is completely optional. Developers using the LibShapeDraw API are also able to use any part of the Trident API directly if desired. Extra flexibility is good to have.

Licenses

See LICENSE.txt for LibShapeDraw's license. (TL;DR: it's the MIT license.)

Trident's license is compatible:

Copyright (c) 2005-2010 Trident Kirill Grouchnikov. All Rights Reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

 o Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer. 
    
 o Redistributions in binary form must reproduce the above copyright notice, 
   this list of conditions and the following disclaimer in the documentation 
   and/or other materials provided with the distribution. 
    
 o Neither the name of Trident Kirill Grouchnikov nor the names of 
   its contributors may be used to endorse or promote products derived 
   from this software without specific prior written permission. 
    
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Trident uses the TimingFramework internally, which is similarly licensed:

Copyright (c) 2006, Sun Microsystems, Inc
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

 Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 Redistributions in binary form must reproduce the above
    copyright notice, this list of conditions and the following 
    disclaimer in the documentation and/or other materials provided 
    with the distribution.
 Neither the name of the TimingFramework project nor the names of its
    contributors may be used to endorse or promote products derived 
    from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.