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

The sources preset. More...

#include <SourcesPreset.h>

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

Public Member Functions

 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 preset.

The SourcesPreset should be used to manage sources and group presets

Definition at line 18 of file SourcesPreset.h.

Constructor & Destructor Documentation

Hoa2D::SourcesPreset::SourcesPreset ( )

The source preset constructor.

The source preset constructor allocates and initialize the member values.

Definition at line 11 of file SourcesPreset.cpp.

Member Function Documentation

void Hoa2D::SourcesPreset::copySlot ( long  sourceIndex,
long  destinationIndex 
)

Copy the content of a slot into another slot.

Parameters
sourceIndexThe index of the slot to copy.
destinationIndexThe index of the slot to copy in.

Definition at line 297 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::deleteSlot ( long  index)

Delete the slot and its content.

Parameters
indexThe index of the slot.

Definition at line 282 of file SourcesPreset.cpp.

long Hoa2D::SourcesPreset::getSlotExistence ( long  index)

Get the existence state of a given slot.

Parameters
indexThe index of the slot.

Definition at line 440 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::insertSlot ( SourcesManager sourcesManager,
long  index 
)

Store a SourcesManager object by inserting it at a particular slot index.

Parameters
sourcesManagerA SourcesManager object pointer.
indexThe index of the slot.

Definition at line 253 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::recallFractionalSlot ( SourcesManager sourcesManager,
long  sourceIndex,
long  destinationIndex,
double  fractionnalIndex 
)

Recall a given slot at a fractionnal index between two slot index.

Interpolate between two SourcesManager's states.

Parameters
sourcesManagerA SourcesManager object pointer.
sourceIndexIndex of the first slot.
destinationIndexIndex of the second slot.
fractionnalIndexThe fractionnal index (between 0 and 1).
See Also
recallFractionalSlot

Definition at line 342 of file SourcesPreset.cpp.

long Hoa2D::SourcesPreset::recallFractionalSlot ( SourcesManager sourcesManager,
double  fractionnalIndex 
)

Recall a given slot at a fractionnal index between two consecutive slot.

Interpolate between two SourcesManager's states.

Parameters
sourcesManagerA SourcesManager object pointer.
fractionnalIndexThe fractionnal index. (ex. 2.3 will interpolate between the slot 2 and slot 3)
See Also
recallFractionalSlot

Definition at line 354 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::recallSlot ( SourcesManager sourcesManager,
long  index 
)

Recall a given slot.

Recall SourcesManager state directly

Parameters
sourcesManagerA SourcesManager object pointer.
indexThe index of the slot.
See Also
recallFractionalSlot

Definition at line 333 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::removeSlot ( long  index)

Delete the content of a slot.

Parameters
indexThe index of the slot.

Definition at line 274 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::storeGroupAtNextSlot ( SourcesManager sourcesManager,
long  groupIndex 
)

Store a group at the next slot.

Parameters
sourcesManagerA SourcesManager object pointer.
slotIndexThe index of the slot.
groupIndexThe index of the group to store.

Definition at line 247 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::storeGroupAtSlot ( SourcesManager sourcesManager,
long  slotIndex,
long  groupIndex 
)

Store a group of source at a given slot index.

Parameters
sourcesManagerA SourcesManager object pointer.
slotIndexThe index of the slot.
groupIndexThe index of the group to store.

Definition at line 231 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::storeSourceAtNextSlot ( SourcesManager sourcesManager,
long  sourceIndex 
)

Store a source at the next slot.

Parameters
sourcesManagerA SourcesManager object pointer.
slotIndexThe index of the slot.
sourceIndexThe index of the source to store.

Definition at line 226 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::storeSourceAtSlot ( SourcesManager sourcesManager,
long  slotIndex,
long  sourceIndex 
)

Store a source at a given slot index.

Parameters
sourcesManagerA SourcesManager object pointer.
slotIndexThe index of the slot.
sourceIndexThe index of the source to store.

Definition at line 210 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::storeSourceManagerAtFirstEmptySlot ( SourcesManager sourcesManager)

Store a SourcesManager object at the first empty slot.

Parameters
sourcesManagerA SourcesManager object pointer.

Definition at line 181 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::storeSourceManagerAtLastUsedSlot ( SourcesManager sourcesManager)

Store a SourcesManager object at the last used slot.

Parameters
sourcesManagerA SourcesManager object pointer.

Definition at line 195 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::storeSourceManagerAtNewEndSlot ( SourcesManager sourcesManager)

Store a SourcesManager object in a new slot.

Parameters
sourcesManagerA SourcesManager object pointer.

Definition at line 205 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::storeSourceManagerAtNextSlot ( SourcesManager sourcesManager)

Store a SourcesManager object at the next slot.

Parameters
sourcesManagerA SourcesManager object pointer.

Definition at line 200 of file SourcesPreset.cpp.

void Hoa2D::SourcesPreset::storeSourceManagerAtSlot ( SourcesManager sourcesManager,
long  index 
)

Store a SourcesManager object at a particular slot index.

Parameters
sourcesManagerA SourcesManager object pointer.
indexThe index of the slot.

Definition at line 165 of file SourcesPreset.cpp.