VST 3 SDK VST 3.7
SDK for developing VST plug-in
Loading...
Searching...
No Matches
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
 
virtual tresult getStringByValue (NoteExpressionValue valueNormalized, String128 string)
 convert a note expression value to a readable string
 
virtual tresult getValueByString (const TChar *string, NoteExpressionValue &valueNormalized)
 convert a readable string to a note expression value
 
int32 getPrecision () const
 gets the current precision (used for string representation of float)
 
void setPrecision (int32 val)
 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)
 

Public Attributes

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

Detailed Description

Note expression type object.

Constructor & Destructor Documentation

◆ NoteExpressionType() [1/4]

◆ NoteExpressionType() [2/4]

◆ NoteExpressionType() [3/4]

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() [4/4]

NoteExpressionType ( NoteExpressionTypeID typeId,
const TChar * title,
const TChar * shortTitle,
const TChar * units,
int32 unitId,
Parameter * associatedParameter,
int32 flags = 0 )

Member Function Documentation

◆ getInfo()

NoteExpressionTypeInfo & getInfo ( )
inline

get the underlying NoteExpressionTypeInfo struct

◆ getStringByValue()

tresult getStringByValue ( NoteExpressionValue valueNormalized,
String128 string )
virtual

convert a note expression value to a readable string

Reimplemented in RangeNoteExpressionType.

◆ getValueByString()

tresult getValueByString ( const TChar * string,
NoteExpressionValue & valueNormalized )
virtual

convert a readable string to a note expression value

Reimplemented in RangeNoteExpressionType.

◆ getPrecision()

int32 getPrecision ( ) const
inline

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

◆ setPrecision()

void setPrecision ( int32 val)
inline

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

◆ getPhysicalUIType()

tresult getPhysicalUIType ( PhysicalUITypeID & physicalUITypeID) const

◆ setPhysicalUITypeID()

tresult setPhysicalUITypeID ( PhysicalUITypeID physicalUITypeID)

Member Data Documentation

◆ associatedParameter

OBJ_METHODS (NoteExpressionType, FObject) protected IPtr<Parameter> associatedParameter

◆ precision

int32 precision

◆ physicalUITypeID

PhysicalUITypeID physicalUITypeID {static_cast<PhysicalUITypeID> (kInvalidPUITypeID)}
Empty

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