tv.amwa.maj.iface
Interface ControlPoint

All Superinterfaces:

InterchangeObject

All Known Implementing Classes:

ControlPoint

public interface ControlPoint
extends InterchangeObject

Specifies 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.

For parameters that are a constant value for an operation group, use a constant value.

Author:

Richard Cartwright

Method Summary

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 getTypeDefinition().
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	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 getTypeDefinition()..

Methods inherited from interface tv.amwa.maj.iface.InterchangeObject

countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue

Method Detail

getTime

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. The value of the time property should be between&nbps;0 and 1 inclusive.

Returns:

Time property of this control point.

getEditHint

EditHintType getEditHint()
                         throws PropertyNotPresentException

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. This is an optional property.

Returns:

A hint to be used if the effect starting time or length is changed during editing.

Throws:

PropertyNotPresentException - The optional edit hint property is not present for this control point.

getValue

Object getValue()

Returns the control point value at the control point's postition (time), which is a value of the data type returned by getTypeDefinition().

Returns:

Control point value.

See Also:

TypeDefinitionIndirect, getTypeDefinition()

setTime

void setTime(Rational time)
             throws RationalRangeException,
                    NullPointerException

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. The value is expressed as a rational value between from 0 to 1.

Parameters:

time - Control point time.

Throws:

RationalRangeException - The rational value is outside the range 0 to 1.

NullPointerException - The given time value is null.

setEditHint

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. Set this optional property to null to omit it.

Parameters:

editHint - Specifies a hint to be used if the effect starting time or length is changed during editing.

getTypeDefinition

TypeDefinition getTypeDefinition()

Returns the type definition of the value of this control point.

Returns:

Type definition associated with the control point data value inside this object.

See Also:

TypeDefinitionIndirect

setValue

void setValue(Object value)
              throws NullPointerException,
                     ClassCastException

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 getTypeDefinition()..

Parameters:

value - The value of this control point at its position (time).

Throws:

NullPointerException - The given control point value is null.

ClassCastException - Cannot cast the given value to the defined type for this control point.

See Also:

TypeDefinition.createValue(Object), PropertyValue.getValue()