A utility class for fitting a set of objects whose sizes can vary between a minimum and maximum size, into a space. More...

#include <juce_StretchableObjectResizer.h>

Collaboration diagram for juce::StretchableObjectResizer:

[legend]

Classes
struct	Item

Public Member Functions
	StretchableObjectResizer ()
	Creates an empty object resizer. More...

	~StretchableObjectResizer ()
	Destructor. More...

void	addItem (double currentSize, double minSize, double maxSize, int order=0)
	Adds an item to the list. More...

double	getItemSize (int index) const noexcept
	Returns the size of one of the items. More...

int	getNumItems () const noexcept
	Returns the number of items that have been added. More...

void	resizeToFit (double targetSize)
	Resizes all the items to fit this amount of space. More...

Private Attributes
Array< Item >	items

Detailed Description

A utility class for fitting a set of objects whose sizes can vary between a minimum and maximum size, into a space.

This is a trickier algorithm than it would first seem, so I've put it in this class to allow it to be shared by various bits of code.

To use it, create one of these objects, call addItem() to add the list of items you need, then call resizeToFit(), which will change all their sizes. You can then retrieve the new sizes with getItemSize() and getNumItems().

It's currently used by the TableHeaderComponent for stretching out the table headings to fill the table's width.

@tags{GUI}

Constructor & Destructor Documentation

◆ StretchableObjectResizer()

juce::StretchableObjectResizer::StretchableObjectResizer ( )

Creates an empty object resizer.

◆ ~StretchableObjectResizer()

juce::StretchableObjectResizer::~StretchableObjectResizer ( )

Destructor.

Member Function Documentation

◆ addItem()

void juce::StretchableObjectResizer::addItem	(	double	currentSize,
		double	minSize,
		double	maxSize,
		int	order = `0`
	)

Adds an item to the list.

The order parameter lets you specify groups of items that are resized first when some space needs to be found. Those items with an order of 0 will be the first ones to be resized, and if that doesn't provide enough space to meet the requirements, the algorithm will then try resizing the items with an order of 1, then 2, and so on.

◆ getItemSize()

double juce::StretchableObjectResizer::getItemSize ( int index ) const

noexcept

Returns the size of one of the items.

◆ getNumItems()

int juce::StretchableObjectResizer::getNumItems ( ) const

inlinenoexcept

Returns the number of items that have been added.

References items.

◆ resizeToFit()

void juce::StretchableObjectResizer::resizeToFit ( double targetSize )

Resizes all the items to fit this amount of space.

This will attempt to fit them in without exceeding each item's minimum and maximum sizes. In cases where none of the items can be expanded or enlarged any further, the final size may be greater or less than the size passed in.

After calling this method, you can retrieve the new sizes with the getItemSize() method.

Member Data Documentation

◆ items

Array<Item> juce::StretchableObjectResizer::items

private

Referenced by getNumItems().

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

juce_StretchableObjectResizer.h

Classes

Public Member Functions

Private Attributes