@MediaClass(uuid1=218169601, uuid2=257, uuid3=15872, uuid4={6,14,43,52,2,6,1,1}, definedName="VaryingValue", description="The VaryingValue class specifies a changing data value for an effect control value.", symbol="VaryingValue") public class VaryingValueImpl extends ParameterImpl implements VaryingValue, Serializable, Cloneable
Implements a changing data value for an effect control value.
ObjectClassPropertyID| Constructor and Description |
|---|
VaryingValueImpl() |
VaryingValueImpl(ParameterDefinition parameterDefinition,
InterpolationDefinition interpolation)
Creates and initializes a new varying value object, which specifies a
changing data value for an effect control value.
|
| Modifier and Type | Method and Description |
|---|---|
void |
appendControlPoint(ControlPoint controlPoint)
Adds a control point to the
sequence of control points of this varying value, each of which specifies a value
and a time point at which the value is defined.
|
void |
clearControlPoints() |
VaryingValue |
clone()
Create a cloned copy of this interchange object.
|
int |
countControlPoints()
Returns the number of control points in
the sequence of control points of this varying value, each of which specifies a
value and a time point at which the value is defined.
|
ControlPoint |
getControlPointAt(int index)
Retrieves the input control point
at the given index in the sequence of control points of this varying
value, each of which specifies a value and a time point at which the value
is defined.
|
List<ControlPoint> |
getControlPoints()
Returns the sequence of control points of this varying value, each of which specifies a value
and a time point at which the value is defined.
|
Object |
getInterpolatedValue(Rational inputValue)
Returns the interpolated value of the
varying value at a given time position, which should be a value
between 0 and 1 inclusive.
|
InterpolationDefinition |
getInterpolationDefinition()
Returns the interpolation property of
this varying value, which specifies the kind of interpolation to be used
to find the value between control points.
|
static InterpolationDefinition |
initializeInterpolation() |
List<ControlPoint> |
initializePointList() |
void |
removeControlPointAt(int index)
This function removes the input control point
at the given index in the sequence of control points of this varying
value, each of which specifies a value
and a time point at which the value is defined.
|
void |
setInterpolationDefinition(InterpolationDefinition interpolation) |
getComment, getParameterDefinition, getParameterDefinitionReference, getParameterDefinitionReferenceString, getTypeDefinition, initializeParameterDefinitionReference, setParameterDefinition, setParameterDefinitionReference, setParameterDefinitionReferenceFromStream, setParameterDefinitionReferenceStringaddApplicationPlugin, appendXMLChildren, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getLinkedGenerationIDString, getObjectClass, getPersistentID, getPersistentIndex, hashCode, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setLinkedGenerationIDString, setObjectClass, setPersistentID, setPersistentIndex, toStringgetParameterDefinition, getParameterDefinitionReference, getTypeDefinitionaddApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexpublic VaryingValueImpl()
public VaryingValueImpl(ParameterDefinition parameterDefinition, InterpolationDefinition interpolation) throws NullPointerException
Creates and initializes a new varying value object, which specifies a
changing data value for an effect control value. The value is identified with the
given the given parameter definition, and requires an
interpolation definition. Although the list of
control points should not be empty, varying values are used to create control point.
The process of setting up a varying value is as follows:
#appendControlPoint(ControlPointImpl).parameterDefinition - Parameter definition for the varying value, which
determines the type of the varying value.interpolation - Specifies the kind of interpolation to be used to
find the value between control points.NullPointerException - One or more of the arguments is null and
all are required.@MediaProperty(uuid1=100729092, uuid2=1542, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="PointList", typeName="ControlPointStrongReferenceVector", optional=false, uniqueIdentifier=false, pid=19970, symbol="PointList") public List<ControlPoint> getControlPoints()
VaryingValueReturns the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined.
getControlPoints in interface VaryingValueTypeDefinitions.ControlPointStrongReferenceVectorpublic final List<ControlPoint> initializePointList()
@MediaListAppend(value="PointList") public void appendControlPoint(ControlPoint controlPoint) throws NullPointerException, IllegalArgumentException
VaryingValueAdds a control point to the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined. The point will be sorted by time order, not the order that the points were added in.
appendControlPoint in interface VaryingValuecontrolPoint - Control point to add to the sequence of control
points.NullPointerException - The given control point is null.IllegalArgumentException@MediaPropertyCount(value="PointList") public int countControlPoints()
VaryingValueReturns the number of control points in the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined.
countControlPoints in interface VaryingValue@MediaPropertyClear(value="PointList") public void clearControlPoints()
@MediaListGetAt(value="PointList") public ControlPoint getControlPointAt(int index) throws IndexOutOfBoundsException
VaryingValueRetrieves the input control point at the given index in the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined.
getControlPointAt in interface VaryingValueindex - 0-based index of the control point to retrieve.IndexOutOfBoundsException - The given index is outside the
acceptable range for the current sequence of control points of this
varying value.@MediaListRemoveAt(value="PointList") public void removeControlPointAt(int index) throws IndexOutOfBoundsException
VaryingValueThis function removes the input control point at the given index in the sequence of control points of this varying value, each of which specifies a value and a time point at which the value is defined. Control points already existing at indices higher than the given index will be moved to the next lower index to accommodate.
removeControlPointAt in interface VaryingValueindex - Index of control point to remove from the sequence.IndexOutOfBoundsException - The index is outside acceptable
range for the current sequence of control points of this varying
value.public Object getInterpolatedValue(Rational inputValue) throws NullPointerException, NotImplementedException
VaryingValueReturns the interpolated value of the varying value at a given time position, which should be a value between 0 and 1 inclusive. The data type of the value contained in the value returned will be the same as the data type of the parameter this varying value provides a value for, which is the same as the data type of all of the control points.
getInterpolatedValue in interface VaryingValueinputValue - Time position along the operation group to find the
interpolated value for.NullPointerException - The given input value is null.NotImplementedExceptionVaryingValue.getInterpolationDefinition(),
InterpolationConstant,
Parameter.getTypeDefinition(),
ControlPoint.getTypeDefinition(),
TypeDefinition.createValue(Object),
PropertyValue.getValue()@MediaProperty(uuid1=100729092, uuid2=261, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Interpolation", typeName="InterpolationDefinitionWeakReference", optional=false, uniqueIdentifier=false, pid=19969, symbol="Interpolation") public InterpolationDefinition getInterpolationDefinition()
VaryingValueReturns the interpolation property of this varying value, which specifies the kind of interpolation to be used to find the value between control points.
getInterpolationDefinition in interface VaryingValueVaryingValue.getInterpolatedValue(Rational),
InterpolationConstant,
TypeDefinitions.InterpolationDefinitionWeakReference@MediaPropertySetter(value="Interpolation") public void setInterpolationDefinition(InterpolationDefinition interpolation) throws NullPointerException
interpolation - NullPointerExceptionpublic static final InterpolationDefinition initializeInterpolation()
public VaryingValue clone()
InterchangeObjectCreate a cloned copy of this interchange object.
clone in interface MediaEntityclone in interface InterchangeObjectclone in interface Parameterclone in interface VaryingValueclone in class ParameterImpl(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.