OdDmUtil Namespace Reference

Functions
int TOOLKIT_EXPORT	dimfit (int dimatfit, int dimtmove)
int TOOLKIT_EXPORT	dimunit (int dimlunit, int dimfrac)
int TOOLKIT_EXPORT	dimatfit (int dimfit)
int TOOLKIT_EXPORT	dimtmove (int dimfit)
int TOOLKIT_EXPORT	dimlunit (int dimunit)
int TOOLKIT_EXPORT	dimfrac (int dimunit)
OdString TOOLKIT_EXPORT	arrowName (OdDbObjectId blockId)
bool TOOLKIT_EXPORT	isBuiltInArrow (const OdString &arrowheadName)
bool TOOLKIT_EXPORT	isZeroLengthArrow (const OdString &arrowheadName)
OdDbObjectId TOOLKIT_EXPORT	findArrowId (const OdString &arrowheadName, const OdDbDatabase *pDb)
OdDbObjectId TOOLKIT_EXPORT	getArrowId (const OdString &arrowheadName, OdDbDatabase *pDb)

Detailed Description

This namespace contains utility functions for Dimension Style processing.

<group TD_Namespaces>

Function Documentation

arrowName()

OdString TOOLKIT_EXPORT OdDmUtil::arrowName

(

OdDbObjectId

blockId

)

Returns the local name of the specified dimension arrowhead.

Parameters

blockId

[in] Object ID of the dimension arrowhead.

dimatfit()

int TOOLKIT_EXPORT OdDmUtil::dimatfit

(

int

dimfit

)

Returns the R15 DIMATFIT value corresponding to the specified R14 DIMFIT value.

Parameters

dimfit

[in] DIMFIT value.

Remarks

The complete mapping is as follows:

dimatfit 0 0 1 1 2 2 3 3 4 3 5 3 other 3

dimfit()

int TOOLKIT_EXPORT OdDmUtil::dimfit	(	int	dimatfit,
		int	dimtmove
	)

Returns the R14 DIMFIT value corresponding to the specified DIMATFIT and DIMTMOVE values.

Parameters

dimatfit	[in] DIMATFIT value.
dimtmove	[in] DIMTMOVE value.

Remarks

The complete mapping is as follows:

DIMAFIT DIMFIT 0 0 0 0 1 1 0 2 2 0 3 3 1 0 4 1 1 4 1 2 4 1 3 4 2 0 5 2 1 5 2 2 5 2 3 5

All other input combinations return 3.

dimfrac()

int TOOLKIT_EXPORT OdDmUtil::dimfrac

(

int

dimunit

)

Returns the R15 DIMFRAC value corresponding to the specified R14 DUMUNIT value.

Parameters

dimunit

[in] DIMUNIT value.

Remarks

The complete mapping is as follows:

dimfrac 1 0 2 0 3 0 4 0 5 0 6 2 7 2 8 0 other 0

dimlunit()

int TOOLKIT_EXPORT OdDmUtil::dimlunit

(

int

dimunit

)

Returns the R15 DIMLUNIT value corresponding to the specified R14 DUMUNIT value.

Parameters

dimunit

[in] DIMUNIT value.

Remarks

The complete mapping is as follows:

dimlunit 1 1 2 2 3 3 4 4 5 5 6 4 7 5 8 6 other 2

dimtmove()

int TOOLKIT_EXPORT OdDmUtil::dimtmove

(

int

dimfit

)

Returns the R15 DIMTMOVE value corresponding to the specified R14 DIMFIT value.

Parameters

dimfit

[in] DIMFIT value.

Remarks

The complete mapping is as follows:

dimtmove 0 0 1 0 2 0 3 0 4 1 5 2 other 0

dimunit()

int TOOLKIT_EXPORT OdDmUtil::dimunit	(	int	dimlunit,
		int	dimfrac
	)

Returns the R14 DIMUNIT value corresponding to the specified DIMLUNIT and DIMFRAC values.

Parameters

dimlunit	[in] DIMLUNIT value.
dimfrac	[in] DIMFRAC value.

Remarks

The complete mapping is as follows:

DIMLUNIT DIMUNIT 0 1 1 0 2 2 0 3 3 0 4 4 0 5 5 0 6 8 1 1 1 1 2 2 1 3 3 1 4 4 1 5 5 1 6 8 2 1 1 2 2 2 2 3 3 2 4 6 2 5 7 2 6 8

All other input combinations return 2.

findArrowId()

OdDbObjectId TOOLKIT_EXPORT OdDmUtil::findArrowId	(	const OdString &	arrowheadName,
		const OdDbDatabase *	pDb
	)

Returns the Object ID of the arrowhead block with the specified arrowhead name.

Parameters

arrowheadName	[in] Arrowhead name.
pDb	[in] Database containing the arrowhead.

getArrowId()

OdDbObjectId TOOLKIT_EXPORT OdDmUtil::getArrowId	(	const OdString &	arrowheadName,
		OdDbDatabase *	pDb
	)

Returns the Object ID of the arrowhead block with the specified arrowhead name, creating this block if necessary.

Parameters

arrowheadName	[in] Arrowhead name.
pDb	[in] Database containing the arrowhead.

isBuiltInArrow()

bool TOOLKIT_EXPORT OdDmUtil::isBuiltInArrow

(

const OdString &

arrowheadName

)

Returns true if and only if the specified arrowhead name is that of a built-in arrowhead.

Parameters

arrowheadName

[in] Arrowhead name.

Remarks

The built-in arrowheads are as follows:

NAME UI STRING ArchTick "Architectural tick" BoxBlank "Box" BoxFilled "Box filled" Closed "Closed" ClosedBlank "Closed blank" DatumBlank "Datum triangle" DatumFilled "Datum triangle filled" Dot "Dot" DotBlank "Dot blank" DotSmall "Dot small" Integral "Integral" None "None" Oblique "Oblique" Open "Open" Open30 "Open 30" Open90 "Right angle" Origin "Origin indicator" Origin2 "Origin indicator 2" Small "Dot small blank"

isZeroLengthArrow()

bool TOOLKIT_EXPORT OdDmUtil::isZeroLengthArrow

(

const OdString &

arrowheadName

)

Returns true if and only if the specified arrowhead name is that of a built-in arrowhead that is treated as having zero length.

Parameters

arrowheadName

[in] Arrowhead name.

Remarks

The built-in zero-length arrowheads are as follows:

NAME ArchTick DotSmall Integral None Oblique Small