ControlPoint (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 ControlPoint

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.ControlPoint

All Implemented Interfaces:: Serializable, Cloneable, MAJCommon, ControlPoint, InterchangeObject, XMLSerializable

@AAFClass(uuid1=218169601, uuid2=257, uuid3=6400, uuid4={6,14,43,52,2,6,1,1}, definedName="ControlPoint", description="The ControlPoint class specifies a value and a time point and is used to specify an effect control value.") public class ControlPoint
extends InterchangeObject
implements ControlPoint, Serializable, Cloneable, MAJCommon
extends InterchangeObject
implements ControlPoint, Serializable, Cloneable, MAJCommon

Implements a value and a time point (position) that is used to specify an effect control value. Control points must be added to a varying value that is then added to the operation group describing the effect.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:: Richard Cartwright
See Also:: Serialized Form

Nested Class Summary
`static class`	`ControlPoint.XMLHandler`

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

Constructor Summary
`ControlPoint(VaryingValue varyingValue, Rational time, Object value)` Creates and initializes a new control point object, which specifies a value and a time point and is used to specify an effect control value.

Method Summary
`void`	`appendXMLChildren(Node parent)` Append child elements to the given parent node to serialize the value of an object to an XML fragment.
`ControlPoint`	`clone()` Creates a cloned copy of this entity.
`boolean`	`equals(Object o)` Tests to see if the given object is equal to this interchange object.
`EditHintType`	`getEditHint()` Returns the edit hint of the control point, which describes how to alter the position (time) of the operation group is made longer or shorter.
`Rational`	`getTime()` Returns the time property of this control point, which specifies the time within the varying value segment for which the value is defined.
`TypeDefinition`	`getTypeDefinition()` Returns the type definition of the value of this control point.
`Object`	`getValue()` Returns the control point value at the control point's postition (time), which is a value of the data type returned by `ControlPoint.getTypeDefinition()`.
`int`	`hashCode()` Returns a hash code value for this interchange object.
`void`	`setEditHint(EditHintType editHint)` Sets the control point edit hint value, which describes how to alter the position (time) if the operation group is made longer or shorter.
`void`	`setPropertiesFromInterface(ControlPoint castFrom)`
`void`	`setTime(Rational time)` Sets the position of the control point within an operation group, which specifies the time within the varying value segment for which the value is defined.
`void`	`setValue(Object value)` Set the data value describing this control point at the control point's postition (time), which is a value of the data type returned by `ControlPoint.getTypeDefinition()`..

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, wait, wait, wait`

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

ControlPoint

public ControlPoint(VaryingValue varyingValue,
                    Rational time,
                    Object value)
             throws NullPointerException,
                    RationalRangeException

Creates and initializes a new control point object, which specifies a value and a time point and is used to specify an effect control value.

Parameters:: varyingValue - A varying value. This determines the type of this control point through the parameter definition.; time - Specifies the time within the VaryingValue segment for which the value is defined, with a value between 0 and 1.; value - Control point value.
Throws:: NullPointerException - One or more of the arguments is null and all values are required.; RationalRangeException - Rational time value is outside the inclusive range 0.0 to 1.0.; ClassCastException - Cannot cast the given Java value to the given AAF type definition.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(ControlPoint castFrom)

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