Verovio
Source code documentation
vrv::OffsetInterface Class Reference

This class is an interface for elements having a single visual offset, such as arpeg, reh, etc. More...

#include <offsetinterface.h>

Inheritance diagram for vrv::OffsetInterface:
vrv::Interface vrv::Accid vrv::Artic vrv::Clef vrv::ControlElement vrv::Custos vrv::DivLine vrv::Dot vrv::HalfmRpt vrv::Liquescent vrv::MRest vrv::Nc vrv::Neume vrv::Note vrv::Oriscus vrv::Quilisma vrv::Rest vrv::Syl vrv::TabGrp

Public Member Functions

FunctorCode InterfaceResetData (ResetDataFunctor &functor, Object *object)
 We have functor code in the interface for avoiding code duplication in each implementation class. More...
 
Constructors, destructors, reset methods

Reset method reset all attribute classes

 OffsetInterface ()
 
virtual ~OffsetInterface ()
 
void Reset () override
 Virtual reset method. More...
 
InterfaceId IsInterface () const override
 Virtual method returning the InterfaceId of the interface. More...
 
- Public Member Functions inherited from vrv::Interface
void RegisterInterfaceAttClass (AttClassId attClassId)
 Method for registering an MEI att classes in the interface.
 
std::vector< AttClassId > * GetAttClasses ()
 Method for obtaining a pointer to the attribute class vector of the interface.
 
 Interface ()
 
virtual ~Interface ()
 

Detailed Description

This class is an interface for elements having a single visual offset, such as arpeg, reh, etc.

It is not an abstract class but should not be instantiated directly.

Member Function Documentation

◆ InterfaceResetData()

FunctorCode vrv::OffsetInterface::InterfaceResetData ( ResetDataFunctor functor,
Object object 
)

We have functor code in the interface for avoiding code duplication in each implementation class.

Since we are in an interface, we need to pass the object (implementation) to the pseudo functor method.

◆ IsInterface()

InterfaceId vrv::OffsetInterface::IsInterface ( ) const
inlineoverridevirtual

Virtual method returning the InterfaceId of the interface.

Needs to be overridden in child classes.

Reimplemented from vrv::Interface.

◆ Reset()

void vrv::OffsetInterface::Reset ( )
overridevirtual

Virtual reset method.

Needs to be overridden in child classes.

Reimplemented from vrv::Interface.

Reimplemented in vrv::Turn, vrv::Trill, vrv::Tie, vrv::Tempo, vrv::TabGrp, vrv::Syl, vrv::Slur, vrv::Rest, vrv::RepeatMark, vrv::Reh, vrv::Quilisma, vrv::PitchInflection, vrv::Phrase, vrv::Pedal, vrv::Ornam, and vrv::Oriscus.


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