LMMS
Loading...
Searching...
No Matches
juce::AnimatedPositionBehaviours::SnapToPageBoundaries Struct Reference

#include <juce_AnimatedPositionBehaviours.h>

Public Member Functions

 SnapToPageBoundaries ()=default
void releasedWithVelocity (double position, double releaseVelocity) noexcept
double getNextPosition (double oldPos, double elapsedSeconds) const noexcept
bool isStopped (double position) const noexcept

Private Attributes

double targetSnapPosition = 0.0

Detailed Description

A behaviour that gravitates an AnimatedPosition object towards the nearest integer position when released.

This class is intended to be used as a template parameter to the AnimatedPosition class. It's handy when using an AnimatedPosition to show a series of pages, because it allows the pages can be scrolled smoothly, but when released, snaps back to show a whole page.

See also
AnimatedPosition

@tags{GUI}

Constructor & Destructor Documentation

◆ SnapToPageBoundaries()

juce::AnimatedPositionBehaviours::SnapToPageBoundaries::SnapToPageBoundaries ( )
default

Member Function Documentation

◆ getNextPosition()

double juce::AnimatedPositionBehaviours::SnapToPageBoundaries::getNextPosition ( double oldPos,
double elapsedSeconds ) const
inlinenoexcept

Called by the AnimatedPosition class to get the new position, after the given time has elapsed.

◆ isStopped()

bool juce::AnimatedPositionBehaviours::SnapToPageBoundaries::isStopped ( double position) const
inlinenoexcept

Called by the AnimatedPosition class to check whether the object is now stationary.

◆ releasedWithVelocity()

void juce::AnimatedPositionBehaviours::SnapToPageBoundaries::releasedWithVelocity ( double position,
double releaseVelocity )
inlinenoexcept

Called by the AnimatedPosition class. This tells us the position and velocity at which the user is about to release the object. The velocity is measured in units/second.

Member Data Documentation

◆ targetSnapPosition

double juce::AnimatedPositionBehaviours::SnapToPageBoundaries::targetSnapPosition = 0.0
private

The documentation for this struct was generated from the following file: