#include <DT_Plugin.h>

Inheritance diagram for DT_ParmDefInteger:

Public Member Functions
DT_ParmDefInteger *	setLabelNames (const UT_StringArray &labels)

const UT_StringArray &	labelNames () const

void	copyValue (const int *src, DT_Value &dst) const

void	copyValue (const DT_Value &src, int *dst) const

bool	operator== (const DT_ParmDef &other) const override


DT_ParmDefInteger *	setVectorSize (int32 size)

int32	vectorSize () const


DT_ParmDefInteger *	setRange (int32 min, int32 max)

void	getRange (int32 &min, int32 &max) const


DT_ParmDefInteger *	setRangeLock (bool min, bool max)

void	getRangeLock (bool &min, bool &max) const

Public Member Functions inherited from DT_ParmDef
virtual	~DT_ParmDef ()

int	id () const

Type	type () const

const char *	typeName () const

DT_ParmDef *	setName (const UT_StringHolder &name)
	Set a name for this parameter definition. More...

const UT_StringHolder &	name () const
	Returns the name of the parameter definition. More...

DT_ParmDef *	setIcon (const UT_StringHolder &icon)
	Show an icon, instead of a headet text / label. More...

const UT_StringHolder &	icon () const

DT_ParmDef *	setTooltip (const UT_StringHolder &str)

const UT_StringHolder &	tooltip () const

DT_ParmDef *	setReadOnly ()

bool	readOnly () const

DT_ParmDef *	setOptionType (OptionType opt_type)

OptionType	optionType () const

DT_ParmDef *	setToolbarName (const UT_StringHolder &toolbar_name)

const UT_StringHolder &	toolbarName () const

DT_ParmDef *	setCanBeIndeterminate ()
	The parameter can be in an indeterminate state. Ignored for options. More...

bool	canBeIndeterminate () const

virtual bool	allowsMultiValueSet () const

Static Public Member Functions
static DT_ParmDefInteger *	create (int id, const UT_StringHolder &name)

static const DT_ParmDefInteger &	get (const DT_ParmDef &def)
	Automatically cast the base class definition to this type. More...

Static Public Member Functions inherited from DT_ParmDef
static DT_ParmDef *	createFromTemplate (int id, const PRM_Template &tpl)

static bool	getMenuItemsFromTemplate (const PRM_Template &tpl, PRM_Parm &parm, DT_MenuItemList &items)

Additional Inherited Members
Public Types inherited from DT_ParmDef
enum	Type { T_TOGGLE, T_INTEGER, T_FLOAT, T_COLOR, T_STRING, T_MENU, T_PATH, T_BUTTON, T_GROUPED }

enum	OptionType { OT_OPTION_ONLY, OT_OPTION_AND_TOOLBAR, OT_TOOLBAR_ONLY }

Protected Member Functions inherited from DT_ParmDef
	DT_ParmDef (int id, const UT_StringHolder &name, Type parm_type)

Protected Member Functions inherited from UT_NonCopyableNS::UT_NonCopyable
	UT_NonCopyable ()=default

	~UT_NonCopyable ()=default

	UT_NonCopyable (const UT_NonCopyable &)=delete

UT_NonCopyable &	operator= (const UT_NonCopyable &)=delete

Protected Attributes inherited from DT_ParmDef
int	myId

UT_StringHolder	myName

UT_StringHolder	myIcon

Type	myType

UT_StringHolder	myTooltip

OptionType	myOptionType

UT_StringHolder	myToolbarName

bool	myReadOnly

bool	myCanBeIndeterminate

Detailed Description

Defines an integer vector parameter, represented by an input field. The integer vector can range from a single entry, to four.

When used with DT_Plugin::setParameterValue, DT_Plugin::getParameterValue, DT_Plugin::setOptionValue, and DT_Plugin::getOptionValue, the value argument type is according to the following table:

Definition at line 350 of file DT_Plugin.h.

Member Function Documentation

void DT_ParmDefInteger::copyValue	(	const int *	src,
		DT_Value &	dst
	)		const

Copy a value from a concrete type to an opaque DT_Value object. The number of entries passed should match the return value of vectorSize().

void DT_ParmDefInteger::copyValue	(	const DT_Value &	src,
		int *	dst
	)		const

Copy a value from DT_Value opaque type to a concrete type. The number of entries in the dst storage should match the return value of vectorSize().

static DT_ParmDefInteger* DT_ParmDefInteger::create	(	int	id,
		const UT_StringHolder &	name
	)

static

Create a new integer vector parameter definition with a given id and a name.

static const DT_ParmDefInteger& DT_ParmDefInteger::get ( const DT_ParmDef & def )

inlinestatic

Automatically cast the base class definition to this type.

Definition at line 361 of file DT_Plugin.h.

void DT_ParmDefInteger::getRange	(	int32 &	min,
		int32 &	max
	)		const

Set get the allowed range for all entries of the integer vector. The min/max values are inclusive.

void DT_ParmDefInteger::getRangeLock	(	bool &	min,
		bool &	max
	)		const

Specify whether the range should be locked at either, or both, ends. A locked range will clamp on the locked side.

const UT_StringArray& DT_ParmDefInteger::labelNames ( ) const

Return the list of label names for the vector components. If no labels were added, returns the empty array.

bool DT_ParmDefInteger::operator== ( const DT_ParmDef & other ) const

overridevirtual

Implements DT_ParmDef.

DT_ParmDefInteger* DT_ParmDefInteger::setLabelNames ( const UT_StringArray & labels )

Set display label names for each vector component (e.g. "X"/"Y"/"Z" or "U"/"V"). The size of the label array should equal to the size of the vector size of the parameter. Therefore, it's important to call setVectorSize prior to this call.

DT_ParmDefInteger* DT_ParmDefInteger::setRange	(	int32	min,
		int32	max
	)

Set get the allowed range for all entries of the integer vector. The min/max values are inclusive.

DT_ParmDefInteger* DT_ParmDefInteger::setRangeLock	(	bool	min,
		bool	max
	)

Specify whether the range should be locked at either, or both, ends. A locked range will clamp on the locked side.

DT_ParmDefInteger* DT_ParmDefInteger::setVectorSize ( int32 size )

Set/get the vector size of the integer. Valid values are 1-4. Invalid values are clamped.

int32 DT_ParmDefInteger::vectorSize ( ) const

Set/get the vector size of the integer. Valid values are 1-4. Invalid values are clamped.

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

DTUI/DT_Plugin.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation