Open 3D Engine AzQtComponents API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzQtComponents::VectorInput Class Reference

Qt Widget that control holds an array of VectorElements. This control can be used to display any number of labeled float values with configurable row(s) & column(s) More...

#include <VectorInput.h>

Inherits QWidget.

Public Slots

QWidget * GetFirstInTabOrder ()
 
QWidget * GetLastInTabOrder ()
 
void UpdateTabOrder ()
 

Signals

void valueChanged (double)
 
void valueAtIndexChanged (int elementIndex, double newValue)
 
void editingFinished ()
 

Public Member Functions

 VectorInput (QWidget *parent=nullptr, int elementCount=4, int elementsPerRow=-1, QString customLabels="")
 
void setLabel (int index, const QString &label)
 
void setLabelStyle (int index, const QString &qss)
 
VectorElement ** getElements ()
 
int getSize () const
 
void setValuebyIndex (double value, int index)
 
void setMinimum (double value)
 
void setMaximum (double value)
 
void setStep (double value)
 
void setDecimals (int value)
 
void setDisplayDecimals (int value)
 
void OnValueChangedInElement (double newValue, int elementIndex)
 
void setSuffix (const QString &suffix)
 

Detailed Description

Qt Widget that control holds an array of VectorElements. This control can be used to display any number of labeled float values with configurable row(s) & column(s)

Constructor & Destructor Documentation

◆ VectorInput()

AzQtComponents::VectorInput::VectorInput ( QWidget *  parent = nullptr,
int  elementCount = 4,
int  elementsPerRow = -1,
QString  customLabels = "" 
)
explicit

Configures and constructs a vector control

Parameters
parentThe Parent Qwidget
elementCountNumber of elements being managed by this vector control
elementsPerRowNumber of elements in every row
customLabelsA string that has custom labels that are use by the Vector elements

Member Function Documentation

◆ getElements()

VectorElement ** AzQtComponents::VectorInput::getElements ( )
inline

Fetches all elements being managed by this Vector control

Returns
An array of VectorElement*

◆ getSize()

int AzQtComponents::VectorInput::getSize ( ) const
inline

Fetches the count of elements being managed by this control

Returns
the number of elements being managed by this control

◆ setDecimals()

void AzQtComponents::VectorInput::setDecimals ( int  value)

Sets the number of decimals to to lock the spinboxes being managed by this control to

Parameters
valueDecimals value

◆ setDisplayDecimals()

void AzQtComponents::VectorInput::setDisplayDecimals ( int  value)

Sets the number of display decimals to truncate the spinboxes being managed by this control to

Parameters
valueDisplayDecimals value

◆ setLabel()

void AzQtComponents::VectorInput::setLabel ( int  index,
const QString &  label 
)

Sets the label on the indicated Vector element

Parameters
indexIndex of the element for which the label is to be set
labelNew label

◆ setLabelStyle()

void AzQtComponents::VectorInput::setLabelStyle ( int  index,
const QString &  qss 
)

Sets the style on the indicated Vector element

Parameters
indexIndex of the element for which the label is to be styled
qssThe Qt Style to be applied

◆ setMaximum()

void AzQtComponents::VectorInput::setMaximum ( double  value)

Sets the maximum value that all spinboxes being managed by this control can have

Parameters
valueMaximum value

◆ setMinimum()

void AzQtComponents::VectorInput::setMinimum ( double  value)

Sets the minimum value that all spinboxes being managed by this control can have

Parameters
valueMinimum value

◆ setStep()

void AzQtComponents::VectorInput::setStep ( double  value)

Sets the step value that all spinboxes being managed by this control can have

Parameters
valueStep value

◆ setSuffix()

void AzQtComponents::VectorInput::setSuffix ( const QString &  suffix)

Sets the suffix that is appended to values in spin boxes

Parameters
suffixSuffix to be used

◆ setValuebyIndex()

void AzQtComponents::VectorInput::setValuebyIndex ( double  value,
int  index 
)

Sets the value on the indicated Vector element

Parameters
valuethe new value
indexIndex of the element for which the value is to be set

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