This class represents a basic object. More...

#include <object.h>

Inheritance diagram for vrv::Object:

Public Types
typedef bool(*	binaryComp) (Object , Object )
	Sort children by a function that takes two arguments and returns true if the first argument is less than the second. More...

Public Member Functions
bool	IsFloatingObject () const
	Wrapper for checking if an element is a floating object (system elements and control elements)

const Resources *	GetDocResources () const
	Resource access from the document.

virtual void	Reset ()
	Reset the object, that is 1) removing all children and 2) resetting all attributes. More...

	Object (const Object &object)
	Copy constructor that also copy the children. More...

Object &	operator= (const Object &object)
	Copy assignement - see copy constructor.

void	MoveChildrenFrom (Object *sourceParent, int idx=-1, bool allowTypeChange=false)
	Move all the children of the object passed as parameter to this one. More...

void	ReplaceChild (Object currentChild, Object replacingChild)
	Replace the currentChild with the replacingChild. More...

void	SortChildren (binaryComp comp)

void	MoveItselfTo (Object *targetParent)
	Move an object to another parent. More...

virtual Object *	Clone () const
	Method call for copying child classes. More...

virtual bool	CopyChildren () const
	Indicate whereas children have to be copied in copy / assignment constructors. More...

virtual void	CloneReset ()
	Reset pointers after a copy and assignment constructor call. More...

const std::string &	GetID () const

void	SetID (const std::string &id)

void	SwapID (Object *other)

void	ResetID ()

std::string	GetComment () const
	Methods for setting / getting comments.

void	SetComment (std::string comment)

bool	HasComment () const

std::string	GetClosingComment () const

void	SetClosingComment (std::string endComment)

bool	HasClosingComment () const

ArrayOfObjects &	GetChildrenForModification ()
	Return a reference to the children that allows modification. More...

void	CopyAttributesTo (Object *target) const
	Copy all the attributes of an obejct to target. More...

int	GetAttributes (ArrayOfStrAttr *attributes) const
	Fill an array of pairs with all attributes and their values. More...

bool	HasAttribute (std::string attribute, std::string value) const
	Check if an Object has an attribute with the specified value.

void	SetParent (Object *parent)
	Set the parent of the Object. More...

void	ResetParent ()
	Reset the parent of the Object. More...

virtual bool	IsSupportedChild (ClassId classId)
	Base method for checking if a child can be added. More...

virtual void	AddChild (Object *object)
	Base method for adding children. More...

virtual bool	AddChildAdditionalCheck (Object *child)
	Additional check when adding a child.

virtual int	GetInsertOrderFor (ClassId classId) const
	Return the child order for a the given ClassId. More...

int	GetInsertOrderForIn (ClassId classId, const std::vector< ClassId > &order) const
	Find the order from an overriden GetInsertOrderFor method.

int	GetIdx () const
	Return the index position of the object in its parent (-1 if not found)

int	GetChildIndex (const Object *child) const
	Look for the Object in the children and return its position (-1 if not found)

int	GetDescendantIndex (const Object *child, const ClassId classId, int depth)
	Look for all Objects of a class and return its position (-1 if not found)

void	InsertChild (Object *element, int idx)
	Insert an element at the idx position.

void	RotateChildren (int first, int middle, int last)
	Rotates the child elements of the object leftwards, using std::rotate() with the given indices. More...

Object *	DetachChild (int idx)
	Detach the child at the idx position (NULL if not found) The parent pointer is set to NULL.

void	ReplaceWithCopyOf (Object *object)
	Replace an object with a copy of the other. More...

bool	HasDescendant (const Object *child, int deepness=UNLIMITED_DEPTH) const
	Return true if the object has the child Object as descendant (reference of direct). More...

Object *	Relinquish (int idx)
	Give up ownership of the child at the idx position (NULL if not found) This is a method to be used only in the very particular case where the child object cannot be detached straight away. More...

void	ClearRelinquishedChildren ()
	Removes all the children that were previously relinquished. More...

void	ClearChildren ()
	Clear the children vector and delete all the objects.

bool	DeleteChild (Object *child)
	Remove and delete the child. More...

int	DeleteChildrenByComparison (Comparison *comparison)
	Delete the children that match the comparison. More...

void	FillFlatList (ListOfConstObjects &list) const
	Fill the list of all the children LayerElement. More...

bool	IsModified () const
	Check if the content was modified or not.

void	Modify (bool modified=true) const
	Mark the object and its parent (if any) as modified.

bool	HasEditorialContent ()
	Return true if the object contains any editorial content.

bool	HasNonEditorialContent ()
	Return true if the object contains anything that is not editorial content.

void	SaveObject (Output *output, bool basic)
	Saves the object (and its children) using the specified output stream.

template<class Compare >
void	StableSort (Compare comp)
	Sort the child elements using std::stable_sort.

void	ReorderByXPos ()

Object *	FindNextChild (Comparison comp, Object start)

Object *	FindPreviousChild (Comparison comp, Object start)

Constructors, destructors, and other standard methods
Reset method resets all attribute classes
	Object ()

	Object (ClassId classId)

virtual	~Object ()

ClassId	GetClassId () const final

virtual std::string	GetClassName () const


void	SetAsReferenceObject ()
	Make an object a reference object that do not own children. More...

bool	IsReferenceObject () const


bool	IsMilestoneElement ()
	Wrapper for checking if an element has a milestone start interface and also if is set as a milestone element.

Object *	GetMilestoneEnd ()

Methods for checking if an object is part of a group of classId's.
Used the static methods passing the object m_classId.
bool	IsControlElement () const

bool	IsEditorialElement () const

bool	IsLayerElement () const

bool	IsPageElement () const

bool	IsRunningElement () const

bool	IsScoreDefElement () const

bool	IsSystemElement () const

bool	IsTextElement () const

Methods for registering a MEI att class and for registering interfaces regrouping MEI att classes.
void	RegisterAttClass (AttClassId attClassId)

bool	HasAttClass (AttClassId attClassId) const

void	RegisterInterface (std::vector< AttClassId > *attClasses, InterfaceId interfaceId)

bool	HasInterface (InterfaceId interfaceId) const

Getter to interfaces
virtual AltSymInterface *	GetAltSymInterface ()

virtual const AltSymInterface *	GetAltSymInterface () const

virtual AreaPosInterface *	GetAreaPosInterface ()

virtual const AreaPosInterface *	GetAreaPosInterface () const

virtual BeamDrawingInterface *	GetBeamDrawingInterface ()

virtual const BeamDrawingInterface *	GetBeamDrawingInterface () const

virtual DurationInterface *	GetDurationInterface ()

virtual const DurationInterface *	GetDurationInterface () const

virtual LinkingInterface *	GetLinkingInterface ()

virtual const LinkingInterface *	GetLinkingInterface () const

virtual FacsimileInterface *	GetFacsimileInterface ()

virtual const FacsimileInterface *	GetFacsimileInterface () const

virtual PitchInterface *	GetPitchInterface ()

virtual const PitchInterface *	GetPitchInterface () const

virtual PlistInterface *	GetPlistInterface ()

virtual const PlistInterface *	GetPlistInterface () const

virtual PositionInterface *	GetPositionInterface ()

virtual const PositionInterface *	GetPositionInterface () const

virtual ScoreDefInterface *	GetScoreDefInterface ()

virtual const ScoreDefInterface *	GetScoreDefInterface () const

virtual StemmedDrawingInterface *	GetStemmedDrawingInterface ()

virtual const StemmedDrawingInterface *	GetStemmedDrawingInterface () const

virtual TextDirInterface *	GetTextDirInterface ()

virtual const TextDirInterface *	GetTextDirInterface () const

virtual TimePointInterface *	GetTimePointInterface ()

virtual const TimePointInterface *	GetTimePointInterface () const

virtual TimeSpanningInterface *	GetTimeSpanningInterface ()

virtual const TimeSpanningInterface *	GetTimeSpanningInterface () const

Insert an object before or after a given child
void	InsertBefore (Object child, Object newChild)

void	InsertAfter (Object child, Object newChild)

Children count, with or without a ClassId.
Used for classes with several types of children. The methods count at the first level.
int	GetChildCount () const

int	GetChildCount (const ClassId classId) const

int	GetChildCount (const ClassId classId, int depth) const

int	GetDescendantCount (const ClassId classId) const


Object *	GetChild (int idx)
	Child access (generic)

const Object *	GetChild (int idx) const

Object *	GetChild (int idx, const ClassId classId)

const Object *	GetChild (int idx, const ClassId classId) const


ArrayOfConstObjects	GetChildren () const
	Return the children as const reference or copy.

const ArrayOfObjects &	GetChildren ()

Iterator methods for accessing children.
GetFirst returns the first element child of the specified type. Its position and the specified type are stored and used of accessing next elements The methods returns NULL when no child is found or when the end is reached. Always call GetFirst before calling GetNext() or call GetNext(child)
Object *	GetFirst (const ClassId classId=UNSPECIFIED)

const Object *	GetFirst (const ClassId classId=UNSPECIFIED) const

Object *	GetNext ()

const Object *	GetNext () const

Retrieving next or previous sibling of a certain type.
Returns NULL is not found
Object *	GetNext (const Object *child, const ClassId classId=UNSPECIFIED)

const Object *	GetNext (const Object *child, const ClassId classId=UNSPECIFIED) const

Object *	GetPrevious (const Object *child, const ClassId classId=UNSPECIFIED)

const Object *	GetPrevious (const Object *child, const ClassId classId=UNSPECIFIED) const


Object *	GetLast (const ClassId classId=UNSPECIFIED)
	Return the last child of the object (if any, NULL otherwise)

const Object *	GetLast (const ClassId classId=UNSPECIFIED) const


Object *	GetParent ()
	Get the parent of the Object.

const Object *	GetParent () const

Get the X and Y drawing position
int	GetDrawingX () const override

int	GetDrawingY () const override

Reset the cached values of the drawingX and Y values.
Reset all children recursively
void	ResetCachedDrawingX () const override

void	ResetCachedDrawingY () const override


Object *	FindDescendantByID (const std::string &id, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD)
	Look for a descendant with the specified id (returns NULL if not found) This method is a wrapper for the Object::FindByID functor.

const Object *	FindDescendantByID (const std::string &id, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD) const


Object *	FindDescendantByType (ClassId classId, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD)
	Look for a descendant with the specified type (returns NULL if not found) This method is a wrapper for the Object::FindByType functor.

const Object *	FindDescendantByType (ClassId classId, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD) const


Object *	FindDescendantByComparison (Comparison *comparison, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD)
	Return the first element matching the Comparison functor Deepness allow to limit the depth search (EditorialElements are not count)

const Object *	FindDescendantByComparison (Comparison *comparison, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD) const


Object *	FindDescendantExtremeByComparison (Comparison *comparison, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD)
	Return the element matching the extreme value with an Comparison functor Deepness allow to limit the depth search (EditorialElements are not count)

const Object *	FindDescendantExtremeByComparison (Comparison *comparison, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD) const


ListOfObjects	FindAllDescendantsByType (ClassId classId, bool continueDepthSearchForMatches=true, int deepness=UNLIMITED_DEPTH)
	Return all the objects with specified type.

ListOfConstObjects	FindAllDescendantsByType (ClassId classId, bool continueDepthSearchForMatches=true, int deepness=UNLIMITED_DEPTH) const


void	FindAllDescendantsByComparison (ListOfObjects objects, Comparison comparison, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD, bool clear=true)
	Return all the objects matching the Comparison functor Deepness allow to limit the depth search (EditorialElements are not count)

void	FindAllDescendantsByComparison (ListOfConstObjects objects, Comparison comparison, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD, bool clear=true) const


void	FindAllDescendantsBetween (ListOfObjects objects, Comparison comparison, const Object start, const Object end, bool clear=true, int depth=UNLIMITED_DEPTH)
	Return all the objects matching the Comparison functor and being between start and end in the tree. More...

void	FindAllDescendantsBetween (ListOfConstObjects objects, Comparison comparison, const Object start, const Object end, bool clear=true, int depth=UNLIMITED_DEPTH) const


ListOfObjects	GetAncestors ()
	Returns all ancestors.

ListOfConstObjects	GetAncestors () const


Object *	GetFirstAncestor (const ClassId classId, int maxSteps=-1)
	Return the first ancestor of the specified type. More...

const Object *	GetFirstAncestor (const ClassId classId, int maxSteps=-1) const


Object *	GetFirstAncestorInRange (const ClassId classIdMin, const ClassId classIdMax, int maxDepth=-1)

const Object *	GetFirstAncestorInRange (const ClassId classIdMin, const ClassId classIdMax, int maxDepth=-1) const


Object *	GetLastAncestorNot (const ClassId classId, int maxSteps=-1)
	Return the last ancestor that is NOT of the specified type. More...

const Object *	GetLastAncestorNot (const ClassId classId, int maxSteps=-1) const


Object *	GetFirstChildNot (const ClassId classId)
	Return the first child that is NOT of the specified type.

const Object *	GetFirstChildNot (const ClassId classId) const

Setter and getter of the attribute flag
bool	IsAttribute () const

void	IsAttribute (bool isAttribute)

Setter and getter of the expansion flag
bool	IsExpansion () const

void	IsExpansion (bool isExpansion)


void	Process (Functor &functor, int deepness=UNLIMITED_DEPTH, bool skipFirst=false)
	Main method that processes functors. More...

void	Process (ConstFunctor &functor, int deepness=UNLIMITED_DEPTH, bool skipFirst=false) const


virtual FunctorCode	Accept (Functor &functor)
	Interface for class functor visitation.

virtual FunctorCode	Accept (ConstFunctor &functor) const

virtual FunctorCode	AcceptEnd (Functor &functor)

virtual FunctorCode	AcceptEnd (ConstFunctor &functor) const


void	LogDebugTree (int maxDepth=UNLIMITED_DEPTH, int level=0)
	Output the class name of the object (or a custom msg) and of its children recursively.

virtual std::string	LogDebugTreeMsg ()

Public Member Functions inherited from vrv::BoundingBox
virtual void	ResetBoundingBox ()
	Reset the bounding box values.

bool	Encloses (const Point point) const
	Return true if the bounding box encloses the point.

int	Intersects (const FloatingCurvePositioner *curve, Accessor type, int margin=0) const
	Return intersection between the bounding box and the curve represented by the FloatingPositioner. More...

int	Intersects (const BeamDrawingInterface *beamInterface, Accessor type, int margin=0, bool fromBeamContentSide=false) const
	Return intersection between the bounding box and the beam represented by the BeamDrawingInterface. More...

	BoundingBox ()

virtual	~BoundingBox ()

bool	Is (ClassId classId) const

bool	Is (const std::vector< ClassId > &classIds) const

virtual void	UpdateContentBBoxX (int x1, int x2)

virtual void	UpdateContentBBoxY (int y1, int y2)

virtual void	UpdateSelfBBoxX (int x1, int x2)

virtual void	UpdateSelfBBoxY (int y1, int y2)

void	SetEmptyBB ()

bool	HasSelfBB () const

bool	HasSelfHorizontalBB () const

bool	HasSelfVerticalBB () const

bool	HasContentBB () const

bool	HasContentHorizontalBB () const

bool	HasContentVerticalBB () const

bool	HasEmptyBB () const

void	SetBoundingBoxGlyph (char32_t smuflGlyph, int fontSize)
	Set and get the smuflGlyph / fontsize for a bounding box that is the one of a single SMuFL glyph.

char32_t	GetBoundingBoxGlyph () const

int	GetBoundingBoxGlyphFontSize () const

int	GetSelfBottom () const

int	GetSelfTop () const

int	GetSelfLeft () const

int	GetSelfRight () const

int	GetContentBottom () const

int	GetContentTop () const

int	GetContentLeft () const

int	GetContentRight () const

int	GetSelfX1 () const

int	GetSelfX2 () const

int	GetSelfY1 () const

int	GetSelfY2 () const

int	GetContentX1 () const

int	GetContentX2 () const

int	GetContentY1 () const

int	GetContentY2 () const

int	GetBottomBy (Accessor type) const

int	GetTopBy (Accessor type) const

int	GetLeftBy (Accessor type) const

int	GetRightBy (Accessor type) const

int	GetX1By (Accessor type) const

int	GetX2By (Accessor type) const

int	GetY1By (Accessor type) const

int	GetY2By (Accessor type) const

bool	HorizontalContentOverlap (const BoundingBox *other, int margin=0) const

bool	VerticalContentOverlap (const BoundingBox *other, int margin=0) const

bool	HorizontalSelfOverlap (const BoundingBox *other, int margin=0) const

bool	VerticalSelfOverlap (const BoundingBox *other, int margin=0) const

int	HorizontalLeftOverlap (const BoundingBox other, const Doc doc, int margin=0, int vMargin=0) const

int	HorizontalRightOverlap (const BoundingBox other, const Doc doc, int margin=0, int vMargin=0) const

int	VerticalTopOverlap (const BoundingBox other, const Doc doc, int margin=0, int hMargin=0) const

int	VerticalBottomOverlap (const BoundingBox other, const Doc doc, int margin=0, int hMargin=0) const

int	GetCutOutTop (const Resources &resources) const

int	GetCutOutBottom (const Resources &resources) const

int	GetCutOutLeft (const Resources &resources) const

int	GetCutOutRight (const Resources &resources) const

int	GetCutOutLeft (const Resources &resources, bool fromTop) const

int	GetCutOutRight (const Resources &resources, bool fromTop) const

Static Public Member Functions
static void	SeedID (uint32_t seed=0)

static std::string	GenerateHashID ()

static uint32_t	Hash (uint32_t number, bool reverse=false)

static bool	sortByUlx (Object a, Object b)

static bool	IsPreOrdered (const Object left, const Object right)
	Return true if left appears before right in preorder traversal.

Static methods for checking if classId is part of a group of classId's.
For example, all LayerElement child class classId's are between LAYER_ELEMENT and LAYER_ELEMENT_max. See classId enum.
static bool	IsControlElement (ClassId classId)

static bool	IsEditorialElement (ClassId classId)

static bool	IsLayerElement (ClassId classId)

static bool	IsPageElement (ClassId classId)

static bool	IsRunningElement (ClassId classId)

static bool	IsScoreDefElement (ClassId classId)

static bool	IsSystemElement (ClassId classId)

static bool	IsTextElement (ClassId classId)

Static Public Member Functions inherited from vrv::BoundingBox
static std::pair< double, int >	ApproximateBezierExtrema (const Point bezier[4], bool isMaxExtrema, int approximationSteps=BEZIER_APPROXIMATION)

static double	CalcDistance (const Point &p1, const Point &p2)
	Calculate the euclidean distance between two points.

static bool	ArePointsClose (const Point &p1, const Point &p2, int margin)

static double	CalcSlope (const Point &p1, const Point &p2)
	Calculate the slope represented by two points.

static Point	CalcPositionAfterRotation (Point point, float alpha, Point center)
	Calculate the position of a point after a rotation of alpha (in radian) around the center.

static double	CalcBezierParamAtPosition (const Point bezier[4], int x)
	Calculate the t parameter of a bezier at position x.

static int	CalcBezierAtPosition (const Point bezier[4], int x)
	Calculate the y position of a bezier at position x.

static void	CalcLinearInterpolation (Point &dest, const Point &a, const Point &b, double t)
	Calculate linear interpolation between two points at time t.

static Point	CalcPointAtBezier (const Point bezier[4], double t)
	Calculate point (X,Y) coordinaties on the bezier curve.

static double	GetBezierThicknessCoefficient (const Point bezier[4], int currentThickness, int penWidth)
	Calculate thickness coefficient to be applient for bezier curve to fit MEI units thickness.

static Point	CalcDeCasteljau (const Point bezier[4], double t)
	Calculate the point bezier point position for a t between 0.0 and 1.0.

static void	CalcThickBezier (const Point bezier[4], int thickness, Point topBezier[4], Point bottomBezier[4])
	Calculate the position of the bezier above and below for a thick bezier.

static void	ApproximateBezierBoundingBox (const Point bezier[4], Point &pos, int &width, int &height, int &minYPos, int &maxYPos)
	Approximate the bounding box of a bezier taking into accound the height and the width.

static std::set< double >	SolveCubicPolynomial (double a, double b, double c, double d)
	Solve the cubic equation ax^3 + bx^2 + cx + d = 0 Returns up to three real roots.

static int	RectLeftOverlap (const Point rect1[2], const Point rect2[2], int margin, int vMargin)
	Calculate the left / right / top / bottom overlap of two rectangle taking into account the margin / v-h-Margins.

static int	RectRightOverlap (const Point rect1[2], const Point rect2[2], int margin, int vMargin)

static int	RectTopOverlap (const Point rect1[2], const Point rect2[2], int margin, int hMargin)

static int	RectBottomOverlap (const Point rect1[2], const Point rect2[2], int margin, int hMargin)

Public Attributes
ArrayOfStrAttr	m_unsupported
	Keep an array of unsupported attributes as pairs. More...

Additional Inherited Members
Protected Attributes inherited from vrv::BoundingBox
int	m_cachedDrawingX
	The cached version of the drawingX and drawingY values. More...

int	m_cachedDrawingY

Detailed Description

This class represents a basic object.

Member Typedef Documentation

◆ binaryComp

typedef bool(* vrv::Object::binaryComp) (Object *, Object *)

Sort children by a function that takes two arguments and returns true if the first argument is less than the second.

If the order of children changes, this returns true.

Constructor & Destructor Documentation

◆ Object()

vrv::Object::Object ( const Object & object )

Copy constructor that also copy the children.

The children are copied using the Object::Clone virtual method that needs to be overridden in the child class - otherwise, it will crash. Because this will create a problem if we don't check this (the parents will one the same child...) ID: the id is copied, it needs to be reset later if this is not wished

Member Function Documentation

◆ AddChild()

virtual void vrv::Object::AddChild ( Object * object )

virtual

Base method for adding children.

The method can be overridden.

Reimplemented in vrv::AlignmentReference, vrv::Note, vrv::Chord, vrv::Rest, vrv::TabDurSym, vrv::Tuplet, and vrv::Lb.

◆ ClearRelinquishedChildren()

void vrv::Object::ClearRelinquishedChildren ( )

Removes all the children that were previously relinquished.

This has to be used when children are moved but then the parent is not deleted.

◆ Clone()

virtual Object* vrv::Object::Clone ( ) const

virtual

Method call for copying child classes.

The method has to be overridden.

Reimplemented in vrv::Beam, vrv::ScoreDef, vrv::Staff, vrv::Flag, vrv::DivLineAttr, vrv::Note, vrv::Neume, vrv::Slur, vrv::KeySig, vrv::Measure, vrv::Rest, vrv::Chord, vrv::Nc, vrv::Clef, vrv::Layer, vrv::StaffGrp, vrv::Accid, vrv::StaffDef, vrv::BeamSpan, vrv::RunningElement, vrv::Syl, vrv::BarLine, vrv::SymbolTable, vrv::Mensur, vrv::MeterSig, vrv::Pedal, vrv::Trill, vrv::Dir, vrv::Dynam, vrv::Ending, vrv::KeyAccid, vrv::Rend, vrv::Tempo, vrv::Tuplet, vrv::Fermata, vrv::Harm, vrv::Mordent, vrv::MRest, vrv::MultiRest, vrv::RepeatMark, vrv::Turn, vrv::Arpeg, vrv::DivLine, vrv::Facsimile, vrv::Hairpin, vrv::MNum, vrv::Octave, vrv::Ornam, vrv::GrpSym, vrv::Reh, vrv::Artic, vrv::Caesura, vrv::Custos, vrv::Dots, vrv::Graphic, vrv::InstrDef, vrv::Surface, vrv::TabDurSym, vrv::Zone, vrv::BracketSpan, vrv::Gliss, vrv::Ligature, vrv::MeterSigGrp, vrv::Section, vrv::Tie, vrv::Verse, vrv::BTrem, vrv::Stem, vrv::CpMark, vrv::Expansion, vrv::HalfmRpt, vrv::MRpt, vrv::MRpt2, vrv::Syllable, vrv::AnchoredText, vrv::BeatRpt, vrv::Fing, vrv::FTrem, vrv::Mdiv, vrv::MultiRpt, vrv::Pb, vrv::Sb, vrv::Symbol, vrv::Breath, vrv::F, vrv::Num, vrv::Course, vrv::Fb, vrv::Fig, vrv::GenericLayerElement, vrv::Label, vrv::LabelAbbr, vrv::Lb, vrv::Liquescent, vrv::Oriscus, vrv::PitchInflection, vrv::Proport, vrv::Quilisma, vrv::Ref, vrv::Space, vrv::Subst, vrv::TabGrp, vrv::Text, vrv::Tuning, vrv::Dot, vrv::Lv, vrv::MSpace, vrv::Abbr, vrv::Add, vrv::App, vrv::Choice, vrv::Corr, vrv::Damage, vrv::Del, vrv::Expan, vrv::GraceGrp, vrv::Lem, vrv::Orig, vrv::Plica, vrv::Rdg, vrv::Reg, vrv::Restore, vrv::Sic, vrv::Supplied, vrv::Unclear, vrv::Phrase, and vrv::LayerDef.

◆ CloneReset()

virtual void vrv::Object::CloneReset ( )

virtual

Reset pointers after a copy and assignment constructor call.

This methods has to be called expicitly when overriden because it is not called from the constructors. Do not forget to call base-class equivalent whenever applicable (e.g., with more than one hierarchy level).

Reimplemented in vrv::Beam, vrv::Staff, vrv::LayerElement, vrv::Measure, and vrv::Layer.

◆ CopyAttributesTo()

void vrv::Object::CopyAttributesTo ( Object * target ) const

Copy all the attributes of an obejct to target.

The object must be of the same ClassId. Unsupported attrbutes are also copied.

◆ CopyChildren()

virtual bool vrv::Object::CopyChildren ( ) const

inlinevirtual

Indicate whereas children have to be copied in copy / assignment constructors.

This is true by default but can be overriden (e.g., for Staff, Layer)

Reimplemented in vrv::HorizontalAligner, and vrv::SystemAligner.

◆ DeleteChild()

bool vrv::Object::DeleteChild ( Object * child )

Remove and delete the child.

Return false if the child could not be found. In that case it will not be deleted.

◆ DeleteChildrenByComparison()

int vrv::Object::DeleteChildrenByComparison ( Comparison * comparison )

Delete the children that match the comparison.

Return the number of children deleted. Also mark the object as modified for invalidating the list.

◆ FillFlatList()

void vrv::Object::FillFlatList ( ListOfConstObjects & list ) const

Fill the list of all the children LayerElement.

This is used for navigating in a Layer (See Layer::GetPrevious and Layer::GetNext).

◆ FindAllDescendantsBetween()

void vrv::Object::FindAllDescendantsBetween	(	ListOfObjects *	objects,
		Comparison *	comparison,
		const Object *	start,
		const Object *	end,
		bool	clear = `true`,
		int	depth = `UNLIMITED_DEPTH`
	)

Return all the objects matching the Comparison functor and being between start and end in the tree.

The start and end objects are included in the result set.

◆ GetAttributes()

int vrv::Object::GetAttributes ( ArrayOfStrAttr * attributes ) const

Fill an array of pairs with all attributes and their values.

Return the number of attributes found.

◆ GetChildrenForModification()

ArrayOfObjects& vrv::Object::GetChildrenForModification ( )

inline

Return a reference to the children that allows modification.

This method should be all only in AddChild overrides methods

◆ GetFirstAncestor()

Object* vrv::Object::GetFirstAncestor	(	const ClassId	classId,
		int	maxSteps = `-1`
	)

Return the first ancestor of the specified type.

The maxSteps parameter limits the search to a certain number of level if not -1.

◆ GetInsertOrderFor()

virtual int vrv::Object::GetInsertOrderFor ( ClassId classId ) const

inlinevirtual

Return the child order for a the given ClassId.

By default, a child is added at the end, but a class can override the method to order them. The overriden method specifies a static vector with the expected order of ClassIds.

Reimplemented in vrv::ScoreDef, vrv::StaffGrp, and vrv::StaffDef.

◆ GetLastAncestorNot()

Object* vrv::Object::GetLastAncestorNot	(	const ClassId	classId,
		int	maxSteps = `-1`
	)

Return the last ancestor that is NOT of the specified type.

The maxSteps parameter limits the search to a certain number of level if not -1.

◆ HasDescendant()

bool vrv::Object::HasDescendant	(	const Object *	child,
		int	deepness = `UNLIMITED_DEPTH`
	)		const

Return true if the object has the child Object as descendant (reference of direct).

Processes in depth-first.

◆ IsSupportedChild()

virtual bool vrv::Object::IsSupportedChild ( ClassId classId )

virtual

Base method for checking if a child can be added.

The method has to be overridden.

Reimplemented in vrv::TimestampAligner, vrv::MeasureAligner, vrv::Beam, vrv::AlignmentReference, vrv::Staff, vrv::ScoreDef, vrv::Note, vrv::Measure, vrv::Alignment, vrv::Neume, vrv::Chord, vrv::KeySig, vrv::Syl, vrv::Dir, vrv::Dynam, vrv::Tempo, vrv::Harm, vrv::RepeatMark, vrv::Rest, vrv::CpMark, vrv::Layer, vrv::MNum, vrv::Ornam, vrv::Rend, vrv::Reh, vrv::TabDurSym, vrv::F, vrv::Custos, vrv::StaffGrp, vrv::Doc, vrv::Fing, vrv::EditorialElement, vrv::Nc, vrv::StaffDef, vrv::FTrem, vrv::System, vrv::Fig, vrv::AnchoredText, vrv::Tuplet, vrv::Ending, vrv::Ligature, vrv::Page, vrv::Score, vrv::TabGrp, vrv::Stem, vrv::MeterSigGrp, vrv::Verse, vrv::BTrem, vrv::Pages, vrv::Section, vrv::SystemAligner, vrv::Facsimile, vrv::Syllable, vrv::Mdiv, vrv::Subst, vrv::Annot, vrv::Surface, vrv::Symbol, vrv::Choice, vrv::Fb, vrv::Label, vrv::LabelAbbr, vrv::Num, vrv::App, vrv::Course, vrv::TextLayoutElement, vrv::Tuning, vrv::GraceGrp, vrv::SymbolDef, vrv::SymbolTable, and vrv::LayerDef.

◆ MoveChildrenFrom()

void vrv::Object::MoveChildrenFrom	(	Object *	sourceParent,
		int	idx = `-1`,
		bool	allowTypeChange = `false`
	)

Move all the children of the object passed as parameter to this one.

Objects must be of the same type. After this operation, the object passed as parameter has no child anymore. If idx is provided, move the children to the idx position in the object children. Only moving to the same type is allow unless allowTypeChange is true.

◆ MoveItselfTo()

void vrv::Object::MoveItselfTo ( Object * targetParent )

Move an object to another parent.

The object is relinquished from its current parent - see Object::Relinquish

◆ Process()

void vrv::Object::Process	(	Functor &	functor,
		int	deepness = `UNLIMITED_DEPTH`,
		bool	skipFirst = `false`
	)

Main method that processes functors.

For each object, it will call the functor. Depending on the code returned by the functor, it will also process it for all children. Deepness specifies how many child levels should be processed. UNLIMITED_DEPTH means no limit (EditorialElement objects do not count). skipFirst does not call the functor on the first (calling) level

◆ Relinquish()

Object* vrv::Object::Relinquish ( int idx )

Give up ownership of the child at the idx position (NULL if not found) This is a method to be used only in the very particular case where the child object cannot be detached straight away.

It is typically the case when this has to be done within an iterator. The parent of the object will be set to NULL but the object will not be removed. If the parent is not destroyed after that, you should expect problems unless Object::ClearRelinquishedChildren is called In other words: do not use unless you are absolutely sure what you are doing

◆ ReplaceChild()

void vrv::Object::ReplaceChild	(	Object *	currentChild,
		Object *	replacingChild
	)

Replace the currentChild with the replacingChild.

The currentChild is not deleted by the methods.

◆ ReplaceWithCopyOf()

void vrv::Object::ReplaceWithCopyOf ( Object * object )

Replace an object with a copy of the other.

They must be of the same class.

◆ Reset()

virtual void vrv::Object::Reset ( )

virtual

Reset the object, that is 1) removing all children and 2) resetting all attributes.

The method is virtual, so always call the parent in the method overriding it.

Reimplemented in vrv::TimestampAligner, vrv::GraceAligner, vrv::MeasureAligner, vrv::HorizontalAligner, vrv::AlignmentReference, vrv::TupletNum, vrv::TupletBracket, vrv::ScoreDef, vrv::Staff, vrv::Flag, vrv::PageRange, vrv::Alignment, vrv::Note, vrv::Neume, vrv::Slur, vrv::KeySig, vrv::Doc, vrv::LayerElement, vrv::Measure, vrv::Rest, vrv::SystemAligner, vrv::Nc, vrv::ScoreDefElement, vrv::Clef, vrv::StaffGrp, vrv::EditorialElement, vrv::Accid, vrv::Syl, vrv::BarLine, vrv::Mensur, vrv::MeterSig, vrv::Pedal, vrv::Trill, vrv::ControlElement, vrv::Dir, vrv::Dynam, vrv::KeyAccid, vrv::Rend, vrv::Tempo, vrv::Tuplet, vrv::Fermata, vrv::Harm, vrv::Mordent, vrv::MRest, vrv::MultiRest, vrv::RepeatMark, vrv::Turn, vrv::Arpeg, vrv::DivLine, vrv::Facsimile, vrv::Hairpin, vrv::MNum, vrv::Octave, vrv::Ornam, vrv::GrpSym, vrv::Page, vrv::Reh, vrv::Score, vrv::Artic, vrv::Caesura, vrv::Custos, vrv::Graphic, vrv::InstrDef, vrv::Surface, vrv::Zone, vrv::BracketSpan, vrv::FloatingObject, vrv::Gliss, vrv::Ligature, vrv::MeterSigGrp, vrv::RunningElement, vrv::Tie, vrv::Verse, vrv::BTrem, vrv::Pages, vrv::Stem, vrv::SystemMilestoneEnd, vrv::CpMark, vrv::Dots, vrv::Expansion, vrv::HalfmRpt, vrv::MRpt, vrv::MRpt2, vrv::Syllable, vrv::AnchoredText, vrv::BeatRpt, vrv::Fing, vrv::MultiRpt, vrv::PageElement, vrv::PageMilestoneEnd, vrv::Pb, vrv::Sb, vrv::Symbol, vrv::SystemElement, vrv::Annot, vrv::Breath, vrv::F, vrv::Num, vrv::Course, vrv::Div, vrv::Fb, vrv::Fig, vrv::GenericLayerElement, vrv::Label, vrv::LabelAbbr, vrv::Lb, vrv::Liquescent, vrv::Oriscus, vrv::PitchInflection, vrv::Proport, vrv::Quilisma, vrv::Ref, vrv::Space, vrv::Subst, vrv::TabGrp, vrv::Text, vrv::TextLayoutElement, vrv::Tuning, vrv::Dot, vrv::Lv, vrv::MSpace, vrv::TextElement, vrv::Choice, vrv::PgFoot, vrv::PgHead, vrv::Abbr, vrv::Add, vrv::App, vrv::Corr, vrv::Damage, vrv::Del, vrv::Expan, vrv::GraceGrp, vrv::Lem, vrv::Orig, vrv::Plica, vrv::Rdg, vrv::Reg, vrv::Restore, vrv::Sic, vrv::Supplied, vrv::Unclear, vrv::Phrase, vrv::Svg, vrv::SymbolDef, vrv::SymbolTable, vrv::LayerDef, and vrv::TimestampAttr.

◆ ResetParent()

void vrv::Object::ResetParent ( )

inline

Reset the parent of the Object.

The current parent is not expected to be NULL.

◆ RotateChildren()

void vrv::Object::RotateChildren	(	int	first,
		int	middle,
		int	last
	)

Rotates the child elements of the object leftwards, using std::rotate() with the given indices.

All elements from first (included) to last (not included) are rotated leftwards, with the element at middle becoming the new first element, see std::rotate() for more details.

◆ SetAsReferenceObject()

void vrv::Object::SetAsReferenceObject ( )

Make an object a reference object that do not own children.

This cannot be un-done and has to be set before any child is added.

◆ SetParent()

void vrv::Object::SetParent ( Object * parent )

Set the parent of the Object.

The current parent is expected to be NULL.

Member Data Documentation

◆ m_unsupported

ArrayOfStrAttr vrv::Object::m_unsupported

Keep an array of unsupported attributes as pairs.

This can be used for writing back data

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

object.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ binaryComp

Constructor & Destructor Documentation

◆ Object()

Member Function Documentation

◆ AddChild()

◆ ClearRelinquishedChildren()

◆ Clone()

◆ CloneReset()

◆ CopyAttributesTo()

◆ CopyChildren()

◆ DeleteChild()

◆ DeleteChildrenByComparison()

◆ FillFlatList()

◆ FindAllDescendantsBetween()

◆ GetAttributes()

◆ GetChildrenForModification()

◆ GetFirstAncestor()

◆ GetInsertOrderFor()

◆ GetLastAncestorNot()

◆ HasDescendant()

◆ IsSupportedChild()

◆ MoveChildrenFrom()

◆ MoveItselfTo()

◆ Process()

◆ Relinquish()

◆ ReplaceChild()

◆ ReplaceWithCopyOf()

◆ Reset()

◆ ResetParent()

◆ RotateChildren()

◆ SetAsReferenceObject()

◆ SetParent()

Member Data Documentation

◆ m_unsupported