WaveTrackFactory Class Reference

Used to create or clone a WaveTrack, with appropriate context from the project that will own the track. More...

#include <WaveTrack.h>

Inheritance diagram for WaveTrackFactory:

Collaboration diagram for WaveTrackFactory:

Public Member Functions
	WaveTrackFactory (const ProjectRate &rate, const SampleBlockFactoryPtr &pFactory)
	WaveTrackFactory (const WaveTrackFactory &) PROHIBITED
WaveTrackFactory &	operator= (const WaveTrackFactory &) PROHIBITED
const SampleBlockFactoryPtr &	GetSampleBlockFactory () const
std::shared_ptr< WaveTrack >	Create ()
	Creates an unnamed empty WaveTrack with default sample format and default rate. More...
std::shared_ptr< WaveTrack >	Create (sampleFormat format, double rate)
	Creates an unnamed empty WaveTrack with custom sample format and custom rate. More...
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static WaveTrackFactory &	Get (AudacityProject &project)
static const WaveTrackFactory &	Get (const AudacityProject &project)
static WaveTrackFactory &	Reset (AudacityProject &project)
static void	Destroy (AudacityProject &project)

Private Attributes
const ProjectRate &	mRate
SampleBlockFactoryPtr	mpFactory

Detailed Description

Used to create or clone a WaveTrack, with appropriate context from the project that will own the track.

Definition at line 563 of file WaveTrack.h.

Constructor & Destructor Documentation

WaveTrackFactory() [1/2]

WaveTrackFactory::WaveTrackFactory ( const ProjectRate &  rate, const SampleBlockFactoryPtr &  pFactory  )

inline

Definition at line 572 of file WaveTrack.h.

       : mRate{ rate }
       , mpFactory(pFactory)
   {
   }

WaveTrackFactory() [2/2]

WaveTrackFactory::WaveTrackFactory

(

const WaveTrackFactory &

)

Member Function Documentation

Create() [1/2]

std::shared_ptr< WaveTrack > WaveTrackFactory::Create

(

)

Creates an unnamed empty WaveTrack with default sample format and default rate.

Returns

Orphaned WaveTrack

Definition at line 116 of file WaveTrack.cpp.

{
   return Create(QualitySettings::SampleFormatChoice(), mRate.GetRate());
}

References Create(), ProjectRate::GetRate(), mRate, and QualitySettings::SampleFormatChoice().

Referenced by Create(), EffectBase::DoEffect(), ProjectAudioManager::DoRecord(), ImportRaw(), MixAndRender(), and ImportFileHandle::NewWaveTrack().

Here is the call graph for this function:

Here is the caller graph for this function:

Create() [2/2]

std::shared_ptr< WaveTrack > WaveTrackFactory::Create	(	sampleFormat	format,
		double	rate
	)

Creates an unnamed empty WaveTrack with custom sample format and custom rate.

Parameters

format	Desired sample format
rate	Desired sample rate

Returns

Orphaned WaveTrack

Definition at line 121 of file WaveTrack.cpp.

{
   return std::make_shared<WaveTrack>(mpFactory, format, rate);
}

References format, and mpFactory.

Destroy()

void WaveTrackFactory::Destroy ( AudacityProject &  project )

static

Definition at line 2553 of file WaveTrack.cpp.

{
   project.AttachedObjects::Assign( key2, nullptr );
}

References key2.

Referenced by ProjectManager::OnCloseWindow().

Here is the caller graph for this function:

Get() [1/2]

WaveTrackFactory & WaveTrackFactory::Get ( AudacityProject &  project )

static

Definition at line 2536 of file WaveTrack.cpp.

{
   return project.AttachedObjects::Get< WaveTrackFactory >( key2 );
}

References key2.

Referenced by EffectUI::DoEffect(), anonymous_namespace{FileMenus.cpp}::DoImport(), anonymous_namespace{TrackMenus.cpp}::DoMixAndRender(), ProjectAudioManager::DoRecord(), AUPImportFileHandle::HandleWaveTrack(), ProjectFileManager::Import(), ProjectFileIO::LoadProject(), WaveTrack::New(), anonymous_namespace{FileMenus.cpp}::OnImportLabels(), anonymous_namespace{WaveTrackMenuItems.cpp}::OnNewStereoTrack(), anonymous_namespace{WaveTrackMenuItems.cpp}::OnNewWaveTrack(), anonymous_namespace{EditMenus.cpp}::OnPaste(), and WaveTrack::PasteInto().

Here is the caller graph for this function:

Get() [2/2]

const WaveTrackFactory & WaveTrackFactory::Get ( const AudacityProject &  project )

static

Definition at line 2541 of file WaveTrack.cpp.

{
   return Get( const_cast< AudacityProject & >( project ) );
}

References WaveTrack::Get().

Here is the call graph for this function:

GetSampleBlockFactory()

const SampleBlockFactoryPtr & WaveTrackFactory::GetSampleBlockFactory ( ) const

inline

Definition at line 582 of file WaveTrack.h.

   { return mpFactory; }

Referenced by ProjectFileIO::LoadProject(), and MixAndRender().

Here is the caller graph for this function:

operator=()

WaveTrackFactory & WaveTrackFactory::operator=

(

const WaveTrackFactory &

)

Reset()

WaveTrackFactory & WaveTrackFactory::Reset ( AudacityProject &  project )

static

Definition at line 2546 of file WaveTrack.cpp.

{
   auto result = TrackFactoryFactory( project );
   project.AttachedObjects::Assign( key2, result );
   return *result;
}

References key2, and TrackFactoryFactory.

Referenced by ProjectManager::ResetProjectToEmpty().

Here is the caller graph for this function:

Member Data Documentation

mpFactory

SampleBlockFactoryPtr WaveTrackFactory::mpFactory

private

Definition at line 601 of file WaveTrack.h.

Referenced by Create().

mRate

const ProjectRate& WaveTrackFactory::mRate

private

Definition at line 600 of file WaveTrack.h.

Referenced by Create().

---

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

• WaveTrack.h
• WaveTrack.cpp