UnitScaleData Class Reference

#include <customgui_unitscale.h>

Inheritance diagram for UnitScaleData:

Private Member Functions
	UnitScaleData ()
	~UnitScaleData ()

Alloc/Free
static UnitScaleData *	Alloc ()
static void	Free (UnitScaleData *&data)

Get/Set Unit/Scale
Bool	GetUnitScale (Float &scale, DOCUMENT_UNIT &unit) const
Bool	SetUnitScale (Float scale, DOCUMENT_UNIT unit)

Operators
Bool	operator== (const UnitScaleData &b) const
Bool	operator!= (const UnitScaleData &b) const

Additional Inherited Members
Static Public Member Functions inherited from iCustomDataType< UnitScaleData >
static UnitScaleData *	Alloc ()
static void	Free (UnitScaleData *&data)

Detailed Description

Unit scale data type (CUSTOMDATATYPE_UNITSCALE).

Example: Set the unit and scale of a document:

BaseDocument *doc = BaseDocument::Alloc();
 
UnitScaleData uscale = UnitScaleData::Alloc();
if (uscale==nullptr)
  return;
 
uscale->SetUnitScale(10.0, DOCUMENT_UNIT_MICRO);
 
GeData data;
data.SetCustomDataType(CUSTOMDATATYPE_UNITSCALE, *uscale);
doc->SetParameter(DOCUMENT_DOCUNIT, data);
 
UnitScaleData::Free(uscale)

Note

Has to be created with Alloc() and destroyed with Free().

Constructor & Destructor Documentation

UnitScaleData()

UnitScaleData ( )

private

~UnitScaleData()

~UnitScaleData ( )

private

Member Function Documentation

Alloc()

static UnitScaleData* Alloc ( )

static

Allocates a unit scale data. Destroy the allocated unit scale data with Free().

Returns

The allocated unit scale data, or nullptr if the allocation failed.

Free()

static void Free ( UnitScaleData *&  data )

static

Destructs unit scale data allocated with Alloc().

Parameters

[in,out]

data

The unit scale data to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

GetUnitScale()

Bool GetUnitScale	(	Float &	scale,
		DOCUMENT_UNIT &	unit
	)		const

Gets the values of the unit scale data.

Parameters

[out]	scale	Assigned the unit scale.
[out]	unit	Assigned the unit.

Returns

true if unit scale data values were successfully retrieved, otherwise false.

SetUnitScale()

Bool SetUnitScale	(	Float	scale,
		DOCUMENT_UNIT	unit
	)

Sets the values for the unit scale data.

Parameters

[in]	scale	The unit scale.
[in]	unit	The unit.

Returns

true if unit scale data values were successfully set, otherwise false.

operator==()

Bool operator==

(

const UnitScaleData &

b

)

const

Equality operator. Checks if two unit scale data are equal.

Parameters

[in]

b

A unit scale data.

Returns

true if the unit scale datas are equal, otherwise false.

operator!=()

Bool operator!=

(

const UnitScaleData &

b

)

const

Inequality operator. Checks if two unit scale data are different.

Parameters

[in]

b

A unit scale data.

Returns

true if the unit scale datas are different, otherwise false.