A label layout defined a label's appearance including, for instance, the padding around the test and the foreground and background colors.
More...
#include <ilabel.h>
Inherits mi::base::Interface_declare< 0x408633d3, ... >.
|
| virtual void | set_padding (mi::Float32 padding)=0 |
| | Set the padding around the label text. More...
|
| |
| virtual mi::Float32 | get_padding () const =0 |
| | Get the padding around the label text. More...
|
| |
| virtual void | set_auto_flip (bool auto_flip)=0 |
| | Set/Clear the auto flip mode. More...
|
| |
| virtual bool | get_auto_flip () const =0 |
| | Returns the state of the auto flip mode. More...
|
| |
| virtual void | get_color (mi::math::Color_struct &foreground, mi::math::Color_struct &background) const =0 |
| | A label defines it foreground color, i.e., the color of the text shown on the label, and its background color, i.e., the color that surrounds the label. More...
|
| |
| virtual void | set_color (const mi::math::Color_struct &foreground, const mi::math::Color_struct &background)=0 |
| | A label defines it foreground color, i.e., the color of the text shown on the label, and its background color, i.e., the color that surrounds the label. More...
|
| |
A label layout defined a label's appearance including, for instance, the padding around the test and the foreground and background colors.
◆ get_auto_flip()
| virtual bool nv::index::ILabel_layout::get_auto_flip |
( |
| ) |
const |
|
pure virtual |
Returns the state of the auto flip mode.
When setting auto flip mode the text of the label will be flip when seen from back face so it always read from left to right.
- Returns
- the state of the auto flip mode.
◆ get_color()
| virtual void nv::index::ILabel_layout::get_color |
( |
mi::math::Color_struct & |
foreground, |
|
|
mi::math::Color_struct & |
background |
|
) |
| const |
|
pure virtual |
A label defines it foreground color, i.e., the color of the text shown on the label, and its background color, i.e., the color that surrounds the label.
- Parameters
-
| [out] | foreground | Returns the foreground color. |
| [out] | background | Returns the background color. |
◆ get_padding()
| virtual mi::Float32 nv::index::ILabel_layout::get_padding |
( |
| ) |
const |
|
pure virtual |
Get the padding around the label text.
- Returns
- The padding in label space.
◆ set_auto_flip()
| virtual void nv::index::ILabel_layout::set_auto_flip |
( |
bool |
auto_flip | ) |
|
|
pure virtual |
Set/Clear the auto flip mode.
When setting auto flip mode the text of the label will be flip when seen from back face so it always read from left to right.
- Parameters
-
| [in] | auto_flip | set to true/false to enable/disable auto flip mode. |
◆ set_color()
| virtual void nv::index::ILabel_layout::set_color |
( |
const mi::math::Color_struct & |
foreground, |
|
|
const mi::math::Color_struct & |
background |
|
) |
| |
|
pure virtual |
A label defines it foreground color, i.e., the color of the text shown on the label, and its background color, i.e., the color that surrounds the label.
- Parameters
-
| [in] | foreground | The foreground color. |
| [in] | background | The background color. |
◆ set_padding()
| virtual void nv::index::ILabel_layout::set_padding |
( |
mi::Float32 |
padding | ) |
|
|
pure virtual |
Set the padding around the label text.
- Parameters
-
| [in] | padding | The padding in label space. The size is interpreted by in which space the label defined. |
The documentation for this class was generated from the following file:
