PlayParameters Class Reference

#include <PlayParameters.h>

Inherits XmlExportable.

Inheritance diagram for PlayParameters:

Inheritance graph
[legend]
Collaboration diagram for PlayParameters:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 23 of file PlayParameters.h.

Public Slots

virtual void setPlayMuted (bool muted)
virtual void setPlayAudible (bool nonMuted)
virtual void setPlayPan (float pan)
virtual void setPlayGain (float gain)
virtual void setPlayPluginId (QString id)
virtual void setPlayPluginConfiguration (QString configuration)

Signals

void playParametersChanged ()
void playMutedChanged (bool)
void playAudibleChanged (bool)
void playPanChanged (float)
void playGainChanged (float)
void playPluginIdChanged (QString)
void playPluginConfigurationChanged (QString)

Public Member Functions

 PlayParameters ()
virtual bool isPlayMuted () const
virtual float getPlayPan () const
virtual float getPlayGain () const
virtual QString getPlayPluginId () const
virtual QString getPlayPluginConfiguration () const
virtual void copyFrom (const PlayParameters *)
virtual void toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const
 Stream this exportable object out to XML on a text stream.
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 *)

Protected Attributes

bool m_playMuted
float m_playPan
float m_playGain
QString m_playPluginId
QString m_playPluginConfiguration

Private Member Functions

 PlayParameters (const PlayParameters &)
PlayParametersoperator= (const PlayParameters &)


Constructor & Destructor Documentation

PlayParameters::PlayParameters (  )  [inline]

Definition at line 28 of file PlayParameters.h.

PlayParameters::PlayParameters ( const PlayParameters  )  [private]


Member Function Documentation

virtual bool PlayParameters::isPlayMuted (  )  const [inline, virtual]

Definition at line 30 of file PlayParameters.h.

References m_playMuted.

Referenced by copyFrom(), LayerTreeModel::data(), AudioGenerator::mixModel(), and PropertyBox::populateViewPlayFrame().

virtual float PlayParameters::getPlayPan (  )  const [inline, virtual]

Definition at line 31 of file PlayParameters.h.

References m_playPan.

Referenced by copyFrom(), and AudioGenerator::mixModel().

virtual float PlayParameters::getPlayGain (  )  const [inline, virtual]

Definition at line 32 of file PlayParameters.h.

References m_playGain.

Referenced by copyFrom(), and AudioGenerator::mixModel().

virtual QString PlayParameters::getPlayPluginId (  )  const [inline, virtual]

Definition at line 34 of file PlayParameters.h.

References m_playPluginId.

Referenced by copyFrom(), PropertyBox::editPlugin(), AudioGenerator::loadPluginFor(), and PropertyBox::populateViewPlayFrame().

virtual QString PlayParameters::getPlayPluginConfiguration (  )  const [inline, virtual]

Definition at line 35 of file PlayParameters.h.

References m_playPluginConfiguration.

Referenced by copyFrom(), PropertyBox::editPlugin(), and AudioGenerator::loadPluginFor().

void PlayParameters::copyFrom ( const PlayParameters  )  [virtual]

Definition at line 23 of file PlayParameters.cpp.

References getPlayGain(), getPlayPan(), getPlayPluginConfiguration(), getPlayPluginId(), isPlayMuted(), m_playGain, m_playMuted, m_playPan, m_playPluginConfiguration, and m_playPluginId.

Referenced by PlayParameterRepository::copyParameters().

void PlayParameters::toXml ( QTextStream &  stream,
QString  indent = "",
QString  extraAttributes = "" 
) const [virtual]

Stream this exportable object out to XML on a text stream.

Implements XmlExportable.

Definition at line 33 of file PlayParameters.cpp.

References m_playGain, m_playMuted, m_playPan, m_playPluginConfiguration, and m_playPluginId.

Referenced by Document::toXml().

void PlayParameters::setPlayMuted ( bool  muted  )  [virtual, slot]

Definition at line 53 of file PlayParameters.cpp.

References m_playMuted, playAudibleChanged(), playMutedChanged(), and playParametersChanged().

Referenced by SVFileReader::readPlayParameters(), LayerTreeModel::setData(), and setPlayAudible().

void PlayParameters::setPlayAudible ( bool  nonMuted  )  [virtual, slot]

Definition at line 63 of file PlayParameters.cpp.

References setPlayMuted().

void PlayParameters::setPlayPan ( float  pan  )  [virtual, slot]

Definition at line 70 of file PlayParameters.cpp.

References m_playPan, playPanChanged(), and playParametersChanged().

Referenced by SVFileReader::readPlayParameters().

void PlayParameters::setPlayGain ( float  gain  )  [virtual, slot]

Definition at line 80 of file PlayParameters.cpp.

References m_playGain, playGainChanged(), and playParametersChanged().

Referenced by SVFileReader::readPlayParameters().

void PlayParameters::setPlayPluginId ( QString  id  )  [virtual, slot]

Definition at line 90 of file PlayParameters.cpp.

References m_playPluginId, playParametersChanged(), and playPluginIdChanged().

Referenced by PlayParameterRepository::addModel(), AudioGenerator::loadPluginFor(), and SVFileReader::readPlayParameters().

void PlayParameters::setPlayPluginConfiguration ( QString  configuration  )  [virtual, slot]

Definition at line 100 of file PlayParameters.cpp.

References m_playPluginConfiguration, playParametersChanged(), and playPluginConfigurationChanged().

Referenced by PlayParameterRepository::addModel(), PropertyBox::editPlugin(), AudioGenerator::loadPluginFor(), PropertyBox::pluginConfigurationChanged(), and SVFileReader::readPlugin().

void PlayParameters::playParametersChanged (  )  [signal]

Referenced by setPlayGain(), setPlayMuted(), setPlayPan(), setPlayPluginConfiguration(), and setPlayPluginId().

void PlayParameters::playMutedChanged ( bool   )  [signal]

Referenced by setPlayMuted().

void PlayParameters::playAudibleChanged ( bool   )  [signal]

Referenced by setPlayMuted().

void PlayParameters::playPanChanged ( float   )  [signal]

Referenced by setPlayPan().

void PlayParameters::playGainChanged ( float   )  [signal]

Referenced by setPlayGain().

void PlayParameters::playPluginIdChanged ( QString   )  [signal]

Referenced by setPlayPluginId().

void PlayParameters::playPluginConfigurationChanged ( QString   )  [signal]

Referenced by setPlayPluginConfiguration().

PlayParameters& PlayParameters::operator= ( const PlayParameters  )  [private]

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]

Definition at line 54 of file XmlExportable.cpp.

Referenced by ColourDatabase::getStringValues().

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().


Member Data Documentation

bool PlayParameters::m_playMuted [protected]

Definition at line 61 of file PlayParameters.h.

Referenced by copyFrom(), isPlayMuted(), setPlayMuted(), and toXml().

float PlayParameters::m_playPan [protected]

Definition at line 62 of file PlayParameters.h.

Referenced by copyFrom(), getPlayPan(), setPlayPan(), and toXml().

float PlayParameters::m_playGain [protected]

Definition at line 63 of file PlayParameters.h.

Referenced by copyFrom(), getPlayGain(), setPlayGain(), and toXml().

QString PlayParameters::m_playPluginId [protected]

Definition at line 64 of file PlayParameters.h.

Referenced by copyFrom(), getPlayPluginId(), setPlayPluginId(), and toXml().

QString PlayParameters::m_playPluginConfiguration [protected]

Definition at line 65 of file PlayParameters.h.

Referenced by copyFrom(), getPlayPluginConfiguration(), setPlayPluginConfiguration(), and toXml().


The documentation for this class was generated from the following files:
Generated on Wed Feb 20 15:45:35 2008 for SonicVisualiser by  doxygen 1.5.1