class "effectKeyMap". More...

#include <liblives.hpp>

Public Member Functions
bool	isValid () const
	Returns whether the effectKeyMap is valid or not. More...

bool	clear () const
	Unmap all effects from effectKey mappings, leaving an empty map. More...

effectKey	at (int i) const
	Returns the ith effect key for this key map. More...

size_t	size () const
	Returns the number of key slots (indices) in the effectKeyMap. More...

bool	operator== (const effectKeyMap &other) const

effectKey	operator[] (int i) const
	Returns an effect key with index i for this key map. More...

Protected Member Functions
	effectKeyMap (livesApp *lives)

Detailed Description

class "effectKeyMap".

Represents a mapping of effectKey instances to key slots. Real time effects are always applied in order of ascending index value (with the exception of generator effects, which are applied first).

See Also: livesApp::getEffectKeyMap()

Member Function Documentation

effectKey lives::effectKeyMap::at ( int i ) const

Returns the ith effect key for this key map.

Valid range for i is 1 <= i <= prefs::rteKeysVirtual(). For values of i outside this range, an invalid effectKey is returned.

Parameters

i	the index value

Returns: an effectKey with index i.

See Also: effectKey::operator[]

bool lives::effectKeyMap::clear ( ) const

Unmap all effects from effectKey mappings, leaving an empty map.

Only has an effect when livesApp::status() is LIVES_STATUS_READY.

Returns: true if all effects were unmapped

bool lives::effectKeyMap::isValid ( ) const

Returns whether the effectKeyMap is valid or not.

A valid effectKeyMap is owned by a valid livesApp, the livesApp::status() is not LIVES_STATUS_NOTREADY, and the index is 1 <= i <= prefs::rteKeysVirtual().

Returns: true if the effectKeyMap is valid.

bool lives::effectKeyMap::operator== ( const effectKeyMap & other ) const

inline

Returns: true if the two effectKeyMaps have the same livesApp

effectKey lives::effectKeyMap::operator[] ( int i ) const

inline

Returns an effect key with index i for this key map.

The value of i may be chosen freely, but if it is outside the range 1 <= i <= size() then the effectKey will be considered invalid.

Returns: an effectKey with index i for this key map.

See Also: at()

size_t lives::effectKeyMap::size ( ) const

Returns the number of key slots (indices) in the effectKeyMap.

The valid range of keys is 1 <= key <= size(). Equivalent to prefs::rteKeysVirtual(), except that if the effectKeyMap is invalid, returns 0.

Returns: the number of key slots.

See Also: prefs::rteKeysVirtual()

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

src/liblives.hpp
src/liblives.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation