Isomet Modular Synthesiser (iMS) API
v1.4.2
iMS API
|
An ImageSequence object completely defines a sequence to be played back on an iMS Controller in terms by containing a list of ImageSequenceEntry 's plus a terminating action and optional value. More...
#include <include/Image.h>
Public Member Functions | |
Constructors & Destructor | |
ImageSequence () | |
Create a default empty Image Sequence. | |
ImageSequence (SequenceTermAction action, int val=0) | |
Create a default empty Image Sequence with Termination Action specifier. More... | |
~ImageSequence () | |
Destructor. | |
ImageSequence (const ImageSequence &) | |
Copy Constructor. | |
ImageSequence & | operator= (const ImageSequence &) |
Assignment Constructor. | |
Control Sequence Terminating Actions | |
void | OnTermination (SequenceTermAction act, int val=0) |
Update Termination Action. More... | |
const SequenceTermAction & | TermAction () const |
return a reference to the currently assign Termination Action More... | |
const int & | TermValue () const |
return a reference to the currently assign Termination Action Parameter More... | |
![]() | |
bool | operator== (ListBase const &rhs) const |
Equality Operator checks ListBase object for equivalence. More... | |
ListBase (const std::string &Name="[no name]", const std::time_t &modified_time=std::time(nullptr)) | |
Create a default empty List with optional name parameter. | |
ListBase (const ListBase &) | |
Copy Constructor. | |
~ListBase () | |
Destructor. | |
ListBase & | operator= (const ListBase &) |
Assignment Constructor. | |
const std::array< std::uint8_t, 16 > | GetUUID () const |
Returns a vector representing the Unique Identifier assigned to the ListBase object. More... | |
const std::time_t & | ModifiedTime () const |
Returns Time at which the Container was last modified. More... | |
std::string | ModifiedTimeFormat () const |
Returns Human-readable string for the time at which the Container was last modified. More... | |
const std::string & | Name () const |
A string stored with the Container to aid human users in identifying its purpose. More... | |
std::string & | Name () |
void | assign (size_t n, const ImageSequenceEntry &val) |
Assign new content to ImageSequence list. More... | |
void | push_front (const ImageSequenceEntry &val) |
Insert ImageSequenceEntry at beginning. More... | |
void | pop_front () |
Delete first ImageSequenceEntry. More... | |
void | push_back (const ImageSequenceEntry &val) |
Add ImageSequenceEntry at end. More... | |
void | pop_back () |
Delete last ImageSequenceEntry. More... | |
iterator | insert (iterator position, const ImageSequenceEntry &val) |
Insert ImageSequenceEntry. More... | |
iterator | insert (iterator position, const_iterator first, const_iterator last) |
Insert Range Of ImageSequenceEntry's. More... | |
iterator | erase (iterator position) |
Erase ImageSequenceEntry. More... | |
iterator | erase (iterator first, iterator last) |
Erase a range of ImageSequenceEntry's. More... | |
void | resize (size_t n) |
Change Size. More... | |
void | clear () |
Clear Content. More... | |
bool | empty () const |
Returns True if the ListBase is empty. More... | |
std::size_t | size () const |
Returns the Number of Entries in the ListBase. More... | |
iterator | begin () |
Returns an iterator pointing to the first element in the ListBase container. More... | |
const_iterator | begin () const |
Returns a const_iterator pointing to the first element in the ListBase container. More... | |
iterator | end () |
Returns an iterator referring to the past-the-end element in the ListBase container. More... | |
const_iterator | end () const |
Returns a const_iterator referring to the past-the-end element in the ListBase container. More... | |
const_iterator | cbegin () const |
Returns a const_iterator pointing to the first element in the ListBase container. More... | |
const_iterator | cend () const |
Returns a const_iterator referring to the past-the-end element in the ListBase container. More... | |
Additional Inherited Members | |
![]() | |
typedef std::list< ImageSequenceEntry >::iterator | iterator |
Iterator defined for user manipulation of ListBase. | |
typedef std::list< ImageSequenceEntry >::const_iterator | const_iterator |
Const Iterator defined for user readback of ListBase. | |
An ImageSequence object completely defines a sequence to be played back on an iMS Controller in terms by containing a list of ImageSequenceEntry 's plus a terminating action and optional value.
Each ImageSequenceEntry defines the Image to be played back at that point in the sequence, together with relevant parameters such as clock frequency, divider and number of repeats. The ImageSequenceEntry 's are played back in the order in which they appear in the ImageSequence list.
The ImageSequence is a container for the list of ImageSequenceEntry 's. User application code can create the entries and add them / remove them from the front or back of the list, insert them or erase them from anywhere in the list, or assign multiple copies of the entry to the list.
As with Images, ImageSequences have a Unique ID (UUID) associated with them which are used to uniquely refer to sequences when communicating with the iMS Controller through the SequenceManager.
iMS::ImageSequence::ImageSequence | ( | SequenceTermAction | action, |
int | val = 0 |
||
) |
Create a default empty Image Sequence with Termination Action specifier.
action | The operation to perform once the Sequence has completed playback |
val | Optional parameter to the Termination Action |
void iMS::ImageSequence::OnTermination | ( | SequenceTermAction | act, |
int | val = 0 |
||
) |
Update Termination Action.
[in] | act | Assign an operation to perform when the Sequence completes |
[in] | val | Optional Parameter to use with some Termination Actions |
const SequenceTermAction& iMS::ImageSequence::TermAction | ( | ) | const |
return a reference to the currently assign Termination Action
const int& iMS::ImageSequence::TermValue | ( | ) | const |
return a reference to the currently assign Termination Action Parameter