HoaLibrary  2.0
High Order Ambisonics Library
 All Classes Namespaces Functions Enumerations Enumerator
Public Member Functions | List of all members
Hoa2D::SourcesTrajectory Class Reference

The sources trajectory. More...

#include <SourcesTrajectory.h>

Inheritance diagram for Hoa2D::SourcesTrajectory:
Hoa2D::SourcesPreset

Public Member Functions

 SourcesTrajectory ()
 The source trajectory constructor. More...
 
 ~SourcesTrajectory ()
 The source trajectory destructor free the memory.
 
void setRecording (bool isRecording)
 Set the recording state. More...
 
void setLimited (bool isLimited)
 Set the limited state. More...
 
void recordSourceInTrajectory (SourcesManager *sourcesManager, long sourceIndex)
 Record a source in trajectory. More...
 
void recordGroupInTrajectory (SourcesManager *sourcesManager, long groupIndex)
 Record a group in trajectory. More...
 
void playTrajectory (SourcesManager *sourcesManager, double fractionnalValue)
 Play a trajectory at a fractionnal index. More...
 
void erase ()
 Erase all of the trajectory.
 
void erase (double fractionnalValueBegin, double fractionnalValueEnd)
 Erase a part of a trajectory. More...
 
bool getLimited () const
 Is the sources trajectory limited. More...
 
bool getRecording () const
 Get the recording state. More...
 
- Public Member Functions inherited from Hoa2D::SourcesPreset
 SourcesPreset ()
 The source preset constructor. More...
 
 ~SourcesPreset ()
 The source preset destructor free the memory.
 
void storeSourceManagerAtSlot (SourcesManager *sourcesManager, long index)
 Store a SourcesManager object at a particular slot index. More...
 
void storeSourceManagerAtFirstEmptySlot (SourcesManager *sourcesManager)
 Store a SourcesManager object at the first empty slot. More...
 
void storeSourceManagerAtLastUsedSlot (SourcesManager *sourcesManager)
 Store a SourcesManager object at the last used slot. More...
 
void storeSourceManagerAtNewEndSlot (SourcesManager *sourcesManager)
 Store a SourcesManager object in a new slot. More...
 
void storeSourceManagerAtNextSlot (SourcesManager *sourcesManager)
 Store a SourcesManager object at the next slot. More...
 
void insertSlot (SourcesManager *sourcesManager, long index)
 Store a SourcesManager object by inserting it at a particular slot index. More...
 
void removeSlot (long index)
 Delete the content of a slot. More...
 
void deleteSlot (long index)
 Delete the slot and its content. More...
 
void copySlot (long sourceIndex, long destinationIndex)
 Copy the content of a slot into another slot. More...
 
void renumber ()
 Renumber all slots.
 
void clear ()
 Clear all slots.
 
void storeSourceAtSlot (SourcesManager *sourcesManager, long slotIndex, long sourceIndex)
 Store a source at a given slot index. More...
 
void storeSourceAtNextSlot (SourcesManager *sourcesManager, long sourceIndex)
 Store a source at the next slot. More...
 
void storeGroupAtSlot (SourcesManager *sourcesManager, long slotIndex, long groupIndex)
 Store a group of source at a given slot index. More...
 
void storeGroupAtNextSlot (SourcesManager *sourcesManager, long groupIndex)
 Store a group at the next slot. More...
 
void recallSlot (SourcesManager *sourcesManager, long index)
 Recall a given slot. More...
 
void recallFractionalSlot (SourcesManager *sourcesManager, long sourceIndex, long destinationIndex, double fractionnalIndex)
 Recall a given slot at a fractionnal index between two slot index. More...
 
long recallFractionalSlot (SourcesManager *sourcesManager, double fractionnalIndex)
 Recall a given slot at a fractionnal index between two consecutive slot. More...
 
long getMaximumIndexOfSlot ()
 Get The maximum index of slots.
 
long getSlotExistence (long index)
 Get the existence state of a given slot. More...
 

Detailed Description

The sources trajectory.

The SourcesTrajectory should be used to manage sources trajectory

Definition at line 17 of file SourcesTrajectory.h.

Constructor & Destructor Documentation

Hoa2D::SourcesTrajectory::SourcesTrajectory ( )

The source trajectory constructor.

The source trajectory constructor allocates and initialize the member values.

Definition at line 11 of file SourcesTrajectory.cpp.

Member Function Documentation

void Hoa2D::SourcesTrajectory::erase ( double  fractionnalValueBegin,
double  fractionnalValueEnd 
)

Erase a part of a trajectory.

Parameters
fractionnalValueBeginThe fractionnal begin value of the trajectory (between 0. and 1.).
fractionnalValueEndThe fractionnal end value of the trajectory (between 0. and 1.).

Definition at line 76 of file SourcesTrajectory.cpp.

bool Hoa2D::SourcesTrajectory::getLimited ( ) const
inline

Is the sources trajectory limited.

Returns
The limited state

Definition at line 82 of file SourcesTrajectory.h.

bool Hoa2D::SourcesTrajectory::getRecording ( ) const
inline

Get the recording state.

Returns
The recording state

Definition at line 88 of file SourcesTrajectory.h.

void Hoa2D::SourcesTrajectory::playTrajectory ( SourcesManager sourcesManager,
double  fractionnalValue 
)

Play a trajectory at a fractionnal index.

Parameters
sourcesManagerA SourcesManager object pointer.
fractionnalValueThe fractionnal value (between 0. and 1.).

Definition at line 61 of file SourcesTrajectory.cpp.

void Hoa2D::SourcesTrajectory::recordGroupInTrajectory ( SourcesManager sourcesManager,
long  groupIndex 
)

Record a group in trajectory.

Parameters
sourcesManagerA SourcesManager object pointer.
groupIndexThe index of the source.

Definition at line 44 of file SourcesTrajectory.cpp.

void Hoa2D::SourcesTrajectory::recordSourceInTrajectory ( SourcesManager sourcesManager,
long  sourceIndex 
)

Record a source in trajectory.

Parameters
sourcesManagerA SourcesManager object pointer.
sourceIndexThe index of the source.

Definition at line 27 of file SourcesTrajectory.cpp.

void Hoa2D::SourcesTrajectory::setLimited ( bool  isLimited)

Set the limited state.

Parameters
isLimitedThe limited state

Definition at line 22 of file SourcesTrajectory.cpp.

void Hoa2D::SourcesTrajectory::setRecording ( bool  isRecording)

Set the recording state.

Parameters
isRecordingThe recording state

Definition at line 17 of file SourcesTrajectory.cpp.