001: /*
002: * $RCSfile: KBKeyFrame.java,v $
003: *
004: * Copyright (c) 2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * - Redistribution of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * - Redistribution in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in
015: * the documentation and/or other materials provided with the
016: * distribution.
017: *
018: * Neither the name of Sun Microsystems, Inc. or the names of
019: * contributors may be used to endorse or promote products derived
020: * from this software without specific prior written permission.
021: *
022: * This software is provided "AS IS," without a warranty of any
023: * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND
024: * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,
025: * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
026: * EXCLUDED. SUN MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL
027: * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF
028: * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
029: * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR
030: * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
031: * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
032: * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
033: * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
034: * POSSIBILITY OF SUCH DAMAGES.
035: *
036: * You acknowledge that this software is not designed, licensed or
037: * intended for use in the design, construction, operation or
038: * maintenance of any nuclear facility.
039: *
040: * $Revision: 1.4 $
041: * $Date: 2007/02/09 17:20:11 $
042: * $State: Exp $
043: */
044:
045: package com.sun.j3d.utils.behaviors.interpolators;
046:
047: import javax.media.j3d.*;
048: import java.util.*;
049: import javax.vecmath.*;
050: import com.sun.j3d.internal.J3dUtilsI18N;
051:
052: /**
053: * This class represents a Key Frame that can be used for Kochanek-Bartels
054: * (also called TCB or Tension-Continuity-Bias Splines) spline interpolation.
055: *
056: * @since Java3D 1.2
057: */
058: public class KBKeyFrame {
059:
060: // Position, Rotation and Scale
061: public Point3f position;
062: public float heading;
063: public float pitch;
064: public float bank;
065: public Point3f scale;
066:
067: // Tension, Continuity & Bias
068: public float tension;
069: public float continuity;
070: public float bias;
071:
072: // Sample Time
073: public float knot;
074:
075: // Interpolation type (linear = 0 -> spline interpolation)
076: public int linear;
077:
078: // default constructor
079: KBKeyFrame() {
080: tension = continuity = bias = 0.0f;
081: }
082:
083: public KBKeyFrame(KBKeyFrame kf) {
084: this (kf.knot, kf.linear, kf.position, kf.heading, kf.pitch,
085: kf.bank, kf.scale, kf.tension, kf.continuity, kf.bias);
086:
087: }
088:
089: /**
090: * Creates a key frame using the given inputs.
091: *
092: * @param k knot value for this key frame
093: * @param l the linear flag (0 - Spline Interp, 1, Linear Interp
094: * @param pos the position at the key frame
095: * @param hd the heading value at the key frame
096: * @param pi the pitch value at the key frame
097: * @param bk the bank value at the key frame
098: * @param s the scales at the key frame
099: * @param t tension (-1.0 < t < 1.0)
100: * @param c continuity (-1.0 < c < 1.0)
101: * @param b bias (-1.0 < b < 1.0)
102: */
103: public KBKeyFrame(float k, int l, Point3f pos, float hd, float pi,
104: float bk, Point3f s, float t, float c, float b) {
105:
106: knot = k;
107: linear = l;
108: position = new Point3f(pos);
109: heading = hd;
110: pitch = pi;
111: bank = bk;
112: scale = new Point3f(s);
113:
114: // Check for valid tension continuity and bias values
115: if (t < -1.0f || t > 1.0f) {
116: throw new IllegalArgumentException(J3dUtilsI18N
117: .getString("KBKeyFrame0"));
118: }
119:
120: if (b < -1.0f || b > 1.0f) {
121: throw new IllegalArgumentException(J3dUtilsI18N
122: .getString("KBKeyFrame1"));
123: }
124:
125: if (c < -1.0f || c > 1.0f) {
126: throw new IllegalArgumentException(J3dUtilsI18N
127: .getString("KBKeyFrame2"));
128: }
129:
130: // copy valid tension, continuity and bias values
131: tension = t;
132: continuity = c;
133: bias = b;
134: }
135:
136: /**
137: * Prints information comtained in this key frame
138: * @param tag string tag for identifying debug message
139: */
140: public void debugPrint(String tag) {
141: System.out.println("\n" + tag);
142: System.out.println(" knot = " + knot);
143: System.out.println(" linear = " + linear);
144: System.out.println(" position(x,y,z) = " + position.x + " "
145: + position.y + " " + position.z);
146:
147: System.out.println(" tension = " + tension);
148: System.out.println(" continuity = " + continuity);
149: System.out.println(" bias = " + bias);
150: }
151: }
|