artofillusion.animation
Class PositionTrack

java.lang.Object
  extended by artofillusion.animation.Track
      extended by artofillusion.animation.PositionTrack

public class PositionTrack
extends Track

This is a Track which controls the position of an object.


Field Summary
static int ABSOLUTE
           
static int LOCAL
           
static int OBJECT
           
static int PARENT
           
static int RELATIVE
           
static int WORLD
           
 
Constructor Summary
PositionTrack(ObjectInfo info)
           
PositionTrack(ObjectInfo info, java.lang.String name, boolean affectX, boolean affectY, boolean affectZ)
           
 
Method Summary
 boolean affectsX()
          Determine whether this track affects the X coordinate.
 boolean affectsY()
          Determine whether this track affects the Y coordinate.
 boolean affectsZ()
          Determine whether this track affects the Z coordinate.
 void apply(double time)
          Modify the position of the object.
 boolean canAcceptAsParent(java.lang.Object obj)
          Determine whether this track can be added as a child of an object.
 void copy(Track tr)
          Make this track identical to another one.
 void deleteDependencies(ObjectInfo obj)
          Delete all references to the specified object from this track.
 void deleteKeyframe(int which)
          Delete the specified keyframe.
 Track duplicate(java.lang.Object obj)
          Create a duplicate of this track.
 void edit(LayoutWindow win)
          This method presents a window in which the user can edit the track.
 void editKeyframe(LayoutWindow win, int which)
          Present a window in which the user can edit the specified keyframe.
 int getApplyToJoint()
          Get the ID of the joint this track applies to, or -1 if it applies to the object origin.
 int getCoordinateSystem()
          Get the coordinate system of this track (WORLD, PARENT, OBJECT, or LOCAL).
 ObjectRef getCoordsObject()
          Get the object reference for the parent coordinate system.
 double[] getDefaultGraphValues()
          Get the default list of graphable values (for a track which has no keyframes).
 ObjectInfo[] getDependencies()
          Get an array of any objects which this track depends on (and which therefore must be updated before this track is applied).
 double[] getKeyTimes()
          Get a list of all keyframe times for this track.
 java.lang.Object getParent()
          Get the parent object of this track.
 int getSmoothingMethod()
          Get the smoothing method for this track.
 Track[] getSubtracks()
          This has a single child track.
 Timecourse getTimecourse()
          Get the timecourse describing this track.
 java.lang.String[] getValueNames()
          Get the names of all graphable values for this track.
 double[][] getValueRange()
          Get the allowed range for graphable values.
 void initFromStream(java.io.DataInputStream in, Scene scene)
          Initialize this tracked based on its serialized representation as written by writeToStream().
 boolean isNullTrack()
          This track is null if it has no keyframes.
 boolean isRelative()
          Determine whether this track is in absolute or relative mode.
 int moveKeyframe(int which, double time)
          Move a keyframe to a new time, and return its new position in the list.
 void setApplyToJoint(int jointID)
          Set the ID of the joint this track applies to.
 void setCoordinateSystem(int system)
          Set the coordinate system of this track (WORLD, PARENT, OBJECT, or LOCAL).
 void setCoordsObject(ObjectRef obj)
          Set the object reference for the parent coordinate system.
 void setKeyframe(double time, Keyframe k, Smoothness s)
          Set a keyframe at the specified time.
 Keyframe setKeyframe(double time, Scene sc)
          Set a keyframe at the specified time, based on the current state of the Scene.
 Keyframe setKeyframeIfModified(double time, Scene sc)
          Set a keyframe at the specified time, based on the current state of the Scene, if and only if the Scene does not match the current state of the track.
 void setParent(java.lang.Object obj)
          Set the parent object of this track.
 void setRelative(boolean rel)
          Set whether this track is in absolute or relative mode.
 void setSmoothingMethod(int method)
          Set the smoothing method for this track.
 void updateObjectReferences(java.util.Map<ObjectInfo,ObjectInfo> objectMap)
          Update any references to objects this track depends on.
 void writeToStream(java.io.DataOutputStream out, Scene scene)
          Write a serialized representation of this track to a stream.
 
Methods inherited from class artofillusion.animation.Track
getGraphValues, getName, isEnabled, isQuantized, setEnabled, setName, setQuantized
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ABSOLUTE

public static final int ABSOLUTE
See Also:
Constant Field Values

RELATIVE

public static final int RELATIVE
See Also:
Constant Field Values

WORLD

public static final int WORLD
See Also:
Constant Field Values

PARENT

public static final int PARENT
See Also:
Constant Field Values

OBJECT

public static final int OBJECT
See Also:
Constant Field Values

LOCAL

public static final int LOCAL
See Also:
Constant Field Values
Constructor Detail

PositionTrack

public PositionTrack(ObjectInfo info)

PositionTrack

public PositionTrack(ObjectInfo info,
                     java.lang.String name,
                     boolean affectX,
                     boolean affectY,
                     boolean affectZ)
Method Detail

apply

public void apply(double time)
Modify the position of the object.

Specified by:
apply in class Track

duplicate

public Track duplicate(java.lang.Object obj)
Create a duplicate of this track.

Specified by:
duplicate in class Track

copy

public void copy(Track tr)
Make this track identical to another one.

Specified by:
copy in class Track

getKeyTimes

public double[] getKeyTimes()
Get a list of all keyframe times for this track.

Specified by:
getKeyTimes in class Track

getTimecourse

public Timecourse getTimecourse()
Get the timecourse describing this track.

Overrides:
getTimecourse in class Track

setKeyframe

public void setKeyframe(double time,
                        Keyframe k,
                        Smoothness s)
Set a keyframe at the specified time.

Overrides:
setKeyframe in class Track

setKeyframe

public Keyframe setKeyframe(double time,
                            Scene sc)
Set a keyframe at the specified time, based on the current state of the Scene.

Overrides:
setKeyframe in class Track

setKeyframeIfModified

public Keyframe setKeyframeIfModified(double time,
                                      Scene sc)
Set a keyframe at the specified time, based on the current state of the Scene, if and only if the Scene does not match the current state of the track. Return the new Keyframe, or null if none was set.

Overrides:
setKeyframeIfModified in class Track

moveKeyframe

public int moveKeyframe(int which,
                        double time)
Move a keyframe to a new time, and return its new position in the list.

Specified by:
moveKeyframe in class Track

deleteKeyframe

public void deleteKeyframe(int which)
Delete the specified keyframe.

Specified by:
deleteKeyframe in class Track

isNullTrack

public boolean isNullTrack()
This track is null if it has no keyframes.

Specified by:
isNullTrack in class Track

affectsX

public boolean affectsX()
Determine whether this track affects the X coordinate.


affectsY

public boolean affectsY()
Determine whether this track affects the Y coordinate.


affectsZ

public boolean affectsZ()
Determine whether this track affects the Z coordinate.


getSubtracks

public Track[] getSubtracks()
This has a single child track.

Overrides:
getSubtracks in class Track

canAcceptAsParent

public boolean canAcceptAsParent(java.lang.Object obj)
Determine whether this track can be added as a child of an object.

Overrides:
canAcceptAsParent in class Track

getParent

public java.lang.Object getParent()
Get the parent object of this track.

Overrides:
getParent in class Track

setParent

public void setParent(java.lang.Object obj)
Set the parent object of this track.

Overrides:
setParent in class Track

getSmoothingMethod

public int getSmoothingMethod()
Get the smoothing method for this track.

Overrides:
getSmoothingMethod in class Track

setSmoothingMethod

public void setSmoothingMethod(int method)
Set the smoothing method for this track.


isRelative

public boolean isRelative()
Determine whether this track is in absolute or relative mode.


setRelative

public void setRelative(boolean rel)
Set whether this track is in absolute or relative mode.


getCoordinateSystem

public int getCoordinateSystem()
Get the coordinate system of this track (WORLD, PARENT, OBJECT, or LOCAL).


setCoordinateSystem

public void setCoordinateSystem(int system)
Set the coordinate system of this track (WORLD, PARENT, OBJECT, or LOCAL).


getCoordsObject

public ObjectRef getCoordsObject()
Get the object reference for the parent coordinate system. The return value is undefined if getCoordinateSystem() does not return OBJECT.


setCoordsObject

public void setCoordsObject(ObjectRef obj)
Set the object reference for the parent coordinate system. This causes the coordinate system to be set to OBJECT.


getApplyToJoint

public int getApplyToJoint()
Get the ID of the joint this track applies to, or -1 if it applies to the object origin.


setApplyToJoint

public void setApplyToJoint(int jointID)
Set the ID of the joint this track applies to. Specify -1 if it should apply to the object origin.


getValueNames

public java.lang.String[] getValueNames()
Get the names of all graphable values for this track.

Overrides:
getValueNames in class Track

getDefaultGraphValues

public double[] getDefaultGraphValues()
Get the default list of graphable values (for a track which has no keyframes).

Overrides:
getDefaultGraphValues in class Track

getValueRange

public double[][] getValueRange()
Get the allowed range for graphable values. This returns a 2D array, where elements [n][0] and [n][1] are the minimum and maximum allowed values, respectively, for the nth graphable value.

Overrides:
getValueRange in class Track

getDependencies

public ObjectInfo[] getDependencies()
Get an array of any objects which this track depends on (and which therefore must be updated before this track is applied).

Overrides:
getDependencies in class Track

deleteDependencies

public void deleteDependencies(ObjectInfo obj)
Delete all references to the specified object from this track. This is used when an object is deleted from the scene.

Overrides:
deleteDependencies in class Track

updateObjectReferences

public void updateObjectReferences(java.util.Map<ObjectInfo,ObjectInfo> objectMap)
Description copied from class: Track
Update any references to objects this track depends on. Any reference to an object found as a key in the map should be replaced with the corresponding object. This is used, for example, when copying and pasting objects between scenes.

Overrides:
updateObjectReferences in class Track

writeToStream

public void writeToStream(java.io.DataOutputStream out,
                          Scene scene)
                   throws java.io.IOException
Write a serialized representation of this track to a stream.

Specified by:
writeToStream in class Track
Throws:
java.io.IOException

initFromStream

public void initFromStream(java.io.DataInputStream in,
                           Scene scene)
                    throws java.io.IOException,
                           java.io.InvalidObjectException
Initialize this tracked based on its serialized representation as written by writeToStream().

Specified by:
initFromStream in class Track
Throws:
java.io.IOException
java.io.InvalidObjectException

editKeyframe

public void editKeyframe(LayoutWindow win,
                         int which)
Present a window in which the user can edit the specified keyframe.

Overrides:
editKeyframe in class Track

edit

public void edit(LayoutWindow win)
This method presents a window in which the user can edit the track.

Specified by:
edit in class Track


Copyright © 1999-2011 by Peter Eastman.