Dimension Arc Functions

MTK_Object_DimensionArc_GetAttributes

int MTK_Object_DimensionArc_GetAttributes(
			MTK_Object* obj,
			char* label, double* tickGap,
			double* tickOffset, double* tickExtentSize,
			double* arrowLength, double* arrowWidth
			);
		

Description

Get the attributes of a dimension arc object.

Parameters

obj

pointer to an MTK_Object struct

label

buffer of length MTK_BUFFER_SIZE to receive the label of the dimension arc (char*)

tickGap

the tick gap (double*)

tickOffset

the tick offset (double*)

tickExtentSize

the tick extent size (double*)

arrowLength

the length of the arrow head (double*)

arrowWidth

the width of the arrow head (double*)

Return Value

0

success

other

failure

MTK_Object_DimensionArc_GetOrigin

int MTK_Object_DimensionArc_GetOrigin(
			MTK_Object* obj,
			double* x, double* y, double* z
			);
		

Description

Get the origin location of a dimension arc object (the centre of the arc).

Parameters

obj

pointer to an MTK_Object struct

x

origin x value (double*)

y

origin y value (double*)

z

origin z value (double*)

Return Value

0

success

other

failure

MTK_Object_DimensionArc_GetRadius

int MTK_Object_DimensionArc_GetRadius(
			MTK_Object* obj,
			double* x, double* y, double* z
			);
		

Description

Get the radius location of a dimension arc object (the start of the arc).

Parameters

obj

pointer to an MTK_Object struct

x

radius x value (double*)

y

radius y value (double*)

z

radius z value (double*)

Return Value

0

success

other

failure

MTK_Object_DimensionArc_GetSweep

int MTK_Object_DimensionArc_GetSweep(
			MTK_Object* obj,
			double* x, double* y, double* z
			);
		

Description

Get the sweep location of a dimension arc object (the end of the arc).

Parameters

obj

pointer to an MTK_Object struct

x

sweep x value (double*)

y

sweep y value (double*)

z

sweep z value (double*)

Return Value

0

success

other

failure

MTK_Object_DimensionArc_GetTextAttributes

int MTK_Object_DimensionArc_GetTextAttributes(
			MTK_Object* obj,
			char* font, char* scale,
			double* height,
			MTK_Object_TextVertPos* textLocation
			);
		

Description

Get the attributes of the text on a dimension arc object.

Parameters

obj

pointer to an MTK_Object struct

font

buffer of length MTK_BUFFER_SIZE to receive the font of the text on the dimension arc (char*)

scale

buffer of length MTK_BUFFER_SIZE to receive the scale of the text on the dimension arc (char*)

height

the height of the text on the dimension arc (double*)

textLocation

the location of the text relative to the dimension arc (MTK_Object_TextVertPos*)

Return Value

0

success

other

failure

MTK_Object_DimensionArc_SetAttributes

int MTK_Object_DimensionArc_SetAttributes(
			MTK_Object* obj,
			const char* label, const double& tickGap,
			const double& tickOffset, const double& tickExtentSize,
			const double& arrowLength, const double& arrowWidth
			);
		

Description

Set the attributes of a dimension arc object.

Parameters

obj

pointer to an MTK_Object struct

label

the label of the dimension arc (const char*)

tickGap

the tick gap (double)

tickOffset

the tick offset (double)

tickExtentSize

the tick extent size (double)

arrowLength

the length of the arrow head (double)

arrowWidth

the width of the arrow head (double)

Return Value

0

success

other

failure

MTK_Object_DimensionArc_SetOrigin

int MTK_Object_DimensionArc_SetOrigin(
			MTK_Object* obj,
			const double& x,
			const double& y,
			const double& z
			);
		

Description

Set the origin location of a dimension arc object (the centre of the arc).

Parameters

obj

pointer to an MTK_Object struct

x

origin x value (double)

y

origin y value (double)

z

origin z value (double)

Return Value

0

success

other

failure

MTK_Object_DimensionArc_SetRadius

int MTK_Object_DimensionArc_SetRadius(
			MTK_Object* obj,
			const double& x,
			const double& y,
			const double& z
			);
		

Description

Set the radius location of a dimension arc object (the start of the arc).

Parameters

obj

pointer to an MTK_Object struct

x

radius x value (double)

y

radius y value (double)

z

radius z value (double)

Return Value

0

success

other

failure

MTK_Object_DimensionArc_SetSweep

int MTK_Object_DimensionArc_SetSweep(
			MTK_Object* obj,
			const double& x,
			const double& y,
			const double& z
			);
		

Description

Set the sweep location of a dimension arc object (the end of the arc).

Parameters

obj

pointer to an MTK_Object struct

x

sweep x value (double)

y

sweep y value (double)

z

sweep z value (double)

Return Value

0

success

other

failure

MTK_Object_DimensionArc_SetTextAttributes

int MTK_Object_DimensionArc_SetTextAttributes(
			MTK_Object* obj,
			const char* font, const char* scale,
			const double& height,
			const MTK_Object_TextVertPos& textLocation
			);
		

Description

Set the attributes of the text on a dimension arc object.

Parameters

obj

pointer to an MTK_Object struct

font

the font of the text on the dimension arc (const char*)

scale

the scale of the text on the dimension arc (const char*)

height

the height of the text on the dimension arc (double)

textLocation

the location of the text relative to the dimension arc (MTK_Object_TextVertPos)

Return Value

0

success

other

failure