#include <ParamI.h>
Inheritance diagram for Composition::ParamI:
Parameter class defines a parameter which can be edited and animated in Demopaja GUI. ParamI implements a base class for all parameters.
An ID is attached to each parameter. When a parameter is changed on a gizmo, the parameter send a notify to the gizmo via the update_notify() method, the update notify is relayed to the effect via effects update_notify method. When handling a notify message each parameter and gizmo can be identified from the ID. The ID of a parameter is specified in the create method or it can be changed with the set_id() method.
If the value range of a animated parameter is changed no range checking is done to the keyframes in the controller. The plugin has to either clanp the keys, or handle the parameters out of the range.
The content of the parameter (including name, range, etc) can be changed at any time, and the change is shown next time the GUI is updated. A common place to change a parameter is on update_notify() method of a gizmo or an effect. Parameters are ment to be created at the constructor of a gizmo. Hence, the some of the properties of the parameter namely, the name of the parameter, the style and the ID are not serialized to the stream.
Demopaja does not currently support overridden parameters.
All the parameters classes are implemented by the system.
|
Default constructor.
|
|
Constructor with reference to the original.
|
|
Constructor.
|
|
Default destructor.
|
|
Sets only specified flags.
|
|
Deep copy from a data block, see Edit::DataBlockI::copy().
Reimplemented from Edit::EditableI. Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Removes only specified flags.
|
|
Returns the conroller attached to the parameter. NULL is returned if the parameter cannot be animated. Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Returns the expanded height of the parameter (used by the GUI).
|
|
Returns gizmo flags.
|
|
Returns the ID of the parameter.
Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Returns the spinner increment.
Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Returns the range of the parameter.
Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Returns the name of the parameter.
|
|
Sets the parent gizmo of the parameter.
|
|
Returns the style of the parameter.
Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Returns the type of the parameter.
Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Returns the value of the parameter.
Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Serialize the parameter from a Demopaja input stream.
Reimplemented from Edit::EditableI. Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Shallow copy from a editable, see Edit::EditableI::restore().
Reimplemented from Edit::EditableI. Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Serialize the parameter to a Demopaja output stream.
Reimplemented from Edit::EditableI. Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Sets the controller of the parameter.
Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Sets the expanded height of the parameter (used by the GUI).
|
|
Sets the parameter flags.
|
|
Sets the ID of the parmeter.
Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Sets the spinner increment of the parameter. The spinner increment is the smallest value the parameter is meant to control. For 1/10th accuracy use spinner increment of 0.1. The spinner increment is used in the spinners of the type-ins and also to draw the values in the GUI. Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Sets the name of the parameter.
|
|
Returns the parent gizmo of the parameter.
|
|
Sets the style of the parameter.
Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Sets the value of the parameter.
Reimplemented in Composition::ParamIntC, Composition::ParamFloatC, Composition::ParamVector2C, Composition::ParamVector3C, Composition::ParamColorC, Composition::ParamTextC, and Composition::ParamFileC. |
|
Toggles only specified flags.
|