| java.lang.Object
 com.sun.perseus.model.StringSegment
| StringSegment | | class StringSegment implements Segment(Code) | | Represents String segment in an animation.
version:
$Id: StringSegment.java,v 1.3 2006/06/29 10:47:34 ln156897 Exp $ |
| Method Summary | |
| public void | addToEnd(Object[] by)
Adds the input value to this Segment's end value.
Parameters:
by - the value to add. | | public void | collapse(Segment seg, Animation anim)
Collapses this segment with the one passed as a parameter.
Note that if the input segment is not of the same class
as this one, an IllegalArgumentException is thrown. | | public String[] | compute(float p)
Computes an interpolated value for the given penetration in the
segment.
Parameters:
p - the segment penetration. | | public Object[] | getEnd()
| | final public float | getLength()
Computes this segment's length. | | public Object[] | getStart()
| | final public void | initialize()
Should be called after the segment's configuration is complete
to give the segment's implementation a chance to initialize
internal data and cache values. | | public boolean | isAdditive()
true if this segment type supports addition. | | public void | setStart(Object[] newStart)
Sets the start value. | | public void | setZeroStart()
Sets the start value to its notion of 'zero'. | | public String | toString()
Debug helper. |
| addToEnd | | public void addToEnd(Object[] by)(Code) | | Adds the input value to this Segment's end value.
Parameters:
by - the value to add. Throws IllegalArgumentException if thisSegment type is not additive or if the input value is incompatible (e.g.,different number of components or different number of dimensions on acomponent). |
| collapse | | public void collapse(Segment seg, Animation anim)(Code) | | Collapses this segment with the one passed as a parameter.
Note that if the input segment is not of the same class
as this one, an IllegalArgumentException is thrown. The
method also throws an exception if the input segment's
end does not have the same number of components as this
segment's end.
After this method is called, this segment's end value
is the one of the input seg parameter.
Parameters:
seg - the Segment to collapse with this one.
Parameters:
anim - the Animation this segment is part of. |
| compute | | public String[] compute(float p)(Code) | | Computes an interpolated value for the given penetration in the
segment.
Parameters:
p - the segment penetration. Should be in the [0, 1] range. the interpolated value. |
| getLength | | final public float getLength()(Code) | | Computes this segment's length. This is always the value
'1' for a string segment.
|
| initialize | | final public void initialize()(Code) | | Should be called after the segment's configuration is complete
to give the segment's implementation a chance to initialize
internal data and cache values.
|
| isAdditive | | public boolean isAdditive()(Code) | | true if this segment type supports addition. falseotherwise. |
| setStart | | public void setStart(Object[] newStart)(Code) | | Sets the start value.
Parameters:
newStart - the new segment start value. |
| setZeroStart | | public void setZeroStart()(Code) | | Sets the start value to its notion of 'zero'.
For a StringSegment, a 'zero' start means empty strings
on all components.
|
|
|