VST 3 SDK  VST 3.6.14
SDK for developing VST Plug-in
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
NoteExpressionType Class Reference

Note expression type object. More...

#include <vstnoteexpressiontypes.h>

+ Inheritance diagram for NoteExpressionType:

Public Member Functions

 NoteExpressionType ()
 
 NoteExpressionType (const NoteExpressionTypeInfo &info)
 
 NoteExpressionType (NoteExpressionTypeID typeId, const TChar *title, const TChar *shortTitle, const TChar *units, int32 unitId, NoteExpressionValue defaultValue, NoteExpressionValue minimum, NoteExpressionValue maximum, int32 stepCount, int32 flags=0, int32 precision=4)
 
 NoteExpressionType (NoteExpressionTypeID typeId, const TChar *title, const TChar *shortTitle, const TChar *units, int32 unitId, Parameter *associatedParameter, int32 flags=0)
 
NoteExpressionTypeInfogetInfo ()
 get the underlying NoteExpressionTypeInfo struct More...
 
virtual tresult getStringByValue (NoteExpressionValue valueNormalized, String128 string)
 convert a note expression value to a readable string More...
 
virtual tresult getValueByString (const TChar *string, NoteExpressionValue &valueNormalized)
 convert a readable string to a note expression value More...
 
int32 getPrecision () const
 gets the current precision (used for string representation of float) More...
 
void setPrecision (int32 val)
 Sets the precision for string representation of float value (for example 4.34 with 2 as precision) More...
 
tresult getPhysicalUIType (PhysicalUITypeID &physicalUITypeID) const
 
tresult setPhysicalUITypeID (PhysicalUITypeID physicalUITypeID)
 

Public Attributes

OBJ_METHODS(NoteExpressionType,
FObject) protected IPtr
< Parameter
associatedParameter
 
int32 precision
 
PhysicalUITypeID physicalUITypeID {static_cast<PhysicalUITypeID> (kInvalidPUITypeID)}
 

Detailed Description

Note expression type object.

Constructor & Destructor Documentation

NoteExpressionType ( NoteExpressionTypeID  typeId,
const TChar title,
const TChar shortTitle,
const TChar units,
int32  unitId,
NoteExpressionValue  defaultValue,
NoteExpressionValue  minimum,
NoteExpressionValue  maximum,
int32  stepCount,
int32  flags = 0,
int32  precision = 4 
)
NoteExpressionType ( NoteExpressionTypeID  typeId,
const TChar title,
const TChar shortTitle,
const TChar units,
int32  unitId,
Parameter associatedParameter,
int32  flags = 0 
)

Member Function Documentation

NoteExpressionTypeInfo& getInfo ( )
inline

get the underlying NoteExpressionTypeInfo struct

tresult getStringByValue ( NoteExpressionValue  valueNormalized,
String128  string 
)
virtual

convert a note expression value to a readable string

Reimplemented in RangeNoteExpressionType.

tresult getValueByString ( const TChar string,
NoteExpressionValue valueNormalized 
)
virtual

convert a readable string to a note expression value

Reimplemented in RangeNoteExpressionType.

int32 getPrecision ( ) const
inline

gets the current precision (used for string representation of float)

void setPrecision ( int32  val)
inline

Sets the precision for string representation of float value (for example 4.34 with 2 as precision)

tresult getPhysicalUIType ( PhysicalUITypeID physicalUITypeID) const
tresult setPhysicalUITypeID ( PhysicalUITypeID  physicalUITypeID)

Member Data Documentation

OBJ_METHODS (NoteExpressionType, FObject) protected IPtr<Parameter> associatedParameter
int32 precision
PhysicalUITypeID physicalUITypeID {static_cast<PhysicalUITypeID> (kInvalidPUITypeID)}
Empty

Copyright ©2019 Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.