Beatmup::Fragments::Sequence::Pointer Class Reference

Points to a position within a sequence. More...

#include <sequence.h>

Public Member Functions
void	moveTo (dtime time)
	Sets pointer to a specific time. More...
void	step ()
	Moves the pointer forward an arbitrary number of samples. More...
void	watch ()
	Enables "watching mode", i.e., if the sequence is modified, the pointer will follow the modifications and remain valid. More...
void	jump (dtime by)
	Moves the pointer by a given number of samples relatively to the current position. More...
dtime	getTime () const
bool	hasData () const
int	samplesAvailable () const

Protected Member Functions
	Pointer (Sequence &sequence, dtime time, bool writing)
	~Pointer ()

Protected Attributes
Sequence &	sequence
FragmentPtr	pointer
	pointed fragment More...

Private Attributes
bool	writing
	if true, the pointer is used to modify the data More...
bool	watching
	if true, the pointer will remain valid even if the sequence is being modified More...
dtime	currentTime
int	fragmentIdx

Detailed Description

Points to a position within a sequence.

Definition at line 38 of file sequence.h.

Constructor & Destructor Documentation

Pointer()

Sequence::Pointer::Pointer ( Sequence &  sequence, dtime  time, bool  writing  )

protected

Definition at line 339 of file sequence.cpp.

                                                                     : writing(writing), watching(false), sequence(sequence) {
    if (0 <= time && time < sequence.cumTimes[1]) {
        // an heuristic to start quickly
        if (writing)
            sequence.fragments[0].editData();
        currentTime = time;
        pointer = sequence.fragments[0];
        pointer.offset += time;
        pointer.length -= time;
        fragmentIdx = 0;
    }
    else
        moveTo(time);
}

~Pointer()

Sequence::Pointer::~Pointer ( )

protected

Definition at line 355 of file sequence.cpp.

                          {
    if (watching)
        sequence.pointers.erase(std::find(sequence.pointers.begin(), sequence.pointers.end(), this));
}

Member Function Documentation

moveTo()

void Sequence::Pointer::moveTo

(

dtime

time

)

Sets pointer to a specific time.

Parameters

time	The time (in samples) to set the pointer to

Definition at line 361 of file sequence.cpp.

                                       {
    currentTime = time;
    fragmentIdx = sequence.findFragment(time);
    if (fragmentIdx != VOID_LEFT && fragmentIdx != VOID_RIGHT) {
        if (writing)
            sequence.fragments[fragmentIdx].editData();
        pointer = sequence.fragments[fragmentIdx];
        dtime dt = time - sequence.cumTimes[fragmentIdx];
        pointer.offset += dt;
        pointer.length -= dt;
    }
    else
        pointer.nullify();
}

step()

void Sequence::Pointer::step

(

)

Moves the pointer forward an arbitrary number of samples.

Definition at line 377 of file sequence.cpp.

                           {
    if (0 <= fragmentIdx && fragmentIdx < sequence.fragments.size()-1) {
        fragmentIdx++;
        pointer = sequence.fragments[fragmentIdx];
        currentTime = sequence.cumTimes[fragmentIdx];
    }
    else {
        fragmentIdx = VOID_RIGHT;
        pointer.nullify();
        currentTime = sequence.getDuration();
    }
}

watch()

void Sequence::Pointer::watch

(

)

Enables "watching mode", i.e., if the sequence is modified, the pointer will follow the modifications and remain valid.

Definition at line 391 of file sequence.cpp.

                            {
    if (!watching) {
        watching = true;
        sequence.pointers.push_back(this);
    }
}

jump()

void Beatmup::Fragments::Sequence::Pointer::jump ( dtime  by )

inline

Moves the pointer by a given number of samples relatively to the current position.

Definition at line 71 of file sequence.h.

{ moveTo(currentTime + by); }

getTime()

dtime Beatmup::Fragments::Sequence::Pointer::getTime ( ) const

inline

Definition at line 73 of file sequence.h.

{ return currentTime; }

hasData()

bool Beatmup::Fragments::Sequence::Pointer::hasData ( ) const

inline

Definition at line 74 of file sequence.h.

{ return !pointer.isNull(); }

samplesAvailable()

int Beatmup::Fragments::Sequence::Pointer::samplesAvailable ( ) const

inline

Definition at line 75 of file sequence.h.

{ return pointer.length; }

Member Data Documentation

writing

bool Beatmup::Fragments::Sequence::Pointer::writing

private

if true, the pointer is used to modify the data

Definition at line 40 of file sequence.h.

watching

bool Beatmup::Fragments::Sequence::Pointer::watching

private

if true, the pointer will remain valid even if the sequence is being modified

Definition at line 41 of file sequence.h.

currentTime

dtime Beatmup::Fragments::Sequence::Pointer::currentTime

private

Definition at line 42 of file sequence.h.

fragmentIdx

int Beatmup::Fragments::Sequence::Pointer::fragmentIdx

private

Definition at line 43 of file sequence.h.

sequence

Sequence& Beatmup::Fragments::Sequence::Pointer::sequence

protected

Definition at line 46 of file sequence.h.

pointer

FragmentPtr Beatmup::Fragments::Sequence::Pointer::pointer

protected

pointed fragment

Definition at line 47 of file sequence.h.

---

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

• core/fragments/sequence.h
• core/fragments/sequence.cpp