#include <ImageModel.h>
Inherits SparseModel< ImagePoint >.
Inheritance diagram for ImageModel:
Definition at line 85 of file ImageModel.h.
Public Types | |
| typedef ImagePoint | Point |
| typedef std::multiset< ImagePoint, typename ImagePoint::OrderComparator > | PointList |
| typedef PointList::iterator | PointListIterator |
Public Slots | |
| void | aboutToDelete () |
| void | sourceModelAboutToBeDeleted () |
Signals | |
| void | modelChanged () |
| Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly). | |
| void | modelChanged (size_t startFrame, size_t endFrame) |
| Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly). | |
| void | completionChanged () |
| Emitted when some internal processing has advanced a stage, but the model has not changed externally. | |
| void | alignmentCompletionChanged () |
| Emitted when the completion percentage changes for the calculation of this model's alignment model. | |
| void | aboutToBeDeleted () |
| Emitted when something notifies this model (through calling aboutToDelete() that it is about to delete it. | |
Public Member Functions | |
| ImageModel (size_t sampleRate, size_t resolution, bool notifyOnAdd=true) | |
| QString | getTypeName () const |
| Return the type of the model. | |
| virtual void | toXml (QTextStream &out, QString indent="", QString extraAttributes="") const |
| Stream this exportable object out to XML on a text stream. | |
| virtual bool | isOK () const |
| Return true if the model was constructed successfully. | |
| virtual size_t | getStartFrame () const |
| Return the first audio frame spanned by the model. | |
| virtual size_t | getEndFrame () const |
| Return the last audio frame spanned by the model. | |
| virtual size_t | getSampleRate () const |
| Return the frame rate in frames per second. | |
| virtual Model * | clone () const |
| Return a copy of this model. | |
| virtual size_t | getResolution () const |
| virtual void | setResolution (size_t resolution) |
| virtual bool | isEmpty () const |
| Return whether the model is empty or not. | |
| virtual size_t | getPointCount () const |
| Get the total number of points in the model. | |
| virtual PointList | getPoints (long start, long end) const |
| Get all of the points in this model between the given boundaries (in frames), as well as up to two points before and after the boundaries. | |
| virtual PointList | getPoints (long frame) const |
| Get all points that cover the given frame number, taking the resolution of the model into account. | |
| virtual const PointList & | getPoints () const |
| Get all points. | |
| virtual PointList | getPreviousPoints (long frame) const |
| Return all points that share the nearest frame number prior to the given one at which there are any points. | |
| virtual PointList | getNextPoints (long frame) const |
| Return all points that share the nearest frame number subsequent to the given one at which there are any points. | |
| virtual void | clear () |
| Remove all points. | |
| virtual void | addPoint (const ImagePoint &point) |
| Add a point. | |
| virtual void | deletePoint (const ImagePoint &point) |
| Remove a point. | |
| virtual bool | isReady (int *completion=0) const |
| Return true if the model has finished loading or calculating all its data, for a model that is capable of calculating in a background thread. | |
| virtual void | setCompletion (int completion, bool update=true) |
| virtual int | getCompletion () const |
| virtual bool | hasTextLabels () const |
| virtual QString | toDelimitedDataString (QString delimiter) const |
| virtual size_t | getNativeRate () const |
| Return the frame rate of the underlying material, if the model itself has already been resampled. | |
| virtual QString | getTitle () const |
| Return the "work title" of the model, if known. | |
| virtual QString | getMaker () const |
| Return the "artist" or "maker" of the model, if known. | |
| virtual QString | getLocation () const |
| Return the location of the data in this model (e.g. | |
| virtual const ZoomConstraint * | getZoomConstraint () const |
| If this model imposes a zoom constraint, i.e. | |
| virtual Model * | getSourceModel () const |
| If this model was derived from another, return the model it was derived from. | |
| virtual void | setSourceModel (Model *model) |
| Set the source model for this model. | |
| virtual void | setAlignment (AlignmentModel *alignment) |
| Specify an aligment between this model's timeline and that of a reference model. | |
| virtual const Model * | getAlignmentReference () const |
| Return the reference model for the current alignment timeline, if any. | |
| virtual size_t | alignToReference (size_t frame) const |
| Return the frame number of the reference model that corresponds to the given frame number in this model. | |
| virtual size_t | alignFromReference (size_t referenceFrame) const |
| Return the frame number in this model that corresponds to the given frame number of the reference model. | |
| virtual int | getAlignmentCompletion () const |
| Return the completion percentage for the alignment model: 100 if there is no alignment model or it has been entirely calculated, or less than 100 if it is still being calculated. | |
| virtual QString | toXmlString (QString indent="", QString extraAttributes="") const |
| Convert this exportable object to XML in a string. | |
Static Public Member Functions | |
| static QString | encodeEntities (QString) |
| static QString | encodeColour (QColor) |
| static int | getObjectExportId (const void *) |
Static Public Attributes | |
| static const int | COMPLETION_UNKNOWN |
Protected Attributes | |
| size_t | m_sampleRate |
| size_t | m_resolution |
| bool | m_notifyOnAdd |
| long | m_sinceLastNotifyMin |
| long | m_sinceLastNotifyMax |
| bool | m_hasTextLabels |
| PointList | m_points |
| size_t | m_pointCount |
| QMutex | m_mutex |
| int | m_completion |
| Model * | m_sourceModel |
| AlignmentModel * | m_alignment |
| bool | m_aboutToDelete |
Classes | |
| class | ChangeImageCommand |
| Command to change the image for a point. More... | |
typedef ImagePoint SparseModel< ImagePoint >::Point [inherited] |
Definition at line 60 of file SparseModel.h.
typedef std::multiset<ImagePoint , typename ImagePoint ::OrderComparator> SparseModel< ImagePoint >::PointList [inherited] |
Definition at line 62 of file SparseModel.h.
typedef PointList::iterator SparseModel< ImagePoint >::PointListIterator [inherited] |
Definition at line 63 of file SparseModel.h.
| ImageModel::ImageModel | ( | size_t | sampleRate, | |
| size_t | resolution, | |||
| bool | notifyOnAdd = true | |||
| ) | [inline] |
Definition at line 88 of file ImageModel.h.
| QString ImageModel::getTypeName | ( | ) | const [inline, virtual] |
Return the type of the model.
For display purposes only.
Reimplemented from SparseModel< ImagePoint >.
Definition at line 92 of file ImageModel.h.
| virtual void ImageModel::toXml | ( | QTextStream & | out, | |
| QString | indent = "", |
|||
| QString | extraAttributes = "" | |||
| ) | const [inline, virtual] |
Stream this exportable object out to XML on a text stream.
Reimplemented from SparseModel< ImagePoint >.
Definition at line 94 of file ImageModel.h.
References SparseModel< PointType >::toXml().
| virtual bool SparseModel< ImagePoint >::isOK | ( | ) | const [inline, virtual, inherited] |
Return true if the model was constructed successfully.
Classes that refer to the model should always test this before use.
Implements Model.
Definition at line 43 of file SparseModel.h.
| virtual size_t SparseModel< ImagePoint >::getStartFrame | ( | ) | const [virtual, inherited] |
| virtual size_t SparseModel< ImagePoint >::getEndFrame | ( | ) | const [virtual, inherited] |
| virtual size_t SparseModel< ImagePoint >::getSampleRate | ( | ) | const [inline, virtual, inherited] |
Return the frame rate in frames per second.
Implements Model.
Definition at line 46 of file SparseModel.h.
| virtual Model* SparseModel< ImagePoint >::clone | ( | ) | const [virtual, inherited] |
Return a copy of this model.
If the model is not editable, this may be effectively a shallow copy. If the model is editable, however, this operation must properly copy all of the model's editable data.
In general this operation is not useful for non-editable dense models such as waveforms, because there may be no efficient copy operation implemented -- for such models it is better not to copy at all.
Caller owns the returned value.
Implements Model.
| virtual size_t SparseModel< ImagePoint >::getResolution | ( | ) | const [inline, virtual, inherited] |
Definition at line 55 of file SparseModel.h.
| virtual void SparseModel< ImagePoint >::setResolution | ( | size_t | resolution | ) | [virtual, inherited] |
| virtual bool SparseModel< ImagePoint >::isEmpty | ( | ) | const [virtual, inherited] |
Return whether the model is empty or not.
| virtual size_t SparseModel< ImagePoint >::getPointCount | ( | ) | const [virtual, inherited] |
Get the total number of points in the model.
| virtual PointList SparseModel< ImagePoint >::getPoints | ( | long | start, | |
| long | end | |||
| ) | const [virtual, inherited] |
Get all of the points in this model between the given boundaries (in frames), as well as up to two points before and after the boundaries.
If you need exact boundaries, check the point coordinates in the returned list.
| virtual PointList SparseModel< ImagePoint >::getPoints | ( | long | frame | ) | const [virtual, inherited] |
Get all points that cover the given frame number, taking the resolution of the model into account.
| virtual const PointList& SparseModel< ImagePoint >::getPoints | ( | ) | const [inline, virtual, inherited] |
| virtual PointList SparseModel< ImagePoint >::getPreviousPoints | ( | long | frame | ) | const [virtual, inherited] |
Return all points that share the nearest frame number prior to the given one at which there are any points.
| virtual PointList SparseModel< ImagePoint >::getNextPoints | ( | long | frame | ) | const [virtual, inherited] |
Return all points that share the nearest frame number subsequent to the given one at which there are any points.
| virtual void SparseModel< ImagePoint >::clear | ( | ) | [virtual, inherited] |
Remove all points.
| virtual void SparseModel< ImagePoint >::addPoint | ( | const ImagePoint & | point | ) | [virtual, inherited] |
Add a point.
| virtual void SparseModel< ImagePoint >::deletePoint | ( | const ImagePoint & | point | ) | [virtual, inherited] |
Remove a point.
Points are not necessarily unique, so this function will remove the first point that compares equal to the supplied one using Point::Comparator. Other identical points may remain in the model.
| virtual bool SparseModel< ImagePoint >::isReady | ( | int * | completion = 0 |
) | const [inline, virtual, inherited] |
Return true if the model has finished loading or calculating all its data, for a model that is capable of calculating in a background thread.
The default implementation is appropriate for a thread that does not background any work but carries out all its calculation from the constructor or accessors.
If "completion" is non-NULL, this function should return through it an estimated percentage value showing how far through the background operation it thinks it is (for progress reporting). If it has no way to calculate progress, it may return the special value COMPLETION_UNKNOWN.
Reimplemented from Model.
Definition at line 124 of file SparseModel.h.
| virtual void SparseModel< ImagePoint >::setCompletion | ( | int | completion, | |
| bool | update = true | |||
| ) | [virtual, inherited] |
| virtual int SparseModel< ImagePoint >::getCompletion | ( | ) | const [inline, virtual, inherited] |
Definition at line 131 of file SparseModel.h.
| virtual bool SparseModel< ImagePoint >::hasTextLabels | ( | ) | const [inline, virtual, inherited] |
Definition at line 133 of file SparseModel.h.
| virtual QString SparseModel< ImagePoint >::toDelimitedDataString | ( | QString | delimiter | ) | const [inline, virtual, inherited] |
| virtual size_t Model::getNativeRate | ( | ) | const [inline, virtual, inherited] |
Return the frame rate of the underlying material, if the model itself has already been resampled.
Reimplemented in WaveFileModel.
Definition at line 67 of file Model.h.
References Model::getSampleRate().
Referenced by Pane::drawDurationAndRate().
| QString Model::getTitle | ( | ) | const [virtual, inherited] |
Return the "work title" of the model, if known.
Reimplemented in WaveFileModel.
Definition at line 150 of file Model.cpp.
References Model::getTitle(), and Model::m_sourceModel.
Referenced by Pane::drawWorkTitle(), and Model::getTitle().
| QString Model::getMaker | ( | ) | const [virtual, inherited] |
Return the "artist" or "maker" of the model, if known.
Reimplemented in WaveFileModel.
Definition at line 157 of file Model.cpp.
References Model::getMaker(), and Model::m_sourceModel.
Referenced by ModelDataModel::data(), Pane::drawWorkTitle(), and Model::getMaker().
| QString Model::getLocation | ( | ) | const [virtual, inherited] |
Return the location of the data in this model (e.g.
source URL). This should not normally be returned for editable models that have been edited.
Reimplemented in WaveFileModel.
Definition at line 164 of file Model.cpp.
References Model::getLocation(), and Model::m_sourceModel.
Referenced by ModelDataModel::data(), and Model::getLocation().
| virtual const ZoomConstraint* Model::getZoomConstraint | ( | ) | const [inline, virtual, inherited] |
If this model imposes a zoom constraint, i.e.
some limit to the set of resolutions at which its data can meaningfully be displayed, then return it.
Reimplemented in AggregateWaveModel, AlignmentModel, WaveFileModel, and WritableWaveFileModel.
Definition at line 132 of file Model.h.
Referenced by WaveformLayer::getZoomConstraint(), and Colour3DPlotLayer::getZoomConstraint().
| virtual Model* Model::getSourceModel | ( | ) | const [inline, virtual, inherited] |
If this model was derived from another, return the model it was derived from.
The assumption is that the source model's alignment will also apply to this model, unless some other property (such as a specific alignment model set on this model) indicates otherwise.
Definition at line 143 of file Model.h.
References Model::m_sourceModel.
Referenced by View::checkProgress(), and Pane::paintEvent().
| void Model::setSourceModel | ( | Model * | model | ) | [virtual, inherited] |
Set the source model for this model.
Definition at line 49 of file Model.cpp.
References Model::aboutToBeDeleted(), Model::alignmentCompletionChanged(), Model::m_sourceModel, and Model::sourceModelAboutToBeDeleted().
Referenced by Document::addDerivedModel(), FeatureExtractionModelTransformer::FeatureExtractionModelTransformer(), and FFTModel::FFTModel().
| void Model::setAlignment | ( | AlignmentModel * | alignment | ) | [virtual, inherited] |
Specify an aligment between this model's timeline and that of a reference model.
The alignment model records both the reference and the alignment. This model takes ownership of the alignment model.
Definition at line 89 of file Model.cpp.
References Model::aboutToDelete(), Model::alignmentCompletionChanged(), Model::completionChanged(), and Model::m_alignment.
Referenced by Document::alignModel().
| const Model * Model::getAlignmentReference | ( | ) | const [virtual, inherited] |
Return the reference model for the current alignment timeline, if any.
Definition at line 101 of file Model.cpp.
References Model::getAlignmentReference(), AlignmentModel::getReferenceModel(), Model::m_alignment, and Model::m_sourceModel.
Referenced by Layer::alignFromReference(), Document::alignModel(), Layer::alignToReference(), Pane::drawAlignmentStatus(), View::getAligningModel(), and Model::getAlignmentReference().
| size_t Model::alignToReference | ( | size_t | frame | ) | const [virtual, inherited] |
Return the frame number of the reference model that corresponds to the given frame number in this model.
Definition at line 111 of file Model.cpp.
References Model::getEndFrame(), AlignmentModel::getReferenceModel(), Model::m_alignment, Model::m_sourceModel, and AlignmentModel::toReference().
Referenced by ViewManager::alignPlaybackFrameToReference(), View::alignToReference(), and Layer::alignToReference().
| size_t Model::alignFromReference | ( | size_t | referenceFrame | ) | const [virtual, inherited] |
Return the frame number in this model that corresponds to the given frame number of the reference model.
Definition at line 124 of file Model.cpp.
References AlignmentModel::fromReference(), Model::getEndFrame(), Model::m_alignment, and Model::m_sourceModel.
Referenced by View::alignFromReference(), Layer::alignFromReference(), ViewManager::alignReferenceToPlaybackFrame(), and View::getAlignedPlaybackFrame().
| int Model::getAlignmentCompletion | ( | ) | const [virtual, inherited] |
Return the completion percentage for the alignment model: 100 if there is no alignment model or it has been entirely calculated, or less than 100 if it is still being calculated.
Definition at line 136 of file Model.cpp.
References AlignmentModel::isReady(), Model::m_alignment, and Model::m_sourceModel.
Referenced by View::checkProgress(), and Pane::drawAlignmentStatus().
| void Model::aboutToDelete | ( | ) | [slot, inherited] |
Definition at line 67 of file Model.cpp.
References Model::aboutToBeDeleted(), and Model::m_aboutToDelete.
Referenced by Document::releaseModel(), Model::setAlignment(), Document::setMainModel(), SpectrumLayer::setModel(), SpectrumLayer::setupFFT(), Document::~Document(), Model::~Model(), and SpectrumLayer::~SpectrumLayer().
| void Model::sourceModelAboutToBeDeleted | ( | ) | [slot, inherited] |
Reimplemented in FFTModel.
Definition at line 83 of file Model.cpp.
References Model::m_sourceModel.
Referenced by Model::setSourceModel().
| void Model::modelChanged | ( | ) | [signal, inherited] |
Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly).
Reimplemented in AggregateWaveModel, AlignmentModel, and WaveFileModel.
Referenced by SparseValueModel< TimeValuePoint >::addPoint(), SparseModel< PointType >::addPoint(), SparseModel< PointType >::clear(), SparseValueModel< TimeValuePoint >::deletePoint(), SparseModel< PointType >::deletePoint(), EditableDenseThreeDimensionalModel::setBinName(), EditableDenseThreeDimensionalModel::setBinNames(), EditableDenseThreeDimensionalModel::setColumn(), SparseModel< PointType >::setCompletion(), EditableDenseThreeDimensionalModel::setCompletion(), SparseModel< PointType >::setResolution(), and WritableWaveFileModel::WritableWaveFileModel().
| void Model::modelChanged | ( | size_t | startFrame, | |
| size_t | endFrame | |||
| ) | [signal, inherited] |
Emitted when a model has been edited (or more data retrieved from cache, in the case of a cached model that generates slowly).
Reimplemented in AggregateWaveModel, AlignmentModel, and WaveFileModel.
| void Model::completionChanged | ( | ) | [signal, inherited] |
Emitted when some internal processing has advanced a stage, but the model has not changed externally.
Views should respond by updating any progress meters or other monitoring, but not refreshing the actual view.
Reimplemented in AggregateWaveModel, AlignmentModel, and WaveFileModel.
Referenced by Model::setAlignment(), SparseModel< PointType >::setCompletion(), and EditableDenseThreeDimensionalModel::setCompletion().
| void Model::alignmentCompletionChanged | ( | ) | [signal, inherited] |
Emitted when the completion percentage changes for the calculation of this model's alignment model.
Referenced by Model::setAlignment(), and Model::setSourceModel().
| void Model::aboutToBeDeleted | ( | ) | [signal, inherited] |
Emitted when something notifies this model (through calling aboutToDelete() that it is about to delete it.
Note that this depends on an external agent such as a Document object or owning model telling the model that it is about to delete it; there is nothing in the model to guarantee that this signal will be emitted before the actual deletion.
Referenced by Model::aboutToDelete(), and Model::setSourceModel().
| QString XmlExportable::toXmlString | ( | QString | indent = "", |
|
| QString | extraAttributes = "" | |||
| ) | const [virtual, inherited] |
Convert this exportable object to XML in a string.
The default implementation calls toXml and returns the result as a string. Do not override this unless you really know what you're doing.
Definition at line 25 of file XmlExportable.cpp.
References XmlExportable::toXml().
Referenced by LayerFactory::setLayerDefaultProperties().
| QString XmlExportable::encodeEntities | ( | QString | ) | [static, inherited] |
Definition at line 41 of file XmlExportable.cpp.
Referenced by AudioGenerator::getDefaultPlayPluginConfiguration(), SVFileReader::readPlugin(), Layer::toBriefXml(), WaveFileModel::toXml(), Transform::toXml(), TextPoint::toXml(), PluginXml::toXml(), Model::toXml(), Layer::toXml(), ImagePoint::toXml(), and Document::writeBackwardCompatibleDerivation().
| QString XmlExportable::encodeColour | ( | QColor | ) | [static, inherited] |
| int XmlExportable::getObjectExportId | ( | const void * | ) | [static, inherited] |
Definition at line 71 of file XmlExportable.cpp.
Referenced by FFTDataServer::generateFileBasename(), View::getTextLabelHeight(), Layer::toBriefXml(), SparseModel< PointType >::toXml(), Model::toXml(), Layer::toXml(), EditableDenseThreeDimensionalModel::toXml(), Document::toXml(), and Document::writeBackwardCompatibleDerivation().
size_t SparseModel< ImagePoint >::m_sampleRate [protected, inherited] |
Definition at line 262 of file SparseModel.h.
size_t SparseModel< ImagePoint >::m_resolution [protected, inherited] |
Definition at line 263 of file SparseModel.h.
bool SparseModel< ImagePoint >::m_notifyOnAdd [protected, inherited] |
Definition at line 264 of file SparseModel.h.
long SparseModel< ImagePoint >::m_sinceLastNotifyMin [protected, inherited] |
Definition at line 265 of file SparseModel.h.
long SparseModel< ImagePoint >::m_sinceLastNotifyMax [protected, inherited] |
Definition at line 266 of file SparseModel.h.
bool SparseModel< ImagePoint >::m_hasTextLabels [protected, inherited] |
Definition at line 267 of file SparseModel.h.
PointList SparseModel< ImagePoint >::m_points [protected, inherited] |
Definition at line 269 of file SparseModel.h.
size_t SparseModel< ImagePoint >::m_pointCount [protected, inherited] |
Definition at line 270 of file SparseModel.h.
QMutex SparseModel< ImagePoint >::m_mutex [mutable, protected, inherited] |
Definition at line 271 of file SparseModel.h.
int SparseModel< ImagePoint >::m_completion [protected, inherited] |
Definition at line 272 of file SparseModel.h.
const int Model::COMPLETION_UNKNOWN [static, inherited] |
Model* Model::m_sourceModel [protected, inherited] |
Definition at line 239 of file Model.h.
Referenced by Model::alignFromReference(), Model::alignToReference(), Model::getAlignmentCompletion(), Model::getAlignmentReference(), Model::getLocation(), Model::getMaker(), Model::getSourceModel(), Model::getTitle(), Model::setSourceModel(), Model::sourceModelAboutToBeDeleted(), and FFTModel::sourceModelAboutToBeDeleted().
AlignmentModel* Model::m_alignment [protected, inherited] |
Definition at line 240 of file Model.h.
Referenced by Model::alignFromReference(), Model::alignToReference(), Model::getAlignmentCompletion(), Model::getAlignmentReference(), Model::setAlignment(), and Model::~Model().
bool Model::m_aboutToDelete [protected, inherited] |
1.5.1