All Classes Namespaces Functions Variables Enumerations Enumerator Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
FileNamePartComponent Class Reference

Inherits Component, LabelListener, and ButtonListener.

Public Types

enum  TokenProperties
 
enum  Datatype
 

Public Member Functions

void fillDataWithTokenInformation (SampleImporter::SampleCollection &collection, int index, const String &currentToken)
 
XmlElement * exportSettings ()
 
void importSettings (XmlElement &p)
 

Static Public Member Functions

static String getSpecialPropertyName (TokenProperties p)
 
static String getDataTypeName (Datatype d)
 

Detailed Description

[Comments]

@see FileNameImporterDialog

Member Enumeration Documentation

enum Datatype

Specifies the type of data which this token contains.

Enumerator
Number 

a simple integer number that can be directly read without further processing.

NumberWithRange 

use this for numbers that indicate a range and supply the upper limit into the item list.

NumericRange 

a range in the format '1-63'

NoteName 

if the token is a note name (format: "D#3"), use this data type to get the right midi note number (middle octave is 3).

Custom 

if the token is a custom string, use this data type and fill in all possible items into the item list (with a space separator) and all values (as integer) into the value list.

FixedValue 

discard all information and directly set a value to the fixed number that is entered into the item list.

Ignored 

ignores the token. You should not have to use this directly, as it's the datatype for ignored tokens.

A selection of useful properties that can be set via the filename token.

Enumerator
VelocityLowHigh 

Velocity Low & High + 1: maps the value to both ModulatorSamplerSound::VeloLow and ModulatorSamplerSound::VeloHigh (+1). Use SampleImporter::fillGaps() after this.

VelocityRange 

Use this with 'NumericRange' for velocity information like '63-127'.

VelocitySpread 

Spread Velocity to complete range: spreads the velocity evenly to the complete Range. Use the data type number and enter the upper limit into the item list or use the custom data type and enter the values '1 ... numItems'.

LowVelocity 

the lower velocity limit

HighVelocity 

the upper velocity limit

SingleKey 

Set to single Key: maps the value to RootNote, KeyLow and KeyHigh. SampleImporter::fillGaps might come in handy after this.

Group 

RRGroup: moves the sound into the specified group.

Ignore 

Do nothing with this token. Use this for every token that does not contain special information (it is the default value anyway).

Member Function Documentation

XmlElement* exportSettings ( )
inline

writes all settings into an xml element which can be stored to save time.

void fillDataWithTokenInformation ( SampleImporter::SampleCollection &  collection,
int  index,
const String &  currentToken 
)
inline

extracts the data from the token and writes it into the supplied SamplerSoundBasicData object.

static String getDataTypeName ( Datatype  d)
inlinestatic

Returns the Identifier for all TokenProperties. This is used for saving.

static String getSpecialPropertyName ( TokenProperties  p)
inlinestatic

Returns the name for all TokenProperties.

void importSettings ( XmlElement &  p)

imports the settings from the supplied XmlElement.

©2017 HISE. This documentation is autogenerated from the HISE source code using Doxygen.