@MediaClass(uuid1=218169601, uuid2=257, uuid3=7424, uuid4={6,14,43,52,2,6,1,1}, definedName="ParameterDefinition", description="The ParameterDefinition class defines a kind of Parameter for an effect.", symbol="ParameterDefinition") public class ParameterDefinitionImpl extends DefinitionObjectImpl implements ParameterDefinition, Serializable, ParameterConstant, Cloneable
Implements the definition of a kind of parameter for an effect.
ObjectClassPropertyIDAlphaKeyInvertAlpha, Amplitude, CropBottom, CropLeft, CropRight, CropTop, IncomingLevel, Level, LumKeyClip, LumKeyLevel, OutgoingLevel, Pan, PhaseOffset, PinBottomLeftX, PinBottomLeftY, PinBottomRightX, PinBottomRightY, PinTopLeftX, PinTopLeftY, PinTopRightX, PinTopRightY, PositionOffsetX, PositionOffsetY, Rotation, ScaleX, ScaleY, SMPTEBorder, SMPTECheckerboard, SMPTEModulator, SMPTEPosition, SMPTEReplicationH, SMPTEReplicationV, SMPTEReverse, SMPTEShadow, SMPTESoft, SMPTESpotlight, SMPTETumble, SMPTEWipeNumber, SpeedRatio| Constructor and Description |
|---|
ParameterDefinitionImpl() |
ParameterDefinitionImpl(AUID identification,
String name,
TypeDefinition type)
Creates and initializes a new parameter definition, which defines a kind of parameter for
an effect.
|
| Modifier and Type | Method and Description |
|---|---|
ParameterDefinition |
clone()
Create a cloned copy of this interchange object.
|
static int |
count() |
static ParameterDefinition |
forAUID(AUID identification) |
static ParameterDefinition |
forIdentification(AUID identification) |
static ParameterDefinition |
forName(String parameterName) |
String |
getParameterDisplayUnits()
Returns the display unit property of this parameter definition, which is a displayable
string identifying the units in which the parameter is measured.
|
TypeDefinition |
getParameterType()
Returns the type definition attached to
this parameter definition, which specifies the data type of the parameter.
|
static TypeDefinition |
initializeParameterType() |
static Collection<String> |
inventory() |
static boolean |
registerParameterDefinition(ParameterDefinition parameterDefinition) |
static int |
registerParametersFromClass(Class<?> classWithParameters) |
void |
setParameterDisplayUnits(String displayUnits)
Sets the display units of this parameter definition, which is a displayable string
identifying the units in which the parameter is measured.
|
void |
setParameterType(TypeDefinition parameterType) |
getAUID, getDefinitionObjectIdentificationString, getDescription, getLocalizedUID, getName, getWeakTargetReference, initializeDefinitionObjectIdentification, initializeDefinitionObjectName, setAUID, setDefinitionObjectIdentificationString, setDescription, setLocalizedUID, setNameaddApplicationPlugin, appendXMLChildren, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getComment, getGeneration, getLinkedGenerationID, getLinkedGenerationIDString, getObjectClass, getPersistentID, getPersistentIndex, hashCode, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setLinkedGenerationIDString, setObjectClass, setPersistentID, setPersistentIndex, toStringgetAUID, getDescription, getName, setDescription, setNameaddApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexgetWeakTargetReferencepublic ParameterDefinitionImpl()
public ParameterDefinitionImpl(AUID identification, @AAFString String name, TypeDefinition type) throws NullPointerException
Creates and initializes a new parameter definition, which defines a kind of parameter for an effect.
identification - Uniquely identifies the parameter definition.name - Display name of the parameter definition.type - Data type of the parameter.NullPointerException - One or more of the arguments is null and they
are all required properties in this implementation.public static final int registerParametersFromClass(Class<?> classWithParameters) throws NullPointerException
NullPointerExceptionpublic static final boolean registerParameterDefinition(ParameterDefinition parameterDefinition) throws NullPointerException
NullPointerExceptionpublic static final ParameterDefinition forName(String parameterName) throws NullPointerException
NullPointerExceptionpublic static final ParameterDefinition forIdentification(AUID identification) throws NullPointerException
NullPointerExceptionpublic static final ParameterDefinition forAUID(AUID identification) throws NullPointerException
NullPointerExceptionpublic static final Collection<String> inventory()
public static final int count()
@MediaProperty(uuid1=87033099, uuid2=256, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="ParameterDisplayUnits", aliases="DisplayUnits", typeName="UTF16String", optional=true, uniqueIdentifier=false, pid=7939, symbol="ParameterDisplayUnits") public String getParameterDisplayUnits() throws PropertyNotPresentException
ParameterDefinitionReturns the display unit property of this parameter definition, which is a displayable string identifying the units in which the parameter is measured. For example: "% of picture width". This property is optional.
getParameterDisplayUnits in interface ParameterDefinitionPropertyNotPresentException - The optional display units property
is not present in this parameter definition.@MediaPropertySetter(value="ParameterDisplayUnits") public void setParameterDisplayUnits(String displayUnits)
ParameterDefinitionSets the display units of this parameter definition, which is a displayable string
identifying the units in which the parameter is measured. For example: "% of
picture width". Set this optional property to null to omit
it.
setParameterDisplayUnits in interface ParameterDefinitiondisplayUnits - Display units of this parameter definition.@MediaProperty(uuid1=100729092, uuid2=262, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="ParameterType", aliases={"Type","ParameterDefinitionType"}, typeName="TypeDefinitionWeakReference", optional=false, uniqueIdentifier=false, pid=7937, symbol="ParameterType") public TypeDefinition getParameterType()
ParameterDefinitionReturns the type definition attached to this parameter definition, which specifies the data type of the parameter.
getParameterType in interface ParameterDefinition@MediaPropertySetter(value="ParameterType") public void setParameterType(TypeDefinition parameterType) throws NullPointerException
NullPointerExceptionpublic static final TypeDefinition initializeParameterType()
public ParameterDefinition clone()
InterchangeObjectCreate a cloned copy of this interchange object.
clone in interface MediaEntityclone in interface DefinitionObjectclone in interface InterchangeObjectclone in interface ParameterDefinitionclone in class DefinitionObjectImpl(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.