VaryingValue (MAJ API)

Overview

Package

Class

Tree

Deprecated

Index

Media Authoring
with Java API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

tv.amwa.maj.entity
Class VaryingValue

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.Parameter
          tv.amwa.maj.entity.VaryingValue

All Implemented Interfaces:: Serializable, Cloneable, MAJCommon, InterchangeObject, Parameter, VaryingValue, XMLSerializable

@AAFClass(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.") public class VaryingValue
extends Parameter
implements VaryingValue, Serializable, Cloneable, MAJCommon
extends Parameter
implements VaryingValue, Serializable, Cloneable, MAJCommon

Implements a changing data value for an effect control value.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:: Richard Cartwright
See Also:: Serialized Form

Nested Class Summary
`static class`	`VaryingValue.PointListXMLHandler`
`static class`	`VaryingValue.XMLHandler`

Nested classes/interfaces inherited from class tv.amwa.maj.entity.Parameter
`Parameter.ParameterXMLHandler`

Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject
`InterchangeObject.InterchangeObjectXMLHandler`

Constructor Summary
`VaryingValue(ParameterDefinition parameterDefinition, InterpolationDefinition interpolation)` Creates and initializes a new varying value object, which specifies a changing data value for an effect control value.

Method Summary
`void`	`addControlPoint(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`	`appendXMLChildren(Node parent)` Append child elements to the given parent node to serialize the value of an object to an XML fragment.
`VaryingValue`	`clone()` Creates a cloned copy of this entity.
`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.
`boolean`	`equals(Object o)` Tests to see if the given object is equal to this interchange object.
`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.
`int`	`hashCode()` Returns a hash code value for this interchange object.
`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`	`setPropertiesFromInterface(VaryingValue castFrom)`

Methods inherited from class tv.amwa.maj.entity.Parameter
`getDefinitionValue, getId, getParameterDefinition, getTypeDefinition, setId, setParameterDefinition, setPropertiesFromInterface`

Methods inherited from class tv.amwa.maj.entity.InterchangeObject
`castFromInterface, countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, registerImplementation, setPropertiesFromInterface, setPropertyValue, toString`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface tv.amwa.maj.iface.Parameter
`getParameterDefinition, getTypeDefinition`

Methods inherited from interface tv.amwa.maj.iface.InterchangeObject
`countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue`

Methods inherited from interface tv.amwa.maj.entity.MAJCommon
`toString`

Constructor Detail

VaryingValue

public VaryingValue(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:

Create a varying value with its parameter and interpolation definition.
Use the varying value to create the control points for the varying value.
Add the control points to the varying value list using addControlPoint(ControlPoint).

Parameters:: 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.
Throws:: NullPointerException - One or more of the arguments is null and all are required.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(VaryingValue castFrom)

See Also:: InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)