Description

Describes properties of a 3D vector, consisting of three double values.

By using this class, the underlying data scheme is hidden from the user of the data. This e.g. eases SessionItem migration. The underlying implementation can be a R3 vector, a member array of three doubles, three double members, or any other construction to hold the three values.

VectorProperty DoubleDescriptor

Definition at line 31 of file VectorDescriptor.h.

Collaboration diagram for VectorDescriptor:

[legend]

Public Member Functions
	VectorDescriptor ()=default

	VectorDescriptor (const QString &label, const QString &tooltip, const variant< QString, Unit > &unit)

	VectorDescriptor (const QString &label, const QString &tooltip, double xVar, double yVar, double *zVar, const variant< QString, Unit > &unit)

void	init (const QString &_label, const QString &_tooltip, const R3 *vec, const variant< QString, Unit > &_unit)

Public Attributes
QString	label
	A label text (short, no trailing colon) More...

QString	tooltip
	Tooltip text. More...

function< QString()>	uid
	unique id describing this value. Used e.g. for undo/redo More...

DoubleDescriptor	x

DoubleDescriptor	y

DoubleDescriptor	z

Constructor & Destructor Documentation

◆ VectorDescriptor() [1/3]

VectorDescriptor::VectorDescriptor ( )

default

◆ VectorDescriptor() [2/3]

VectorDescriptor::VectorDescriptor	(	const QString &	label,
		const QString &	tooltip,
		double *	xVar,
		double *	yVar,
		double *	zVar,
		const variant< QString, Unit > &	unit
	)

inline

Definition at line 35 of file VectorDescriptor.h.

         : label(label)
         , tooltip(tooltip)
         , x("X", xVar, unit)
         , y("Y", yVar, unit)
         , z("Z", zVar, unit)
     {
         x.limits = RealLimits::limitless();
         y.limits = RealLimits::limitless();
         z.limits = RealLimits::limitless();
         x.decimals = 3;
         y.decimals = 3;
         z.decimals = 3;
         x.tooltip = tooltip;
         y.tooltip = tooltip;
         z.tooltip = tooltip;
     }

References DoubleDescriptor::decimals, DoubleDescriptor::limits, DoubleDescriptor::tooltip, tooltip, x, y, and z.

◆ VectorDescriptor() [3/3]

VectorDescriptor::VectorDescriptor	(	const QString &	label,
		const QString &	tooltip,
		const variant< QString, Unit > &	unit
	)

inline

Definition at line 54 of file VectorDescriptor.h.

         : label(label)
         , tooltip(tooltip)
     {
         x.limits = RealLimits::limitless();
         y.limits = RealLimits::limitless();
         z.limits = RealLimits::limitless();
         x.decimals = 3;
         y.decimals = 3;
         z.decimals = 3;
         x.tooltip = tooltip;
         y.tooltip = tooltip;
         z.tooltip = tooltip;
         x.unit = unit;
         y.unit = unit;
         z.unit = unit;
         x.label = "x";
         y.label = "y";
         z.label = "z";
     }

References DoubleDescriptor::decimals, DoubleDescriptor::label, DoubleDescriptor::limits, DoubleDescriptor::tooltip, tooltip, DoubleDescriptor::unit, x, y, and z.

Member Function Documentation

◆ init()

void VectorDescriptor::init	(	const QString &	_label,
		const QString &	_tooltip,
		const R3 *	vec,
		const variant< QString, Unit > &	_unit
	)

inline

Definition at line 76 of file VectorDescriptor.h.

     {
         label = _label;
         tooltip = _tooltip;
         x.limits = RealLimits::limitless();
         y.limits = RealLimits::limitless();
         z.limits = RealLimits::limitless();
         x.decimals = 3;
         y.decimals = 3;
         z.decimals = 3;
         x.tooltip = tooltip;
         y.tooltip = tooltip;
         z.tooltip = tooltip;
         x.unit = _unit;
         y.unit = _unit;
         z.unit = _unit;
         x.label = "x";
         y.label = "y";
         z.label = "z";
         x.set = [=](double v) { const_cast<R3*>(vec)->setX(v); };
         x.get = [=]() { return vec->x(); };
         x.path = [=] { return uid() + "x"; };
         y.set = [=](double v) { const_cast<R3*>(vec)->setY(v); };
         y.get = [=]() { return vec->y(); };
         y.path = [=] { return uid() + "y"; };
         z.set = [=](double v) { const_cast<R3*>(vec)->setZ(v); };
         z.get = [=]() { return vec->z(); };
         z.path = [=] { return uid() + "z"; };
     }