openpine::inputs::InputFloat Class Reference

Wrapper for a float script input. More...

#include <input_float.hpp>

Public Member Functions
	InputFloat (const ffi::InputFloat &data, const ffi::Input *input=nullptr)
	Constructs from FFI data and optional handle for optionAt().
int64_t	id () const
	Input ID.
double	defaultValue () const
	Default value.
std::optional< std::string_view >	title () const
	Optional title.
std::optional< std::string_view >	tooltip () const
	Optional tooltip.
std::optional< std::string_view >	inlineGroup () const
	Optional inline group name.
std::optional< std::string_view >	group () const
	Optional group name.
uint64_t	display () const
	Display bitmask.
bool	active () const
	Whether the input is active.
bool	hasOptions () const
	Whether options are present.
uintptr_t	optionsLength () const
	Number of options (for optionAt()).
std::optional< double >	minValue () const
	Optional minimum value.
std::optional< double >	maxValue () const
	Optional maximum value.
std::optional< double >	step () const
	Optional step.
bool	confirm () const
	Whether the input requires confirmation.
std::optional< double >	optionAt (uintptr_t index) const
	Option value at the given index.

Friends
class	openpine::ScriptInput

Detailed Description

Wrapper for a float script input.

String views are valid only while the ScriptInfo/Instance is alive.

Definition at line 27 of file input_float.hpp.

Constructor & Destructor Documentation

InputFloat()

openpine::inputs::InputFloat::InputFloat ( const ffi::InputFloat & data, const ffi::Input * input = nullptr )

inline

Constructs from FFI data and optional handle for optionAt().

Definition at line 30 of file input_float.hpp.

Member Function Documentation

active()

bool openpine::inputs::InputFloat::active ( ) const

inline

Whether the input is active.

Definition at line 55 of file input_float.hpp.

confirm()

bool openpine::inputs::InputFloat::confirm ( ) const

inline

Whether the input requires confirmation.

Definition at line 73 of file input_float.hpp.

defaultValue()

double openpine::inputs::InputFloat::defaultValue ( ) const

inline

Default value.

Definition at line 35 of file input_float.hpp.

display()

uint64_t openpine::inputs::InputFloat::display ( ) const

inline

Display bitmask.

Definition at line 53 of file input_float.hpp.

group()

std::optional< std::string_view > openpine::inputs::InputFloat::group ( ) const

inline

Optional group name.

Definition at line 49 of file input_float.hpp.

References openpine::detail::optRefToView().

hasOptions()

bool openpine::inputs::InputFloat::hasOptions ( ) const

inline

Whether options are present.

Definition at line 57 of file input_float.hpp.

id()

int64_t openpine::inputs::InputFloat::id ( ) const

inline

Input ID.

Definition at line 33 of file input_float.hpp.

inlineGroup()

std::optional< std::string_view > openpine::inputs::InputFloat::inlineGroup ( ) const

inline

Optional inline group name.

Definition at line 45 of file input_float.hpp.

References openpine::detail::optRefToView().

maxValue()

std::optional< double > openpine::inputs::InputFloat::maxValue ( ) const

inline

Optional maximum value.

Definition at line 65 of file input_float.hpp.

minValue()

std::optional< double > openpine::inputs::InputFloat::minValue ( ) const

inline

Optional minimum value.

Definition at line 61 of file input_float.hpp.

optionAt()

std::optional< double > openpine::inputs::InputFloat::optionAt ( uintptr_t index ) const

inline

Option value at the given index.

Parameters

index

Zero-based option index (must be < optionsLength()).

Returns

The option value, or std::nullopt if out of range or not available.

Definition at line 80 of file input_float.hpp.

optionsLength()

uintptr_t openpine::inputs::InputFloat::optionsLength ( ) const

inline

Number of options (for optionAt()).

Definition at line 59 of file input_float.hpp.

step()

std::optional< double > openpine::inputs::InputFloat::step ( ) const

inline

Optional step.

Definition at line 69 of file input_float.hpp.

title()

std::optional< std::string_view > openpine::inputs::InputFloat::title ( ) const

inline

Optional title.

Definition at line 37 of file input_float.hpp.

References openpine::detail::optRefToView().

tooltip()

std::optional< std::string_view > openpine::inputs::InputFloat::tooltip ( ) const

inline

Optional tooltip.

Definition at line 41 of file input_float.hpp.

References openpine::detail::optRefToView().

Friends And Related Symbol Documentation

openpine::ScriptInput

friend class openpine::ScriptInput

friend

Definition at line 90 of file input_float.hpp.

---

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

• cpp/include/inputs/input_float.hpp