001: /*
002: * $RCSfile: ViewPlatformBehavior.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:15 $
042: * $State: Exp $
043: */
044:
045: package com.sun.j3d.utils.behaviors.vp;
046:
047: import javax.vecmath.*;
048: import javax.media.j3d.*;
049: import com.sun.j3d.utils.universe.*;
050:
051: /**
052: * Abstract class for ViewPlatformBehaviors. A ViewPlatformBehavior must
053: * be added to the ViewingPlatform with the
054: * ViewingPlatform.addViewPlatformBehavior() method. The ViewPlatformBehavior
055: * will operate on the ViewPlatform transform (the TransformGroup return by
056: * ViewingPlatform.getViewPlatformTransform()).
057: * @since Java 3D 1.2.1
058: */
059: abstract public class ViewPlatformBehavior extends Behavior {
060:
061: /**
062: * The ViewingPlatform for this behavior.
063: */
064: protected ViewingPlatform vp;
065:
066: /**
067: * The target TransformGroup for this behavior.
068: */
069: protected TransformGroup targetTG;
070:
071: /**
072: * The "home" transform for this behavior. This is a transform used to
073: * position and orient the ViewingPlatform to a known point of interest.
074: *
075: * @since Java 3D 1.3
076: */
077: protected Transform3D homeTransform = null;
078:
079: /**
080: * Sets the ViewingPlatform for this behavior. This method is called by
081: * the ViewingPlatform. If a sub-calls overrides this method, it must
082: * call super.setViewingPlatform(vp).<p>
083: *
084: * NOTE: Applications should <i>not</i> call this method.
085: *
086: * @param vp the target ViewingPlatform for this behavior
087: */
088: public void setViewingPlatform(ViewingPlatform vp) {
089: this .vp = vp;
090:
091: if (vp != null)
092: targetTG = vp.getViewPlatformTransform();
093: else
094: targetTG = null;
095: }
096:
097: /**
098: * Returns the ViewingPlatform for this behavior
099: * @return the ViewingPlatform for this behavior
100: */
101: public ViewingPlatform getViewingPlatform() {
102: return vp;
103: }
104:
105: /**
106: * Copies the given Transform3D into the "home" transform, used to
107: * position and reorient the ViewingPlatform to a known point of interest.
108: *
109: * @param home source transform to be copied
110: * @since Java 3D 1.3
111: */
112: public void setHomeTransform(Transform3D home) {
113: if (homeTransform == null)
114: homeTransform = new Transform3D(home);
115: else
116: homeTransform.set(home);
117: }
118:
119: /**
120: * Returns the behaviors "home" transform.
121: *
122: * @param home transform to be returned
123: * @since Java 3D 1.3
124: */
125: public void getHomeTransform(Transform3D home) {
126: home.set(homeTransform);
127: }
128:
129: /**
130: * Positions and reorients the ViewingPlatform to its "home" transform.
131: * @since Java 3D 1.3
132: */
133: public void goHome() {
134: if (targetTG != null && homeTransform != null)
135: targetTG.setTransform(homeTransform);
136: }
137: }
|