MUSX Document Model
Loading...
Searching...
No Matches
musx::dom::percussion::PercussionNoteType Struct Reference

Represents a percussion note type mapping entry. More...

#include <PercussionNoteType.h>

Public Member Functions

std::string createName (unsigned orderId) const
 Creates the human-readable name.
 

Public Attributes

int instrumentId
 Unique ID for this percussion note type.
 
int parentInstrumentId
 ID of the parent percussion instrument.
 
std::string rawName
 Raw name of the note type. May need to be massaged with group and order id.
 
int defaultStaffPos
 Default staff position for this note type, where 0 is the middle-C position of treble clef and up is positive.
 
int generalMidi
 General MIDI percussion mapping number or -1 if none.
 
int groupId
 Group ID for note type grouping in Finale UI.
 
int copies
 Number of copies defined for this note type.
 
bool copyGroup
 Whether this note type copies its group's attributes.
 

Detailed Description

Represents a percussion note type mapping entry.

Contains fields parsed from Finale's PercNoteTypes.txt CSV, including identification, display, and grouping information.

Member Function Documentation

◆ createName()

std::string musx::dom::percussion::PercussionNoteType::createName ( unsigned  orderId) const

Creates the human-readable name.

Parameters
orderIdThe order Id that distinguishes which version of the instrument it is (taken from the top four bits of PercussionNoteTypeId)
Returns
The human-readable name in uf8 encoding.