inviwo::plot Namespace Reference

Classes
class	Axis2DProcessorHelper
class	Axis3DProcessorHelper
class	AxisData
class	AxisProperty
class	AxisRenderer
	Renderer for 2D axes in screen coordinates. The side to the right of the line from start to end position of the axis is defined as the "outside". As an example, consider the x axis at the bottom of a 2D plot, the outside is below the axis while the inside lies within the plot area. Mirroring the axis exchanges "outside" and "inside", that is labels and ticks will appear on the opposing side of the axis. More...
class	AxisRenderer3D
	Renderer for arbitrary axes in world coordinates. More...
class	AxisRendererBase
	Renders an axis based on AxisSettings. More...
class	AxisRenderProcessor
	Test processor for axis rendering. More...
class	AxisSettings
class	AxisStyleProperty
	A convenience property for updating/overriding multiple axes properties. A property change will propagate to all the subproperties of the registered axes. More...
class	BoxSelectionInteractionHandler
	Handles interaction for 2D rectangle selection/filtering Selection/Filtering callbacks are called when filtering changes. More...
class	BoxSelectionProperty
	Settings for rectangle selection/filtering. More...
class	BoxSelectionRenderer
	Renders a 2D rectangle in screen space. Use in combination with BoxSelectionInteractionHandler. More...
class	BoxSelectionSettingsInterface
class	CategoricalAxisProperty
	Axis for variables with a fixed number of possible values, e.g., categories. Will set the AxisProperty::range to match the number of categories and make it read-only. minorTicks will be made invisible. More...
class	ColorScaleLegend
class	DataFrameColumnToColorVector
class	ImagePlotProcessor
	plot an image with an x and y axis Event handling based on ViewManager More...
class	LayerAxis
class	MajorTickData
class	MajorTickProperty
class	MajorTickSettings
class	MeshAxis
class	MinorTickData
class	MinorTickProperty
class	MinorTickSettings
class	ParallelCoordinates
class	PCPAxisSettings
class	PCPCaptionSettings
class	PCPLabelSettings
class	PCPMajorTickSettings
class	PCPMinorTickSettings
class	PersistenceDiagramPlotGL
	base class for plotting a persistence diagram using OpenGL More...
class	PersistenceDiagramPlotProcessor
	plots a persistence diagram of extremum-saddle pairs with vertical lines More...
class	PlotTextData
class	PlotTextProperty
class	PlotTextSettings
class	ScatterPlotGL
class	ScatterPlotMatrixProcessor
class	ScatterPlotProcessor
class	VolumeAxis
	Processor for rendering axis annotations next to a volume. More...

Enumerations
enum class	TickStyle { None , Inside , Outside , Both }
enum class	LabelPlacement { Outside , Inside }

Functions
IVW_MODULE_PLOTTING_API bool	operator== (const AxisSettings &a, const AxisSettings &b)
IVW_MODULE_PLOTTING_API bool	operator!= (const AxisSettings &a, const AxisSettings &b)
IVW_MODULE_PLOTTING_API bool	operator== (const BoxSelectionSettingsInterface &a, const BoxSelectionSettingsInterface &b)
IVW_MODULE_PLOTTING_API bool	operator!= (const BoxSelectionSettingsInterface &a, const BoxSelectionSettingsInterface &b)
IVW_MODULE_PLOTTING_API bool	operator== (const MajorTickSettings &a, const MajorTickSettings &b)
IVW_MODULE_PLOTTING_API bool	operator!= (const MajorTickSettings &a, const MajorTickSettings &b)
IVW_MODULE_PLOTTING_API TickStyle	flip (TickStyle s)
IVW_MODULE_PLOTTING_API bool	operator== (const MinorTickSettings &a, const MinorTickSettings &b)
IVW_MODULE_PLOTTING_API bool	operator!= (const MinorTickSettings &a, const MinorTickSettings &b)
IVW_MODULE_PLOTTING_API bool	operator== (const PlotTextSettings &a, const PlotTextSettings &b)
IVW_MODULE_PLOTTING_API bool	operator!= (const PlotTextSettings &a, const PlotTextSettings &b)
IVW_MODULE_PLOTTING_API LabelPlacement	flip (LabelPlacement p)
IVW_MODULE_PLOTTING_API std::vector< double >	getMajorTickPositions (const MajorTickSettings &ticks, dvec2 range, size_t maxTicks=1000)
IVW_MODULE_PLOTTING_API std::vector< double >	getMinorTickPositions (const MinorTickSettings &minorTicks, const MajorTickSettings &majorTicks, dvec2 range, size_t maxTicks=1000)
std::vector< double >	getMajorTickPositions (const AxisSettings &settings, size_t maxTicks=1000)
	returns tick positions along the axis range defined in the axis property
std::vector< double >	getMinorTickPositions (const AxisSettings &settings, size_t maxTicks=1000)
vec2 IVW_MODULE_PLOTTING_API	getAxisCaptionPosition (const AxisSettings &settings, const vec2 &startPos, const vec2 &endPos)
IVW_MODULE_PLOTTING_API std::vector< std::pair< double, vec2 > >	getLabelPositions (const AxisSettings &property, const vec2 &startPos, const vec2 &endPos)
vec3 IVW_MODULE_PLOTTING_API	getAxisCaptionPosition3D (const AxisSettings &settings, const vec3 &startPos, const vec3 &endPos, const vec3 &tickDirection)
IVW_MODULE_PLOTTING_API std::vector< std::pair< double, vec3 > >	getLabelPositions3D (const AxisSettings &property, const vec3 &startPos, const vec3 &endPos, const vec3 &tickDirection)
IVW_MODULE_PLOTTING_API std::unique_ptr< Mesh >	generateMajorTicksMesh (const AxisSettings &settings, const vec2 &startPos, const vec2 &endPos)
	creates a mesh containing major ticks for an axis extending from start to end position
IVW_MODULE_PLOTTING_API std::unique_ptr< Mesh >	generateMinorTicksMesh (const AxisSettings &settings, const vec2 &startPos, const vec2 &endPos)
IVW_MODULE_PLOTTING_API std::unique_ptr< Mesh >	generateAxisMesh (const vec2 &startPos, const vec2 &endPos, const vec4 &color, const size_t &pickingId=std::numeric_limits< size_t >::max())
IVW_MODULE_PLOTTING_API std::unique_ptr< Mesh >	generateMajorTicksMesh3D (const AxisSettings &settings, const vec3 &startPos, const vec3 &endPos, const vec3 &tickDirection)
IVW_MODULE_PLOTTING_API std::unique_ptr< Mesh >	generateMinorTicksMesh3D (const AxisSettings &settings, const vec3 &startPos, const vec3 &endPos, const vec3 &tickDirection)
IVW_MODULE_PLOTTING_API std::unique_ptr< Mesh >	generateAxisMesh3D (const vec3 &startPos, const vec3 &endPos, const vec4 &color, const size_t &pickingId=std::numeric_limits< size_t >::max())
IVW_MODULE_PLOTTING_API std::unique_ptr< Mesh >	generateTicksMesh (const std::vector< double > &tickMarks, dvec2 axisRange, const vec3 &startPos, const vec3 &endPos, const vec3 &tickDirection, float tickLength, TickStyle style, const vec4 &color, bool flip)
	utility function to create a mesh for a given set of tick mark positions
IVW_MODULE_PLOTTING_API std::pair< vec2, vec2 >	tickBoundingRect (const AxisSettings &settings, const vec2 &startPos, const vec2 &endPos)

Detailed Description

plot

Function Documentation

flip() [1/2]

IVW_MODULE_PLOTTING_API LabelPlacement inviwo::plot::flip

(

LabelPlacement

p

)

flip inside and outside direction of placement p

flip() [2/2]

IVW_MODULE_PLOTTING_API TickStyle inviwo::plot::flip

(

TickStyle

s

)

flip inside and outside direction of tick style s

generateAxisMesh()

IVW_MODULE_PLOTTING_API std::unique_ptr< Mesh > inviwo::plot::generateAxisMesh	(	const vec2 &	startPos,
		const vec2 &	endPos,
		const vec4 &	color,
		const size_t &	pickingId = std::numeric_limits< size_t >::max() )

No picking buffer will be generated if pickingId = std::numeric_limits<size_t>::max()

generateAxisMesh3D()

IVW_MODULE_PLOTTING_API std::unique_ptr< Mesh > inviwo::plot::generateAxisMesh3D	(	const vec3 &	startPos,
		const vec3 &	endPos,
		const vec4 &	color,
		const size_t &	pickingId = std::numeric_limits< size_t >::max() )

No picking buffer will be generated id pickingId = std::numeric_limits<size_t>::max()

generateMajorTicksMesh()

IVW_MODULE_PLOTTING_API std::unique_ptr< Mesh > inviwo::plot::generateMajorTicksMesh	(	const AxisSettings &	settings,
		const vec2 &	startPos,
		const vec2 &	endPos )

creates a mesh containing major ticks for an axis extending from start to end position

Parameters

settings	axis property used for tick settings
startPos	start position of axis
endPos	end position of axis

Returns

mesh containing of ticks, each tick is represented by two positions and matching colors

generateTicksMesh()

IVW_MODULE_PLOTTING_API std::unique_ptr< Mesh > inviwo::plot::generateTicksMesh	(	const std::vector< double > &	tickMarks,
		dvec2	axisRange,
		const vec3 &	startPos,
		const vec3 &	endPos,
		const vec3 &	tickDirection,
		float	tickLength,
		TickStyle	style,
		const vec4 &	color,
		bool	flip )

utility function to create a mesh for a given set of tick mark positions

Parameters

tickMarks	positions of tick marks in same coordinate system as the axis range
axisRange	min/max values of the axis
startPos	start position of axis (spatial coordinates)
endPos	end position of axis (spatial coordinates)
tickDirection	direction of ticks pointing outwards (spatial coordinates)
tickLength	length of the ticks
style	tick style (none, inside, outside, both)
color	tick color
flip	if true, the orientation of ticks is flipped (only affects inside/outside ticks). This is, e.g., used for axis at the top (default tick outside location is bottom/left)

Returns

mesh containing of ticks, each tick is represented by two positions and matching colors

getMajorTickPositions()

std::vector< double > inviwo::plot::getMajorTickPositions ( const AxisSettings & settings, size_t maxTicks = 1000 )

inline

returns tick positions along the axis range defined in the axis property

Parameters

settings	axis property used for tick settings
maxTicks	maximum number of ticks

Returns

positions of tick marks