001: /*
002: * $RCSfile: CubicSplineCurve.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: * CubicSplineCurve is a container class that holds a number of
054: * cubicSplineSegments
055: *
056: * @since Java3D 1.1
057: */
058:
059: public class CubicSplineCurve {
060:
061: private float totalCurveLength;
062: private CubicSplineSegment[] cubicSplineSegment;
063: public int numSegments;
064:
065: /**
066: * Default constructor
067: */
068: CubicSplineCurve() {
069: numSegments = 0;
070: totalCurveLength = 0f;
071: }
072:
073: /**
074: * This method takes a list of key frames and creates spline segments
075: * from it. It requires at least four key frames to be passed to it.
076: * Given n key frames, it creates n-3 CubicSplineSegments.
077: * @param keys the list of key frames that specify the motion path
078: */
079:
080: CubicSplineCurve(TCBKeyFrame keys[]) {
081:
082: int keyLength = keys.length;
083: // Require at least 4 key frames for cubic spline curve
084: if (keyLength < 4)
085: throw new IllegalArgumentException(J3dUtilsI18N
086: .getString("CubicSplineCurve0"));
087:
088: numSegments = keyLength - 3;
089: this .cubicSplineSegment = new CubicSplineSegment[numSegments];
090:
091: // intialize and calculate coefficients for each segment
092: int k0 = 0;
093: int k1 = 1;
094: int k2 = 2;
095: int k3 = 3;
096: for (; k0 < numSegments; k0++, k1++, k2++, k3++) {
097: this .cubicSplineSegment[k0] = new CubicSplineSegment(
098: keys[k0], keys[k1], keys[k2], keys[k3]);
099: }
100:
101: // compute total curve length
102: computeTotalCurveLength();
103: }
104:
105: /**
106: * This method takes a list of spline segments creates the
107: * CubicSplineCurve.
108: * @param the list of segments that comprise the complete motion path
109: */
110:
111: CubicSplineCurve(CubicSplineSegment s[]) {
112:
113: cubicSplineSegment = new CubicSplineSegment[s.length];
114: numSegments = cubicSplineSegment.length;
115: for (int i = 0; i < numSegments; i++) {
116: this .cubicSplineSegment[i] = s[i];
117: }
118:
119: // compute total curve length
120: computeTotalCurveLength();
121: }
122:
123: /**
124: * This method takes a list of spline segments to replace the existing
125: * set of CubicSplineSegments that comprise the current CubicSplineCurve
126: * motion path.
127: * @param s the list of segments that comprise the complete motion path
128: */
129:
130: public void setSegments(CubicSplineSegment s[]) {
131:
132: cubicSplineSegment = new CubicSplineSegment[s.length];
133: numSegments = cubicSplineSegment.length;
134: for (int i = 0; i < numSegments; i++) {
135: this .cubicSplineSegment[i] = s[i];
136: }
137:
138: // compute total curve length
139: computeTotalCurveLength();
140: }
141:
142: /**
143: * This method returns the CubicSplineSegments pointed to by index
144: * @param index the index of the CubicSplineSegment required
145: * @return index the CubicSplineSegment pointed to by index
146: */
147: public CubicSplineSegment getSegment(int index) {
148:
149: return this .cubicSplineSegment[index];
150:
151: }
152:
153: // computes the total length of the curve
154: private void computeTotalCurveLength() {
155:
156: totalCurveLength = 0f;
157: for (int i = 0; i < numSegments; i++) {
158: totalCurveLength += cubicSplineSegment[i].length;
159: }
160:
161: }
162:
163: /**
164: * This method returns the total length of the entire CubicSplineCurve
165: * motion path.
166: *
167: * @return the length of the CubicSplineCurve motion path
168: */
169:
170: public float getTotalCurveLength() {
171:
172: return this.totalCurveLength;
173:
174: }
175:
176: }
|