ZoomInfo Class Reference

#include <ZoomInfo.h>

Inheritance diagram for ZoomInfo:

Collaboration diagram for ZoomInfo:

Classes
struct	Interval

Public Types
enum	FisheyeState { HIDDEN , PINNED , NUM_STATES }
typedef std::vector< Interval >	Intervals

Public Member Functions
	ZoomInfo (double start, double pixelsPerSecond)
	~ZoomInfo ()
	ZoomInfo (const ZoomInfo &) PROHIBITED
ZoomInfo &	operator= (const ZoomInfo &) PROHIBITED
void	UpdatePrefs () override
double	PositionToTime (wxInt64 position, wxInt64 origin=0, bool ignoreFisheye=false) const
wxInt64	TimeToPosition (double time, wxInt64 origin=0, bool ignoreFisheye=false) const
	STM: Converts a project time to screen x position. More...
double	TimeRangeToPixelWidth (double timeRange) const
double	OffsetTimeByPixels (double time, wxInt64 offset, bool ignoreFisheye=false) const
int	GetWidth () const
void	SetWidth (int width)
int	GetVRulerWidth () const
void	SetVRulerWidth (int width)
int	GetVRulerOffset () const
int	GetLeftOffset () const
int	GetTracksUsableWidth () const
double	GetScreenEndTime () const
bool	ZoomInAvailable () const
bool	ZoomOutAvailable () const
void	SetZoom (double pixelsPerSecond)
double	GetZoom () const
void	ZoomBy (double multiplier)
void	FindIntervals (double rate, Intervals &results, wxInt64 width, wxInt64 origin=0) const
FisheyeState	GetFisheyeState () const
bool	InFisheye (wxInt64, wxInt64 WXUNUSED(origin=0)) const
wxInt64	GetFisheyeLeftBoundary (wxInt64 WXUNUSED(origin=0)) const
wxInt64	GetFisheyeRightBoundary (wxInt64 WXUNUSED(origin=0)) const
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static double	GetDefaultZoom ()
static double	GetMaxZoom ()
static double	GetMinZoom ()

Public Attributes
int	vpos
double	h
float	dBr
int	mWidth { 0 }
int	mVRulerWidth { 36 }

Protected Attributes
double	zoom

Additional Inherited Members
Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdatePrefs ()=0
Static Protected Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Detailed Description

Definition at line 42 of file ZoomInfo.h.

Member Typedef Documentation

Intervals

typedef std::vector<Interval> ZoomInfo::Intervals

Definition at line 146 of file ZoomInfo.h.

Member Enumeration Documentation

FisheyeState

enum ZoomInfo::FisheyeState

Enumerator
HIDDEN
PINNED
NUM_STATES

Definition at line 158 of file ZoomInfo.h.

                     {
      HIDDEN,
      PINNED,
 
      NUM_STATES,
   };

Constructor & Destructor Documentation

ZoomInfo() [1/2]

ZoomInfo::ZoomInfo	(	double	start,
		double	pixelsPerSecond
	)

Definition at line 21 of file ZoomInfo.cpp.

   : vpos(0)
   , h(start)
   , zoom(pixelsPerSecond)
{
   UpdatePrefs();
}

References UpdatePrefs().

Here is the call graph for this function:

~ZoomInfo()

ZoomInfo::~ZoomInfo

(

)

Definition at line 29 of file ZoomInfo.cpp.

{
}

ZoomInfo() [2/2]

ZoomInfo::ZoomInfo

(

const ZoomInfo &

)

Member Function Documentation

FindIntervals()

void ZoomInfo::FindIntervals	(	double	rate,
		Intervals &	results,
		wxInt64	width,
		wxInt64	origin = 0
	)		const

Definition at line 109 of file ZoomInfo.cpp.

{
   results.clear();
   results.reserve(2);
 
   const wxInt64 rightmost(origin + (0.5 + width));
   wxASSERT(origin <= rightmost);
   {
      results.push_back(Interval(origin, zoom, false));
   }
 
   if (origin < rightmost)
      results.push_back(Interval(rightmost, 0, false));
   wxASSERT(!results.empty() && results[0].position == origin);
}

References zoom.

Referenced by anonymous_namespace{WaveformView.cpp}::FindWavePortions(), and anonymous_namespace{SampleHandle.cpp}::SampleResolutionTest().

Here is the caller graph for this function:

GetDefaultZoom()

static double ZoomInfo::GetDefaultZoom ( )

inlinestatic

Definition at line 123 of file ZoomInfo.h.

   { return 44100.0 / 512.0; }

Referenced by anonymous_namespace{ViewMenus.cpp}::GetZoomOfPreset(), ViewActions::Handler::OnZoomNormal(), ZoomHandle::Release(), and TrackPanel::UpdateViewIfNoTracks().

Here is the caller graph for this function:

GetFisheyeLeftBoundary()

wxInt64 ZoomInfo::GetFisheyeLeftBoundary ( wxInt64   WXUNUSEDorigin=0 ) const

inline

Definition at line 174 of file ZoomInfo.h.

   {return 0;} // stub

GetFisheyeRightBoundary()

wxInt64 ZoomInfo::GetFisheyeRightBoundary ( wxInt64   WXUNUSEDorigin=0 ) const

inline

Definition at line 177 of file ZoomInfo.h.

   {return 0;} // stub

GetFisheyeState()

FisheyeState ZoomInfo::GetFisheyeState ( ) const

inline

Definition at line 164 of file ZoomInfo.h.

   { return HIDDEN; } // stub

GetLeftOffset()

int ZoomInfo::GetLeftOffset ( ) const

inline

Definition at line 103 of file ZoomInfo.h.

      { return GetVRulerOffset() + GetVRulerWidth() + 1; }

Referenced by LabelTrackView::DialogForLabelName(), TrackPanel::GetMostRecentXPos(), and TrackPanel::UpdateVRulerSize().

Here is the caller graph for this function:

GetMaxZoom()

double ZoomInfo::GetMaxZoom ( )

static

Definition at line 83 of file ZoomInfo.cpp.

{ return gMaxZoom;};

References anonymous_namespace{ZoomInfo.cpp}::gMaxZoom.

Referenced by anonymous_namespace{ViewMenus.cpp}::GetZoomOfPreset().

Here is the caller graph for this function:

GetMinZoom()

double ZoomInfo::GetMinZoom ( )

static

Definition at line 84 of file ZoomInfo.cpp.

{ return gMinZoom;};

References anonymous_namespace{ZoomInfo.cpp}::gMinZoom.

GetScreenEndTime()

double ZoomInfo::GetScreenEndTime ( ) const

inline

Definition at line 114 of file ZoomInfo.h.

   {
      auto width = GetTracksUsableWidth();
      return PositionToTime(width, 0, true);
   }

Referenced by TrackPanel::HandlePageDownKey(), and TrackPanel::HandlePageUpKey().

Here is the caller graph for this function:

GetTracksUsableWidth()

int ZoomInfo::GetTracksUsableWidth ( ) const

inline

Definition at line 106 of file ZoomInfo.h.

   {
      return
         std::max( 0, GetWidth() - ( GetLeftOffset() + kRightMargin ) );
   }

References kRightMargin.

GetVRulerOffset()

int ZoomInfo::GetVRulerOffset ( ) const

inline

Definition at line 100 of file ZoomInfo.h.

{ return kTrackInfoWidth + kLeftMargin; }

References kLeftMargin, and kTrackInfoWidth.

Referenced by TrackPanel::UpdateTrackVRuler().

Here is the caller graph for this function:

GetVRulerWidth()

int ZoomInfo::GetVRulerWidth ( ) const

inline

Definition at line 98 of file ZoomInfo.h.

{ return mVRulerWidth; }

Referenced by TrackPanel::UpdateTrackVRuler(), and TrackPanel::UpdateVRulerSize().

Here is the caller graph for this function:

GetWidth()

int ZoomInfo::GetWidth ( ) const

inline

Definition at line 95 of file ZoomInfo.h.

{ return mWidth; }

GetZoom()

double ZoomInfo::GetZoom

(

)

const

Definition at line 82 of file ZoomInfo.cpp.

{ return zoom;};

References zoom.

InFisheye()

bool ZoomInfo::InFisheye ( wxInt64  , wxInt64   WXUNUSEDorigin=0  ) const

inline

Definition at line 169 of file ZoomInfo.h.

   {return false;} // stub

OffsetTimeByPixels()

double ZoomInfo::OffsetTimeByPixels ( double  time, wxInt64  offset, bool  ignoreFisheye = false  ) const

inline

Definition at line 90 of file ZoomInfo.h.

   {
      return PositionToTime(offset + TimeToPosition(time, ignoreFisheye), ignoreFisheye);
   }

operator=()

ZoomInfo & ZoomInfo::operator=

(

const ZoomInfo &

)

PositionToTime()

double ZoomInfo::PositionToTime	(	wxInt64	position,
		wxInt64	origin = 0,
		bool	ignoreFisheye = false
	)		const

Converts a position (mouse X coordinate) to project time, in seconds. Needs the left edge of the track as an additional parameter.

Definition at line 41 of file ZoomInfo.cpp.

{
   return h + (position - origin) / zoom;
}

References h, and zoom.

Referenced by SelectHandle::AdjustSelection(), anonymous_namespace{WaveTrackView.cpp}::CalculateAdjustmentForZoomLevel(), anonymous_namespace{SelectHandle.cpp}::ChooseBoundary(), ClipParameters::ClipParameters(), CommonTrackPanelCell::DoContextMenu(), TimeShiftHandle::DoSlideVertical(), anonymous_namespace{TimeShiftHandle.cpp}::FindDesiredSlideAmount(), SampleHandle::FindSampleEditingLevel(), CommonTrackView::GetEnvelopeValues(), TrackPanel::GetMostRecentXPos(), LabelGlyphHandle::HandleGlyphDragRelease(), EnvelopeEditor::HandleMouseButtonDown(), anonymous_namespace{SampleHandle.cpp}::IsSampleEditingPossible(), EnvelopeEditor::MoveDragPoint(), AdornedRulerPanel::Pos2Time(), anonymous_namespace{BrushHandle.cpp}::PositionToLongSample(), and SelectHandle::SelectHandle().

Here is the caller graph for this function:

SetVRulerWidth()

void ZoomInfo::SetVRulerWidth ( int  width )

inline

Definition at line 99 of file ZoomInfo.h.

{ mVRulerWidth = width; }

Referenced by TrackPanel::UpdateVRulerSize().

Here is the caller graph for this function:

SetWidth()

void ZoomInfo::SetWidth ( int  width )

inline

Definition at line 96 of file ZoomInfo.h.

{ mWidth = width; }

Referenced by TrackPanel::OnSize().

Here is the caller graph for this function:

SetZoom()

void ZoomInfo::SetZoom

(

double

pixelsPerSecond

)

Definition at line 86 of file ZoomInfo.cpp.

{
   zoom = std::max(gMinZoom, std::min(gMaxZoom, pixelsPerSecond));
// DA: Avoids stuck in snap-to
#ifdef EXPERIMENTAL_DA
   // Disable snapping if user zooms in a long way.
   // Helps stop users be trapped in snap-to.
   // The level chosen is in sample viewing range with samples
   // still quite close together.
   if( zoom > (gMaxZoom * 0.06  ))
   {
      AudacityProject * project = GetActiveProject();
      if( project )
         project->OnSnapToOff();
   }
#endif
}

References GetActiveProject(), anonymous_namespace{ZoomInfo.cpp}::gMaxZoom, anonymous_namespace{ZoomInfo.cpp}::gMinZoom, min(), and zoom.

Referenced by TrackPanel::UpdateViewIfNoTracks(), and ZoomBy().

Here is the call graph for this function:

Here is the caller graph for this function:

TimeRangeToPixelWidth()

double ZoomInfo::TimeRangeToPixelWidth

(

double

timeRange

)

const

Definition at line 67 of file ZoomInfo.cpp.

{
   return timeRange * zoom;
}

References zoom.

TimeToPosition()

wxInt64 ZoomInfo::TimeToPosition	(	double	time,
		wxInt64	origin = 0,
		bool	ignoreFisheye = false
	)		const

STM: Converts a project time to screen x position.

Definition at line 51 of file ZoomInfo.cpp.

{
   double t = 0.5 + zoom * (projectTime - h) + origin ;
   if( t < wxINT64_MIN )
      return wxINT64_MIN;
   if( t > wxINT64_MAX )
      return wxINT64_MAX;
   t = floor( t );
   return t;
}

References h, and zoom.

Referenced by anonymous_namespace{SelectHandle.cpp}::ChooseTimeBoundary(), ClipParameters::ClipParameters(), LabelTrackView::ComputeLayout(), LabelTrackView::DialogForLabelName(), anonymous_namespace{TimeShiftHandle.cpp}::FindDesiredSlideAmount(), ClipParameters::GetClipRect(), LabelGlyphHandle::HandleGlyphClick(), EnvelopeEditor::HandleMouseButtonDown(), anonymous_namespace{CutlineHandle.cpp}::IsOverCutline(), SnapManager::PixelDiff(), anonymous_namespace{SampleHandle.cpp}::SampleResolutionTest(), SnapManager::Snap(), and AdornedRulerPanel::Time2Pos().

Here is the caller graph for this function:

UpdatePrefs()

void ZoomInfo::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 33 of file ZoomInfo.cpp.

{
   dBr = DecibelScaleCutoff.Read();
}

References dBr, DecibelScaleCutoff, and Setting< T >::Read().

Referenced by ViewInfo::UpdatePrefs(), and ZoomInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

ZoomBy()

void ZoomInfo::ZoomBy

(

double

multiplier

)

Definition at line 104 of file ZoomInfo.cpp.

{
   SetZoom(zoom * multiplier);
}

References SetZoom(), and zoom.

Here is the call graph for this function:

ZoomInAvailable()

bool ZoomInfo::ZoomInAvailable

(

)

const

Definition at line 72 of file ZoomInfo.cpp.

{
   return zoom < gMaxZoom;
}

References anonymous_namespace{ZoomInfo.cpp}::gMaxZoom, and zoom.

Referenced by ZoomInAvailableFlag().

Here is the caller graph for this function:

ZoomOutAvailable()

bool ZoomInfo::ZoomOutAvailable

(

)

const

Definition at line 77 of file ZoomInfo.cpp.

{
   return zoom > gMinZoom;
}

References anonymous_namespace{ZoomInfo.cpp}::gMinZoom, and zoom.

Referenced by ZoomOutAvailableFlag().

Here is the caller graph for this function:

Member Data Documentation

dBr

float ZoomInfo::dBr

Definition at line 66 of file ZoomInfo.h.

Referenced by UpdatePrefs().

h

double ZoomInfo::h

Definition at line 60 of file ZoomInfo.h.

Referenced by anonymous_namespace{Scrubbing.cpp}::FindScrubbingSpeed(), anonymous_namespace{Scrubbing.cpp}::FindSeekSpeed(), TrackPanel::HandlePageUpKey(), PositionToTime(), ViewInfo::SetBeforeScreenWidth(), TimeToPosition(), and TrackPanel::UpdateViewIfNoTracks().

mVRulerWidth

int ZoomInfo::mVRulerWidth { 36 }

Definition at line 181 of file ZoomInfo.h.

mWidth

int ZoomInfo::mWidth { 0 }

Definition at line 180 of file ZoomInfo.h.

vpos

int ZoomInfo::vpos

Definition at line 58 of file ZoomInfo.h.

Referenced by TrackPanel::OnEnsureVisible(), TrackPanel::RefreshTrack(), and TrackPanel::VerticalScroll().

zoom

double ZoomInfo::zoom

protected

Definition at line 63 of file ZoomInfo.h.

Referenced by FindIntervals(), GetZoom(), PositionToTime(), ViewInfo::SetBeforeScreenWidth(), SetZoom(), TimeRangeToPixelWidth(), TimeToPosition(), ZoomBy(), ZoomInAvailable(), and ZoomOutAvailable().

---

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

• ZoomInfo.h
• ZoomInfo.cpp