WaveformAppearance Class Reference

Persistent appearance settings that apply to all channels of a track. More...

#include <WaveformAppearance.h>

Inheritance diagram for WaveformAppearance:

Collaboration diagram for WaveformAppearance:

Public Member Functions
	WaveformAppearance (WaveTrack &track)
	~WaveformAppearance () override
void	CopyTo (Track &track) const override
	Copy state, for undo/redo purposes. More...
void	Reparent (const std::shared_ptr< Track > &parent) override
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...
void	WriteXMLAttributes (XMLWriter &writer) const override
	Serialize persistent attributes. More...
bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView) override
	Deserialize an attribute, returning true if recognized. More...
int	GetColorIndex () const
void	SetColorIndex (int colorIndex)
Public Member Functions inherited from TrackAttachment
virtual	~TrackAttachment ()
virtual void	CopyTo (Track &track) const
	Copy state, for undo/redo purposes. More...
virtual void	Reparent (const std::shared_ptr< Track > &parent)
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...
virtual void	WriteXMLAttributes (XMLWriter &) const
	Serialize persistent attributes. More...
virtual bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView)
	Deserialize an attribute, returning true if recognized. More...
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static WaveformAppearance &	Get (WaveTrack &track)
static const WaveformAppearance &	Get (const WaveTrack &track)
static WaveformAppearance &	Get (WaveChannel &channel)
static const WaveformAppearance &	Get (const WaveChannel &channel)

Private Member Functions
void	Subscribe (const std::shared_ptr< WaveTrack > &pTrack)

Private Attributes
std::weak_ptr< WaveTrack >	mwTrack
Observer::Subscription	mSubscription
int	mColorIndex { 0 }

Detailed Description

Persistent appearance settings that apply to all channels of a track.

Definition at line 18 of file WaveformAppearance.h.

Constructor & Destructor Documentation

WaveformAppearance()

WaveformAppearance::WaveformAppearance ( WaveTrack &  track )

explicit

Definition at line 45 of file WaveformAppearance.cpp.

   : mwTrack{
      std::static_pointer_cast<WaveTrack>(track.shared_from_this()) }
{
   Subscribe(mwTrack.lock());
}

References mwTrack, and Subscribe().

Here is the call graph for this function:

~WaveformAppearance()

WaveformAppearance::~WaveformAppearance ( )

overridedefault

Member Function Documentation

CopyTo()

void WaveformAppearance::CopyTo ( Track &  track ) const

overridevirtual

Copy state, for undo/redo purposes.

Reimplemented from TrackAttachment.

Definition at line 71 of file WaveformAppearance.cpp.

{
   if (const auto pTrack = dynamic_cast<WaveTrack *>(&track)) {
      auto &other = Get(*pTrack);
      other.mColorIndex = mColorIndex;
   }
}

References Get(), and mColorIndex.

Here is the call graph for this function:

Get() [1/4]

const WaveformAppearance & WaveformAppearance::Get ( const WaveChannel &  channel )

static

Definition at line 40 of file WaveformAppearance.cpp.

{
   return Get(const_cast<WaveChannel &>(channel));
}

References Get().

Here is the call graph for this function:

Get() [2/4]

const WaveformAppearance & WaveformAppearance::Get ( const WaveTrack &  track )

static

Definition at line 30 of file WaveformAppearance.cpp.

{
   return Get(const_cast<WaveTrack&>(track));
}

References Get().

Here is the call graph for this function:

Get() [3/4]

WaveformAppearance & WaveformAppearance::Get ( WaveChannel &  channel )

static

Definition at line 35 of file WaveformAppearance.cpp.

{
   return Get(channel.GetTrack());
}

References Get(), and WaveChannel::GetTrack().

Here is the call graph for this function:

Get() [4/4]

WaveformAppearance & WaveformAppearance::Get ( WaveTrack &  track )

static

Definition at line 25 of file WaveformAppearance.cpp.

{
   return track.AttachedObjects::Get<WaveformAppearance>(keyWA);
}

References keyWA.

Referenced by SetTrackVisualsCommand::ApplyInner(), CopyTo(), Get(), and WaveColorMenuTable::OnWaveColorChange().

Here is the caller graph for this function:

GetColorIndex()

int WaveformAppearance::GetColorIndex ( ) const

inline

Definition at line 37 of file WaveformAppearance.h.

{ return mColorIndex; }

References mColorIndex.

HandleXMLAttribute()

bool WaveformAppearance::HandleXMLAttribute ( const std::string_view &  attr, const XMLAttributeValueView &  valueView  )

overridevirtual

Deserialize an attribute, returning true if recognized.

default recognizes no attributes, and returns false

Reimplemented from TrackAttachment.

Definition at line 92 of file WaveformAppearance.cpp.

{
   long nValue;
   if (attr == ColorIndex_attr && valueView.TryGet(nValue))
      mColorIndex = nValue;
   return false;
}

References ColorIndex_attr, mColorIndex, and XMLAttributeValueView::TryGet().

Here is the call graph for this function:

Reparent()

void WaveformAppearance::Reparent ( const std::shared_ptr< Track > &  parent )

overridevirtual

Object may be shared among tracks but hold a special back-pointer to one of them; reassign it.

default does nothing

Reimplemented from TrackAttachment.

Definition at line 79 of file WaveformAppearance.cpp.

{
   mwTrack = std::dynamic_pointer_cast<WaveTrack>(parent);
   Subscribe(mwTrack.lock());
}

References mwTrack, and Subscribe().

Here is the call graph for this function:

SetColorIndex()

void WaveformAppearance::SetColorIndex

(

int

colorIndex

)

Definition at line 101 of file WaveformAppearance.cpp.

{
   mColorIndex = colorIndex;
   const auto pTrack = mwTrack.lock();
   if (!pTrack)
      return;
   for (const auto &pInterval : pTrack->Intervals())
      for (const auto &pChannel : pInterval->Channels())
         WaveColorAttachment::Get(*pChannel)
            .SetColorIndex(colorIndex);
}

References WaveColorAttachment::Get(), mColorIndex, mwTrack, and WaveColorAttachment::SetColorIndex().

Referenced by SetTrackVisualsCommand::ApplyInner(), and WaveColorMenuTable::OnWaveColorChange().

Here is the call graph for this function:

Here is the caller graph for this function:

Subscribe()

void WaveformAppearance::Subscribe ( const std::shared_ptr< WaveTrack > &  pTrack )

private

Definition at line 54 of file WaveformAppearance.cpp.

{
   if (pTrack)
      mSubscription =
      pTrack->Subscribe([this](const WaveTrackMessage &message){
         switch (message.type) {
         case WaveTrackMessage::New:
         case WaveTrackMessage::Deserialized:
            WaveColorAttachment::Get(*message.pClip).SetColorIndex(mColorIndex);
         default:
            break;
         }
      });
   else
      mSubscription.Reset();
}

References mSubscription, Observer::Subscription::Reset(), and WaveTrackMessage::type.

Referenced by Reparent(), and WaveformAppearance().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteXMLAttributes()

void WaveformAppearance::WriteXMLAttributes ( XMLWriter &  ) const

overridevirtual

Serialize persistent attributes.

default does nothing

Reimplemented from TrackAttachment.

Definition at line 87 of file WaveformAppearance.cpp.

{
   writer.WriteAttr(ColorIndex_attr, mColorIndex);
}

References ColorIndex_attr, mColorIndex, and XMLWriter::WriteAttr().

Here is the call graph for this function:

Member Data Documentation

mColorIndex

int WaveformAppearance::mColorIndex { 0 }

private

Definition at line 45 of file WaveformAppearance.h.

Referenced by CopyTo(), GetColorIndex(), HandleXMLAttribute(), SetColorIndex(), and WriteXMLAttributes().

mSubscription

Observer::Subscription WaveformAppearance::mSubscription

private

Definition at line 44 of file WaveformAppearance.h.

Referenced by Subscribe().

mwTrack

std::weak_ptr<WaveTrack> WaveformAppearance::mwTrack

private

Definition at line 43 of file WaveformAppearance.h.

Referenced by Reparent(), SetColorIndex(), and WaveformAppearance().

---

The documentation for this class was generated from the following files:

• WaveformAppearance.h
• WaveformAppearance.cpp