MUSX Document Model
Loading...
Searching...
No Matches
musx::dom::others::SmartShape::EndPointAdjustment Class Reference

Represents the endpoint adjustment of the smart shape. More...

#include <SmartShape.h>

+ Inheritance diagram for musx::dom::others::SmartShape::EndPointAdjustment:

Public Member Functions

 EndPointAdjustment (const DocumentWeakPtr &document)
 Constructor function.
 
bool requireAllFields () const override
 ignore other fields because they are difficult to figure out
 
- Public Member Functions inherited from musx::dom::Base
virtual ~Base () noexcept(false)=default
 Virtual destructor for polymorphic behavior.
 
DocumentPtr getDocument () const
 Gets a reference to the Document.
 
Cmper getPartId () const
 Gets the partId for this instance (or 0 for score)
 
std::shared_ptr< others::PartDefinitiongetPartDefinition () const
 Gets the others::PartDefinition corresponding to getPartId.
 
ShareMode getShareMode () const
 Gets the sharing mode for this instance.
 
const SharedNodesgetUnlinkedNodes () const
 Gets the unlinked nodes for this instance. (Only populated for ShareMode::Partial)
 
void addUnlinkedNode (const std::string &nodeName)
 Adds a shared node for this instance.
 
virtual void integrityCheck ()
 Allows a class to determine if it has been properly contructed by the factory and fix issues that it can, such as creating default instances of contained classes.
 

Static Public Member Functions

static const xml::XmlElementArray< EndPointAdjustment > & xmlMappingArray ()
 Required for musx::factory::FieldPopulator.
 

Public Attributes

Evpu horzOffset {}
 Horizontal offset (xml node is <x>)
 
Evpu vertOffset {}
 Vertical offset (xml node is <y>)
 
bool active {}
 If true, this adjustment should be used when it is applicable (xml node is <on>)
 

Additional Inherited Members

- Public Types inherited from musx::dom::Base
enum class  ShareMode { All , Partial , None }
 Describes how this instance is shared between part and score. More...
 
using SharedNodes = std::set< std::string >
 The container type for shared nodes.
 
- Protected Member Functions inherited from musx::dom::Base
 Base (const DocumentWeakPtr &document, Cmper partId, ShareMode shareMode)
 Constructs the base class and enforces the static constexpr XmlNodeName.
 
Baseoperator= (const Base &)
 assignment constructor: m_unlinkedNodes is intentionally omitted
 

Detailed Description

Represents the endpoint adjustment of the smart shape.

Member Function Documentation

◆ requireAllFields()

bool musx::dom::others::SmartShape::EndPointAdjustment::requireAllFields ( ) const
inlineoverridevirtual

ignore other fields because they are difficult to figure out

Reimplemented from musx::dom::Base.