#include <ParamI.h>
Inheritance diagram for Composition::ParamVector2C:
The 2D vector parameter can used to control everything where two parameter is enough. This parameter can have extra styles which enables it to be used as a percentage or an angle parameter. Also a couple of flags enables it to be used efficiently as positional parameter. This parameter type can also be edited in the Layout view if prper styles are set.
A new 2D vector parameter is created using the create_new() static method.
|
Default constructor.
|
|
Constructor.
|
|
Constructor with reference to the original.
|
|
Default destructor.
|
|
Deep copy from a data block, see Edit::DataBlockI::copy().
Reimplemented from Composition::ParamI. |
|
Creates new datablock, with reference to the original.
Reimplemented from Edit::EditableI. |
|
Creates new parameter. Following default values are used: pParent = 0, szName = 0, rValue = (0, 0), ui32ID = 0, ui32Style = 0, bAnimatable = false, rMin = (0, 0), rMax = (0, 0), f32Inc = 0.1f
Reimplemented from Edit::EditableI. |
|
Creates a new 2D vector parameter.
The only type-in style is editbox. If PARAM_STYLE_PERCENT is set, percent marks are used in the GUI, and also the values are multiplied by 100 before displayed. That is, the value for 100% is 1.0. If PARAM_STYLE_ANGLE is set, the angle mark is shown in the GUI. The value is not scaled. If PARAM_STYLE_ABS_POSITION is set the parameter is treated as absolute position from the layout origo (lower left corner). Absolute positions are always in the world space. If the parameter is the position of the effect, this style has to be set. If PARAM_STYLE_REL_POSITION is set the parameter is treated as relative to the position of the effect (not including the pivot). If the parameter is the pivot of the effect, this style has to be set along with the PARAM_STYLE_WORLD_SPACE style. If PARAM_STYLE_WORLD_SPACE is set the parameter is in the world space coordinate system. The world space coordinate system is the same as the layouts coord-sys. If PARAM_STYLE_OBJECT_SPACE is set the parameter is in the object space coordinate system. The object space coordinate system is the same as the effect's coord-sys. If this style is set, the point this parameter defines will move along with the effect as it rotates, scales, or when it's pivot is changed. If the parameter has PARAM_STYLE_ABS_POSITION or PARAM_STYLE_REL_POSITION style the parameter can be edited in the Layout view. Example: This example creates new parameter. The name of the parameter is "Center", it's default value is (0, 0) and it's ID is ID_CENTER (constant defined by the plugin writer), the type-in style is editbox, the parameter can be animated, and no range is defined. The represents a position which is relative to the effect position and is in effects coordinate system. The is used as effect's center point and therefore it has to transform along with the effect. Spinner increment is default 0.1.
m_pParamCenter = ParamVector2C::create_new( this, "Center", Vector2C(), ID_CENTER, PARAM_STYLE_EDITBOX | PARAM_STYLE_REL_POSITION | PARAM_STYLE_OBJECT_SPACE, PARAM_ANIMATABLE ); |
|
Returns the conroller attached to the parameter. NULL is returned if the parameter cannot be animated. Reimplemented from Composition::ParamI. |
|
Returns the ID of the parameter.
Reimplemented from Composition::ParamI. |
|
Returns the spinner increment.
Reimplemented from Composition::ParamI. |
|
Returns the maximum of the value range.
|
|
Returns the minimum of the value range.
|
|
Returns the range of the parameter.
Reimplemented from Composition::ParamI. |
|
Returns the style of the parameter.
Reimplemented from Composition::ParamI. |
|
Returns the type of the parameter.
Reimplemented from Composition::ParamI. |
|
Gets the value of the parameter at specified time.
|
|
Returns the value of the parameter.
Reimplemented from Composition::ParamI. |
|
Serialize the parameter from a Demopaja input stream.
Reimplemented from Composition::ParamI. |
|
Shallow copy from a editable, see Edit::EditableI::restore().
Reimplemented from Composition::ParamI. |
|
Serialize the parameter to a Demopaja output stream.
Reimplemented from Composition::ParamI. |
|
Sets the controller of the parameter.
Reimplemented from Composition::ParamI. |
|
Sets the ID of the parmeter.
Reimplemented from Composition::ParamI. |
|
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 from Composition::ParamI. |
|
Sets the range of the parameter.
|
|
Sets the style of the parameter.
Reimplemented from Composition::ParamI. |
|
Sets the value of the parameter at specified time.
|
|
Sets the value of the parameter.
Reimplemented from Composition::ParamI. |