This class is an interface for elements with a position on the staff, such as rests. More...

#include <positioninterface.h>

Inheritance diagram for vrv::PositionInterface:

Public Member Functions
int	CalcDrawingLoc (const Layer layer, const LayerElement element)

bool	HasIdenticalPositionInterface (const PositionInterface *otherPositionInterface) const
	Inteface comparison operator. More...

bool	HasLedgerLines (int &linesAbove, int &linesBelow, const Staff *staff) const
	Check if the note has ledger lines. More...

Constructors, destructors, reset methods
Reset method resets all attribute classes
	PositionInterface ()

virtual	~PositionInterface ()

void	Reset () override
	Virtual reset method. More...

InterfaceId	IsInterface () const override
	Virtual method returning the InterfaceId of the interface. More...

Setter and getter for the drawing staff loc.
This is set by the CalcAlignmentPitchPosFunctor.
void	SetDrawingLoc (int drawingLoc)

int	GetDrawingLoc () const


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

FunctorCode	InterfaceResetHorizontalAlignment (ResetHorizontalAlignmentFunctor &functor, Object *object)

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 with a position on the staff, such as rests.

It is not an abstract class but should not be instanciated directly. For now, the position is handled in a similar way that for PitchInterface, that is with a pitch and octave.

Member Function Documentation

◆ HasIdenticalPositionInterface()

bool vrv::PositionInterface::HasIdenticalPositionInterface ( const PositionInterface * otherPositionInterface ) const

Inteface comparison operator.

Checks if the LayerElement has a PositionInterface and compares attributes

◆ HasLedgerLines()

bool vrv::PositionInterface::HasLedgerLines	(	int &	linesAbove,
		int &	linesBelow,
		const Staff *	staff
	)		const

Check if the note has ledger lines.

If staff is passed, use it for getting the staff line number. Otherwise, it will look for the Staff ancestor. Set the value of ledger lines above or below.

◆ InterfaceResetData()

FunctorCode vrv::PositionInterface::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::PositionInterface::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::PositionInterface::Reset ( )

overridevirtual

Virtual reset method.