Bounds< T > Struct Template Reference

#include <BLI_bounds_types.hh>

Public Member Functions
	Bounds ()=default
	Bounds (const T &value)
	Bounds (const T &min, const T &max)
bool	is_empty () const
T	center () const
T	size () const
void	translate (const T &offset)
void	scale_from_center (const T &scale)
void	resize (const T &new_size)
void	recenter (const T &new_center)
template<typename PaddingT>
void	pad (const PaddingT &padding)

Public Attributes
T	min
T	max

Detailed Description

template<typename T>
struct Bounds< T >

Definition at line 13 of file BLI_bounds_types.hh.

Constructor & Destructor Documentation

Bounds() [1/3]

template<typename T>

blender::Bounds< T >::Bounds ( )

default

Bounds() [2/3]

template<typename T>

blender::Bounds< T >::Bounds ( const T & value )

inline

Definition at line 17 of file BLI_bounds_types.hh.

Bounds() [3/3]

template<typename T>

blender::Bounds< T >::Bounds ( const T & min, const T & max )

inline

Definition at line 18 of file BLI_bounds_types.hh.

Member Function Documentation

center()

template<typename T>

T blender::Bounds< T >::center ( ) const

inline

Return the center (i.e. the midpoint) of the bounds. This matches the behavior of #BLI_rctf_cent/#BLI_rcti_cent.

Definition at line 270 of file BLI_bounds.hh.

is_empty()

template<typename T>

bool blender::Bounds< T >::is_empty ( ) const

inline

Returns true when the size of the bounds is zero (or negative). This matches the behavior of BLI_rcti_is_empty/BLI_rctf_is_empty.

Definition at line 260 of file BLI_bounds.hh.

pad()

template<typename T>

template<typename PaddingT>

void blender::Bounds< T >::pad ( const PaddingT & padding )

inline

Adds some padding to the bounds. This matches the behavior of BLI_rcti_pad/BLI_rctf_pad.

Definition at line 308 of file BLI_bounds.hh.

recenter()

template<typename T>

void blender::Bounds< T >::recenter ( const T & new_center )

inline

Translate the bounds such that their center is #new_center. This matches the behavior of BLI_rctf_recenter/BLI_rcti_recenter.

Definition at line 300 of file BLI_bounds.hh.

resize()

template<typename T>

void blender::Bounds< T >::resize ( const T & new_size )

inline

Resize the bounds in-place to ensure their size is #new_size. The center of the bounds doesn't change. This matches the behavior of BLI_rctf_resize/BLI_rcti_resize.

Definition at line 294 of file BLI_bounds.hh.

scale_from_center()

template<typename T>

void blender::Bounds< T >::scale_from_center ( const T & scale )

inline

Scale the bounds from the center. This matches the behavior of BLI_rctf_scale/BLI_rcti_scale.

Definition at line 286 of file BLI_bounds.hh.

size()

template<typename T>

T blender::Bounds< T >::size ( ) const

inline

Return the size of the bounds. E.g. for a Bounds<float3> this would return the dimensions of bounding box as a float3. This matches the behavior of #BLI_rctf_size/#BLI_rcti_size.

Definition at line 275 of file BLI_bounds.hh.

Referenced by curvemap_zoom().

translate()

template<typename T>

void blender::Bounds< T >::translate ( const T & offset )

inline

Translate the bounds by #offset. This matches the behavior of BLI_rctf_translate/BLI_rcti_translate.

Definition at line 280 of file BLI_bounds.hh.

Member Data Documentation

max

template<typename T>

T blender::Bounds< T >::max

Definition at line 15 of file BLI_bounds_types.hh.

Referenced by curvemap_zoom().

min

template<typename T>

T blender::Bounds< T >::min

Definition at line 14 of file BLI_bounds_types.hh.

Referenced by curvemap_zoom().

---

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

• BLI_bounds_types.hh
• BLI_bounds.hh