Anklang 0.3.0-460-gc4ef46ba
ASE — Anklang Sound Engine (C++)

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Ase::ClapPropertyImpl Struct Reference
Inheritance diagram for Ase::ClapPropertyImpl:
[legend]

Public Member Functions

String ident () const override
 Unique name (per owner) of this Property.
 
String label () const override
 Preferred user interface name.
 
String nick () const override
 Abbreviated user interface name, usually not more than 6 characters.
 
String unit () const override
 Units of the values within range.
 
double get_min () const override
 Get the minimum property value, converted to double.
 
double get_max () const override
 Get the maximum property value, converted to double.
 
double get_step () const override
 Get the property value stepping, converted to double.
 
bool is_numeric () const override
 Whether the property settings can be represented as a floating point number.
 
bool is_stepped () const
 
void reset () override
 Assign default as normalized property value.
 
 ClapPropertyImpl (ClapDeviceImplP device, const ClapParamInfo info)
 
ChoiceS choices () const override
 Enumerate choices for choosable properties.
 
StringS get_metadata () const override
 
double get_normalized () const override
 Get the normalized property value, converted to double.
 
bool set_normalized (double v) override
 Set the normalized property value as double.
 
String get_text () const override
 Get the current property value, converted to a text String.
 
bool set_text (String vstr) override
 Set the current property value as a text String.
 
Value get_value () const override
 Get the native property value.
 
bool set_value (const Value &val) override
 Set the native property value.
 
- Public Member Functions inherited from Ase::Property
virtual String get_name () const
 
virtual void set_name (const String &n)
 
virtual void set_metadata (const StringS &md)
 
String hints () const
 Hints for parameter handling (metadata).
 
String blurb () const
 Short description for user interface tooltips (metadata).
 
String descr () const
 Elaborate description, e.g. for help dialogs (metadata).
 
String group () const
 Group name for parameters of similar function (metadata).
 
- Public Member Functions inherited from Ase::Emittable
void js_trigger (const String &eventselector, JsTrigger callback)
 
- Public Member Functions inherited from std::enable_shared_from_this< SharedBase >
enable_shared_from_this (T... args)
 
operator= (T... args)
 
shared_from_this (T... args)
 
weak_from_this (T... args)
 
~enable_shared_from_this (T... args)
 
- Public Member Functions inherited from Ase::EmittableImpl
ASE_USE_RESULT Connection on_event (const String &eventselector, const EventHandler &eventhandler) override
 
void emit_event (const String &type, const String &detail, const ValueR fields={}) override
 
void emit_notify (const String &detail) override
 Emit notify:detail, multiple notifications maybe coalesced if a CoalesceNotifies instance exists.
 

Public Attributes

ClapDeviceImplP device_
 
clap_id param_id
 
uint32_t flags
 
String ident_
 
String label_
 
String module_
 
double min_value
 
double max_value
 
double default_value
 
- Public Attributes inherited from Ase::Property
Member<&Property::get_name,&Property::set_name > name
 
Member<&Property::get_value,&Property::set_valuevalue
 
Member<&Property::get_metadata,&Property::set_metadata > metadata
 
- Public Attributes inherited from Ase::Emittable
const EventHandlereventhandler
 

Detailed Description

Definition at line 16 of file clapdevice.cc.

Constructor & Destructor Documentation

◆ ClapPropertyImpl()

Ase::ClapPropertyImpl::ClapPropertyImpl ( ClapDeviceImplP  device,
const ClapParamInfo  info 
)

Definition at line 33 of file clapdevice.cc.

Member Function Documentation

◆ choices()

ChoiceS Ase::ClapPropertyImpl::choices ( ) const
overridevirtual

Enumerate choices for choosable properties.

Implements Ase::Property.

Definition at line 46 of file clapdevice.cc.

References choices(), get_max(), get_min(), ident(), return_unless, and Ase::string_format().

Referenced by choices().

◆ get_max()

double Ase::ClapPropertyImpl::get_max ( ) const
overridevirtual

Get the maximum property value, converted to double.

Implements Ase::Property.

Definition at line 28 of file clapdevice.cc.

Referenced by choices(), get_normalized(), and set_normalized().

◆ get_metadata()

StringS Ase::ClapPropertyImpl::get_metadata ( ) const
overridevirtual

Implements Ase::Property.

Definition at line 60 of file clapdevice.cc.

◆ get_min()

double Ase::ClapPropertyImpl::get_min ( ) const
overridevirtual

Get the minimum property value, converted to double.

Implements Ase::Property.

Definition at line 27 of file clapdevice.cc.

Referenced by choices(), get_normalized(), and set_normalized().

◆ get_normalized()

double Ase::ClapPropertyImpl::get_normalized ( ) const
overridevirtual

Get the normalized property value, converted to double.

Implements Ase::Property.

Definition at line 69 of file clapdevice.cc.

References Ase::Value::as_double(), get_max(), get_min(), and get_value().

◆ get_step()

double Ase::ClapPropertyImpl::get_step ( ) const
overridevirtual

Get the property value stepping, converted to double.

Implements Ase::Property.

Definition at line 29 of file clapdevice.cc.

◆ get_text()

String Ase::ClapPropertyImpl::get_text ( ) const
overridevirtual

Get the current property value, converted to a text String.

Implements Ase::Property.

Definition at line 83 of file clapdevice.cc.

◆ get_value()

Value Ase::ClapPropertyImpl::get_value ( ) const
overridevirtual

Get the native property value.

Implements Ase::Property.

Definition at line 95 of file clapdevice.cc.

Referenced by get_normalized().

◆ ident()

String Ase::ClapPropertyImpl::ident ( ) const
overridevirtual

Unique name (per owner) of this Property.

Implements Ase::Property.

Definition at line 23 of file clapdevice.cc.

Referenced by choices().

◆ is_numeric()

bool Ase::ClapPropertyImpl::is_numeric ( ) const
overridevirtual

Whether the property settings can be represented as a floating point number.

Implements Ase::Property.

Definition at line 30 of file clapdevice.cc.

◆ is_stepped()

bool Ase::ClapPropertyImpl::is_stepped ( ) const

Definition at line 31 of file clapdevice.cc.

◆ label()

String Ase::ClapPropertyImpl::label ( ) const
overridevirtual

Preferred user interface name.

Implements Ase::Property.

Definition at line 24 of file clapdevice.cc.

◆ nick()

String Ase::ClapPropertyImpl::nick ( ) const
overridevirtual

Abbreviated user interface name, usually not more than 6 characters.

Implements Ase::Property.

Definition at line 25 of file clapdevice.cc.

References Ase::parameter_guess_nick().

◆ reset()

void Ase::ClapPropertyImpl::reset ( )
overridevirtual

Assign default as normalized property value.

Implements Ase::Property.

Definition at line 32 of file clapdevice.cc.

References set_value().

◆ set_normalized()

bool Ase::ClapPropertyImpl::set_normalized ( double  v)
overridevirtual

Set the normalized property value as double.

Implements Ase::Property.

Definition at line 76 of file clapdevice.cc.

References get_max(), get_min(), and set_value().

◆ set_text()

bool Ase::ClapPropertyImpl::set_text ( String  v)
overridevirtual

Set the current property value as a text String.

Implements Ase::Property.

Definition at line 90 of file clapdevice.cc.

◆ set_value()

bool Ase::ClapPropertyImpl::set_value ( const Value v)
overridevirtual

Set the native property value.

Implements Ase::Property.

Definition at line 100 of file clapdevice.cc.

References Ase::Value::as_double().

Referenced by reset(), and set_normalized().

◆ unit()

String Ase::ClapPropertyImpl::unit ( ) const
overridevirtual

Units of the values within range.

Implements Ase::Property.

Definition at line 26 of file clapdevice.cc.

Member Data Documentation

◆ default_value

double Ase::ClapPropertyImpl::default_value

Definition at line 21 of file clapdevice.cc.

◆ device_

ClapDeviceImplP Ase::ClapPropertyImpl::device_

Definition at line 17 of file clapdevice.cc.

◆ flags

uint32_t Ase::ClapPropertyImpl::flags

Definition at line 19 of file clapdevice.cc.

◆ ident_

String Ase::ClapPropertyImpl::ident_

Definition at line 20 of file clapdevice.cc.

◆ label_

String Ase::ClapPropertyImpl::label_

Definition at line 20 of file clapdevice.cc.

◆ max_value

double Ase::ClapPropertyImpl::max_value

Definition at line 21 of file clapdevice.cc.

◆ min_value

double Ase::ClapPropertyImpl::min_value

Definition at line 21 of file clapdevice.cc.

◆ module_

String Ase::ClapPropertyImpl::module_

Definition at line 20 of file clapdevice.cc.

◆ param_id

clap_id Ase::ClapPropertyImpl::param_id

Definition at line 18 of file clapdevice.cc.


The documentation for this struct was generated from the following file: