ZoomInfo Class Reference

#include <ZoomInfo.h>

Inheritance diagram for ZoomInfo:

Classes
struct	Interval

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

Public Member Functions
	ZoomInfo (double start, double pixelsPerSecond)
	~ZoomInfo ()
	ZoomInfo (const ZoomInfo &)=delete
ZoomInfo &	operator= (const ZoomInfo &)=delete
double	PositionToTime (int64 position, int64 origin=0, bool ignoreFisheye=false) const
int64	TimeToPosition (double time, int64 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, int64 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
double	GetAbsoluteOffset (double offset) const
void	ZoomBy (double multiplier)
Intervals	FindIntervals (int64 width, int64 origin=0) const
FisheyeState	GetFisheyeState () const
bool	InFisheye (int64, int64=0) const
int64	GetFisheyeLeftBoundary (int64=0) const
int64	GetFisheyeRightBoundary (int64=0) const

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

Public Attributes
double	hpos
	Leftmost visible timeline position in seconds. More...
int	mWidth { 0 }
int	mVRulerWidth { 36 }

Protected Attributes
double	zoom
	pixels per second More...

Detailed Description

Definition at line 36 of file ZoomInfo.h.

Member Typedef Documentation

int64

using ZoomInfo::int64 = std::int64_t

Definition at line 41 of file ZoomInfo.h.

Intervals

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

Definition at line 144 of file ZoomInfo.h.

Member Enumeration Documentation

FisheyeState

enum ZoomInfo::FisheyeState

Enumerator
HIDDEN
PINNED
NUM_STATES

Definition at line 155 of file ZoomInfo.h.

                     {
      HIDDEN,
      PINNED,
 
      NUM_STATES,
   };

Constructor & Destructor Documentation

ZoomInfo() [1/2]

ZoomInfo::ZoomInfo	(	double	start,
		double	pixelsPerSecond
	)

Parameters

start

leftmost visible timeline position, in seconds

Definition at line 21 of file ZoomInfo.cpp.

   : hpos{ start }
   , zoom{ pixelsPerSecond }
{
}

~ZoomInfo()

ZoomInfo::~ZoomInfo

(

)

Definition at line 27 of file ZoomInfo.cpp.

{
}

ZoomInfo() [2/2]

ZoomInfo::ZoomInfo ( const ZoomInfo &  )

delete

Member Function Documentation

FindIntervals()

ZoomInfo::Intervals ZoomInfo::FindIntervals	(	int64	width,
		int64	origin = 0
	)		const

Definition at line 112 of file ZoomInfo.cpp.

{
   ZoomInfo::Intervals results;
   results.reserve(2);
 
   const int64 rightmost(origin + (0.5 + width));
   assert(origin <= rightmost);
   {
      results.push_back(Interval(origin, zoom, false));
   }
 
   if (origin < rightmost)
      results.push_back(Interval(rightmost, 0, false));
   assert(!results.empty() && results[0].position == origin);
   return results;
}

References zoom.

Referenced by anonymous_namespace{WaveformView.cpp}::FindWavePortions().

Here is the caller graph for this function:

GetAbsoluteOffset()

double ZoomInfo::GetAbsoluteOffset

(

double

offset

)

const

Get the absolute pixel offset, that corresponds to an offset on time line. This function effectively return std::floor(0.5 + h * zoom + offset)

Definition at line 77 of file ZoomInfo.cpp.

{
   return std::floor(0.5 + hpos * zoom + offset);
}

References hpos, and zoom.

Referenced by anonymous_namespace{TrackArt.cpp}::BeatsGridlinePainter::GetBoundaries().

Here is the caller graph for this function:

GetDefaultZoom()

static double ZoomInfo::GetDefaultZoom ( )

inlinestatic

Definition at line 116 of file ZoomInfo.h.

   { return 44100.0 / 512.0; }

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

Here is the caller graph for this function:

GetFisheyeLeftBoundary()

int64 ZoomInfo::GetFisheyeLeftBoundary ( int64  = 0 ) const

inline

Definition at line 171 of file ZoomInfo.h.

   {return 0;} // stub

GetFisheyeRightBoundary()

int64 ZoomInfo::GetFisheyeRightBoundary ( int64  = 0 ) const

inline

Definition at line 174 of file ZoomInfo.h.

   {return 0;} // stub

GetFisheyeState()

FisheyeState ZoomInfo::GetFisheyeState ( ) const

inline

Definition at line 161 of file ZoomInfo.h.

   { return HIDDEN; } // stub

GetLeftOffset()

int ZoomInfo::GetLeftOffset ( ) const

inline

Definition at line 96 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 82 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 86 of file ZoomInfo.cpp.

{ return gMinZoom;};

References anonymous_namespace{ZoomInfo.cpp}::gMinZoom.

GetScreenEndTime()

double ZoomInfo::GetScreenEndTime ( ) const

inline

Definition at line 107 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 99 of file ZoomInfo.h.

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

References kRightMargin.

GetVRulerOffset()

int ZoomInfo::GetVRulerOffset ( ) const

inline

Definition at line 93 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 91 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 88 of file ZoomInfo.h.

{ return mWidth; }

GetZoom()

double ZoomInfo::GetZoom

(

)

const

Definition at line 75 of file ZoomInfo.cpp.

{ return zoom;};

References zoom.

InFisheye()

bool ZoomInfo::InFisheye ( int64  , int64  = 0  ) const

inline

Definition at line 166 of file ZoomInfo.h.

   {return false;} // stub

OffsetTimeByPixels()

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

inline

Definition at line 83 of file ZoomInfo.h.

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

operator=()

ZoomInfo & ZoomInfo::operator= ( const ZoomInfo &  )

delete

PositionToTime()

double ZoomInfo::PositionToTime	(	int64	position,
		int64	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 34 of file ZoomInfo.cpp.

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

References hpos, and zoom.

Referenced by SelectHandle::AdjustSelection(), anonymous_namespace{SelectHandle.cpp}::ChooseBoundary(), ClipParameters::ClipParameters(), CommonTrackPanelCell::DoContextMenu(), TimeShiftHandle::DoSlideVertical(), SampleHandle::FindSampleEditingLevel(), CommonChannelView::GetEnvelopeValues(), TrackPanel::GetMostRecentXPos(), anonymous_namespace{WaveChannelView.cpp}::GetPixelsPerSecond(), LabelGlyphHandle::HandleGlyphDragRelease(), EnvelopeEditor::HandleMouseButtonDown(), EnvelopeEditor::MoveDragPoint(), AdornedRulerPanel::Pos2Time(), anonymous_namespace{BrushHandle.cpp}::PositionToLongSample(), SelectHandle::SelectHandle(), and LinearUpdater::Update().

Here is the caller graph for this function:

SetVRulerWidth()

void ZoomInfo::SetVRulerWidth ( int  width )

inline

Definition at line 92 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 89 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 88 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(), project, 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 60 of file ZoomInfo.cpp.

{
   return timeRange * zoom;
}

References zoom.

Referenced by anonymous_namespace{TrackArt.cpp}::BeatsGridlinePainter::GetMinorTick().

Here is the caller graph for this function:

TimeToPosition()

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

STM: Converts a project time to screen x position.

Definition at line 44 of file ZoomInfo.cpp.

{
   double t = 0.5 + zoom * (projectTime - hpos) + origin ;
   if( t < INT64_MIN )
      return INT64_MIN;
   if( t > INT64_MAX )
      return INT64_MAX;
   t = floor( t );
   return t;
}

Referenced by anonymous_namespace{TimeShiftHandle.cpp}::AdjustToSnap(), anonymous_namespace{SelectHandle.cpp}::ChooseTimeBoundary(), ClipParameters::ClipParameters(), LabelTrackView::ComputeLayout(), LabelTrackView::DialogForLabelName(), TrackArt::DrawBackgroundWithSelection(), TrackArt::DrawCursor(), ClipParameters::GetClipRect(), anonymous_namespace{TrackArt.cpp}::BeatsGridlinePainter::GetPositionInRect(), LabelGlyphHandle::HandleGlyphClick(), EnvelopeEditor::HandleMouseButtonDown(), anonymous_namespace{CutlineHandle.cpp}::IsOverCutline(), SnapManager::PixelDiff(), anonymous_namespace{SampleHandle.cpp}::SampleResolutionTest(), SnapManager::Snap(), AdornedRulerPanel::Time2Pos(), and LinearUpdater::Update().

Here is the caller graph for this function:

ZoomBy()

void ZoomInfo::ZoomBy

(

double

multiplier

)

Definition at line 106 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 65 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 70 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

hpos

double ZoomInfo::hpos

Leftmost visible timeline position in seconds.

Definition at line 54 of file ZoomInfo.h.

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

mVRulerWidth

int ZoomInfo::mVRulerWidth { 36 }

Definition at line 178 of file ZoomInfo.h.

mWidth

int ZoomInfo::mWidth { 0 }

Definition at line 177 of file ZoomInfo.h.

zoom

double ZoomInfo::zoom

protected

pixels per second

Definition at line 58 of file ZoomInfo.h.

Referenced by FindIntervals(), GetAbsoluteOffset(), GetZoom(), PositionToTime(), SetZoom(), TimeRangeToPixelWidth(), ZoomBy(), ZoomInAvailable(), and ZoomOutAvailable().

---

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

• ZoomInfo.h
• ZoomInfo.cpp