tSlider Struct Reference

Public Attributes
Scene *	scene
ScrArea *	area
ARegion *	region_header
void *	draw_handle
float	raw_factor
float	factor
float	last_cursor [2]
float	factor_bounds [2]
float	increment_step
SliderMode	slider_mode
std::string	property_label
char	unit_string [SLIDER_UNIT_STRING_SIZE]
bool	allow_overshoot_lower
bool	allow_overshoot_upper
bool	overshoot
bool	allow_increments
bool	increments
bool	precision

Detailed Description

Definition at line 62 of file ed_draw.cc.

Member Data Documentation

allow_increments

bool tSlider::allow_increments

Whether keeping CTRL pressed will snap to multiples of increment_step. Default is true. Set to false if the CTRL key is needed for other means.

Definition at line 109 of file ed_draw.cc.

Referenced by ED_slider_allow_increments_get(), ED_slider_allow_increments_set(), ED_slider_create(), ED_slider_modal(), ED_slider_status_get(), and ED_slider_status_string_get().

allow_overshoot_lower

bool tSlider::allow_overshoot_lower

Enable range beyond factor_bounds. This is set by the code that uses the slider, as not all operations support extrapolation.

Definition at line 100 of file ed_draw.cc.

Referenced by ED_slider_allow_overshoot_set(), ED_slider_create(), ED_slider_modal(), ED_slider_status_get(), ED_slider_status_string_get(), and slider_update_factor().

allow_overshoot_upper

bool tSlider::allow_overshoot_upper

Definition at line 101 of file ed_draw.cc.

Referenced by ED_slider_allow_overshoot_set(), ED_slider_create(), ED_slider_modal(), ED_slider_status_get(), ED_slider_status_string_get(), and slider_update_factor().

area

ScrArea* tSlider::area

Definition at line 64 of file ed_draw.cc.

Referenced by ED_slider_create(), and ED_slider_destroy().

draw_handle

void* tSlider::draw_handle

Draw callback handler.

Definition at line 70 of file ed_draw.cc.

Referenced by ED_slider_create(), and ED_slider_destroy().

factor

float tSlider::factor

Current value for determining the influence of whatever is relevant.

Definition at line 76 of file ed_draw.cc.

Referenced by ED_slider_create(), ED_slider_factor_get(), ED_slider_factor_set(), slider_draw(), and slider_update_factor().

factor_bounds

float tSlider::factor_bounds[2]

Range of the slider without overshoot.

Definition at line 82 of file ed_draw.cc.

Referenced by ED_slider_create(), ED_slider_factor_bounds_set(), ED_slider_factor_set(), slider_draw(), and slider_update_factor().

increment_step

float tSlider::increment_step

Change if the slider range is so large/small that a 0.1 increment is meaningless.

Definition at line 85 of file ed_draw.cc.

Referenced by ED_slider_create(), ED_slider_increment_step_set(), and slider_update_factor().

increments

bool tSlider::increments

Move factor in multiples of increment_step.

Definition at line 112 of file ed_draw.cc.

Referenced by ED_slider_modal(), ED_slider_status_get(), ED_slider_status_string_get(), and slider_update_factor().

last_cursor

float tSlider::last_cursor[2]

Last mouse cursor position used for mouse movement delta calculation.

Definition at line 79 of file ed_draw.cc.

Referenced by ED_slider_init(), and slider_update_factor().

overshoot

bool tSlider::overshoot

Allow overshoot or clamp between factor_bounds. This is set by the artist while using the slider.

Definition at line 105 of file ed_draw.cc.

Referenced by ED_slider_factor_set(), ED_slider_modal(), ED_slider_status_get(), ED_slider_status_string_get(), slider_draw(), and slider_update_factor().

precision

bool tSlider::precision

Reduces factor delta from mouse movement.

Definition at line 115 of file ed_draw.cc.

Referenced by ED_slider_modal(), ED_slider_status_get(), ED_slider_status_string_get(), and slider_update_factor().

property_label

std::string tSlider::property_label

Definition at line 92 of file ed_draw.cc.

Referenced by ED_slider_property_label_set(), and slider_draw().

raw_factor

float tSlider::raw_factor

Accumulative factor (not clamped or rounded).

Definition at line 73 of file ed_draw.cc.

Referenced by ED_slider_create(), ED_slider_factor_set(), and slider_update_factor().

region_header

ARegion* tSlider::region_header

Header of the region used for drawing the slider.

Definition at line 67 of file ed_draw.cc.

Referenced by ED_slider_create(), ED_slider_destroy(), ED_slider_modal(), and slider_draw().

scene

Scene* tSlider::scene

Definition at line 63 of file ed_draw.cc.

Referenced by ED_slider_create().

slider_mode

SliderMode tSlider::slider_mode

Definition at line 88 of file ed_draw.cc.

Referenced by ED_slider_create(), ED_slider_mode_get(), ED_slider_mode_set(), and slider_draw().

unit_string

char tSlider::unit_string[SLIDER_UNIT_STRING_SIZE]

Definition at line 95 of file ed_draw.cc.

Referenced by ED_slider_create(), ED_slider_unit_set(), and slider_draw().

---

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

• ed_draw.cc