VST 3 SDK VST 3.7
SDK for developing VST plug-in
RangeNoteExpressionType Class Reference

Note expression type object representing a custom range. More...

#include <vstnoteexpressiontypes.h>

+ Inheritance diagram for RangeNoteExpressionType:

Public Member Functions

 RangeNoteExpressionType (NoteExpressionTypeID typeId, const TChar *title, const TChar *shortTitle, const TChar *units, int32 unitId, NoteExpressionValue defaultPlainValue, NoteExpressionValue plainMin, NoteExpressionValue plainMax, int32 flags=0, int32 precision=4)
 
virtual ParamValue getMin () const
 Gets the minimum plain value. More...
 
virtual void setMin (ParamValue value)
 Sets the minimum plain value. More...
 
virtual ParamValue getMax () const
 Gets the maximum plain value. More...
 
virtual void setMax (ParamValue value)
 Sets the maximum plain value. More...
 
tresult getStringByValue (NoteExpressionValue valueNormalized, String128 string) SMTG_OVERRIDE
 
tresult getValueByString (const TChar *string, NoteExpressionValue &valueNormalized) SMTG_OVERRIDE
 
- Public Member Functions inherited from NoteExpressionType
 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(RangeNoteExpressionType, NoteExpressionType) protected NoteExpressionValue plainMax
 
- Public Attributes inherited from NoteExpressionType
OBJ_METHODS(NoteExpressionType, FObject) protected IPtr< ParameterassociatedParameter
 
int32 precision
 
PhysicalUITypeID physicalUITypeID {static_cast<PhysicalUITypeID> (kInvalidPUITypeID)}
 

Detailed Description

Note expression type object representing a custom range.

Constructor & Destructor Documentation

◆ RangeNoteExpressionType()

RangeNoteExpressionType ( NoteExpressionTypeID  typeId,
const TChar title,
const TChar shortTitle,
const TChar units,
int32  unitId,
NoteExpressionValue  defaultPlainValue,
NoteExpressionValue  plainMin,
NoteExpressionValue  plainMax,
int32  flags = 0,
int32  precision = 4 
)

Member Function Documentation

◆ getMin()

virtual ParamValue getMin ( ) const
inlinevirtual

Gets the minimum plain value.

◆ setMin()

virtual void setMin ( ParamValue  value)
inlinevirtual

Sets the minimum plain value.

◆ getMax()

virtual ParamValue getMax ( ) const
inlinevirtual

Gets the maximum plain value.

◆ setMax()

virtual void setMax ( ParamValue  value)
inlinevirtual

Sets the maximum plain value.

◆ getStringByValue()

tresult getStringByValue ( NoteExpressionValue  valueNormalized,
String128  string 
)
virtual

Reimplemented from NoteExpressionType.

◆ getValueByString()

tresult getValueByString ( const TChar string,
NoteExpressionValue valueNormalized 
)
virtual

Reimplemented from NoteExpressionType.

Member Data Documentation

◆ plainMax

Empty

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