#include <ParamI.h>
Inheritance diagram for Composition::ParamFileC:
The file parameter provodes access to the imported files in the Demopaja system for the effect plugins.
Range and spinner increment are not used.
A new file 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, rSuperClassFilter = NULL_SUPERCLASSID, rClassFilter = NULL_CLASSID, ui32ID = 0, ui32Style = 0,
Reimplemented from Edit::EditableI. |
|
Creates a new file parameter.
The super class filter and class filter enables only a defined set of files to be set via this parameter. For example if the superclass filter is SUPERCLASS_IMAGE all the files that are selected via this parameter implement the Import::ImportableImageI interface. Passing null (super) class ID disables the filtering. Example 1: This example creates new parameter. The name of the parameter is "Image", it's super class filter is set to enable only files which support the ImportableImageI interface, any sub-type can be used. Parameter's ID is ID_IMAGE (constant defined by the plugin writer), the type-in style is the default file selector.
m_pParamFile = ParamFileC::create_new( this, "Image", SUPERCLASS_IMAGE, NULL_CLASSID, ID_IMAGE ); Example 2: This example creates new parameter. The name of the parameter is "Scene", the class filters are set to enable only specified file type to be set. Parameter's ID is ID_SCENE (constant defined by the plugin writer), the type-in style is the default file selector.
m_pParamFile = ParamFileC::create_new( this, "Scene", NULL_SUPERCLASSID, MY_3DFILE_CLASSID, ID_3DSCENE ); |
|
Returns the super filter.
|
|
Returns the conroller attached to the parameter. NULL is returned if the parameter cannot be animated. Reimplemented from Composition::ParamI. |
|
Returns the duration of the file. If the duration cannot be determined (for example the data is a still image) negative value is returned. This information is used by the system to draw the duration of the file.
|
|
Returns end label/frame.
|
|
Returns the file handle.
|
|
Returns the ID of the parameter.
Reimplemented from Composition::ParamI. |
|
Returns the spinner increment.
Reimplemented from Composition::ParamI. |
|
Returns the range of the parameter.
Reimplemented from Composition::ParamI. |
|
Returns start label/frame.
|
|
Returns the style of the parameter.
Reimplemented from Composition::ParamI. |
|
Returns the super class filter.
|
|
Returns the time offset\. See: set_time_offset().
|
|
Returns the time scale factor\. See: set_time_scale().
|
|
Returns the type of the parameter.
Reimplemented from Composition::ParamI. |
|
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 class filter.
|
|
Sets the controller of the parameter.
Reimplemented from Composition::ParamI. |
|
Sets the file handle.
|
|
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 style of the parameter.
Reimplemented from Composition::ParamI. |
|
Sets the super class filter.
|
|
Sets the time offset which is used to display the file duration. If it is neccessary an offset can be set to the file parameter. The system uses this offset and the scale factor set by the set_time_scale() method to calculate the duration of the file. The result is then shown in the timegraph. The default offset is zero.
|
|
Sets the scaling factor which is used to scale the duration got from the file. If it is neccessary a scale factor can be set to the file parameter. The system uses this scalefactor and the offset set by the set_time_offset() method to calculate the duration of the file. The result is then shown in the timegraph. The default scale factor is one.
|
|
Sets the value of the parameter.
Reimplemented from Composition::ParamI. |