3Depict: RegionGroup Class Reference

#include <plot.h>

Collaboration diagram for RegionGroup:

Collaboration graph

[legend]

Public Member Functions
	RegionGroup ()

void	clear ()

void	addRegion (unsigned int regionId, const std::string &name, float start, float end, float r, float g, float b, Filter *parentFilter)
	Append a region to the plot. More...

bool	getRegionIdAtPosition (float x, float y, unsigned int &id) const
	Retrieve the ID of the non-overlapping region in X-Y space. More...

void	getRegion (unsigned int id, PlotRegion &r) const
	Retrieve a region using its ID. More...

size_t	getNumRegions () const
	Get the number of regions;. More...

void	moveRegion (unsigned int regionId, unsigned int method, bool selfUpdate, float newX, float newY)
	Pass the region movement information to the parent filter object. More...

void	findRegionLimit (unsigned int regionId, unsigned int movementType, float &maxX, float &maxY) const
	Obtain limit of motion for a given region movement type. More...

void	getOverlaps (std::vector< std::pair< size_t, size_t > > &ids, std::vector< std::pair< float, float > > &coords) const

Public Attributes
std::vector< PlotRegion >	regions
	Interactive, or otherwise marked plot regions. More...

Constructor & Destructor Documentation

◆ RegionGroup()

RegionGroup::RegionGroup ( )

inline

Member Function Documentation

◆ addRegion()

void RegionGroup::addRegion	(	unsigned int	regionId,
		const std::string &	name,
		float	start,
		float	end,
		float	r,
		float	g,
		float	b,
		Filter *	parentFilter
	)

Append a region to the plot.

References PlotRegion::ACCESS_MODE_FILTER, ASSERT, PlotRegion::b, PlotRegion::bounds, PlotRegion::g, PlotRegion::id, PlotRegion::label, and PlotRegion::r.

Referenced by VisController::updateScene().

Here is the caller graph for this function:

◆ clear()

void RegionGroup::clear ( )

inline

References PlotRegion::b, PlotRegion::g, and PlotRegion::r.

◆ findRegionLimit()

void RegionGroup::findRegionLimit	(	unsigned int	regionId,
		unsigned int	movementType,
		float &	maxX,
		float &	maxY
	)		const

Obtain limit of motion for a given region movement type.

References ASSERT, REGION_MOVE_EXTEND_XMINUS, REGION_MOVE_EXTEND_XPLUS, and REGION_MOVE_TRANSLATE_X.

◆ getNumRegions()

size_t RegionGroup::getNumRegions ( ) const

inline

Get the number of regions;.

◆ getOverlaps()

void RegionGroup::getOverlaps	(	std::vector< std::pair< size_t, size_t > > &	ids,
		std::vector< std::pair< float, float > > &	coords
	)		const

References rangesOverlap().

Referenced by PlotWrapper::getRegionOverlaps().

Here is the caller graph for this function:

◆ getRegion()

void RegionGroup::getRegion	(	unsigned int	id,
		PlotRegion &	r
	)		const

Retrieve a region using its ID.

◆ getRegionIdAtPosition()

bool RegionGroup::getRegionIdAtPosition	(	float	x,
		float	y,
		unsigned int &	id
	)		const

Retrieve the ID of the non-overlapping region in X-Y space.

◆ moveRegion()

void RegionGroup::moveRegion	(	unsigned int	regionId,
		unsigned int	method,
		bool	selfUpdate,
		float	newX,
		float	newY
	)

Pass the region movement information to the parent filter object.

Member Data Documentation

◆ regions

std::vector<PlotRegion> RegionGroup::regions

Interactive, or otherwise marked plot regions.

Referenced by PlotWrapper::getRegions(), RangeEditorDialog::setPlotWrapper(), and PlotWrapper::switchOutRegionParent().

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