Dimension Line Functions

MTK_Object_DimensionLine_GetAttributes

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

Description

Get the attributes of a dimension line object.

Parameters

obj

pointer to an MTK_Object struct

label

buffer of length MTK_BUFFER_SIZE to receive the label of the dimension line (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_DimensionLine_GetEnd

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

Description

Get the end location of a dimension line object.

Parameters

obj

pointer to an MTK_Object struct

x

end x value (double*)

y

end y value (double*)

z

end z value (double*)

Return Value

0

success

other

failure

MTK_Object_DimensionLine_GetNormal

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

Description

Get the normal of a dimension line object.

Parameters

obj

pointer to an MTK_Object struct

x

normal x value (double*)

y

normal y value (double*)

z

normal z value (double*)

Return Value

0

success

other

failure

MTK_Object_DimensionLine_GetStart

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

Description

Get the start location of a dimension line object.

Parameters

obj

pointer to an MTK_Object struct

x

start x value (double*)

y

start y value (double*)

z

start z value (double*)

Return Value

0

success

other

failure

MTK_Object_DimensionLine_GetTextAttributes

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

Description

Get the attributes of the text on a dimension line 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 line (char*)

scale

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

height

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

textLocation

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

Return Value

0

success

other

failure

MTK_Object_DimensionLine_SetAttributes

int MTK_Object_DimensionLine_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 line object.

Parameters

obj

pointer to an MTK_Object struct

label

the label of the dimension line (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_DimensionLine_SetEnd

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

Description

Set the end location of a dimension line object.

Parameters

obj

pointer to an MTK_Object struct

x

end x value (double)

y

end y value (double)

z

end z value (double)

Return Value

0

success

other

failure

MTK_Object_DimensionLine_SetNormal

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

Description

Set the normal of a dimension line object.

Parameters

obj

pointer to an MTK_Object struct

x

normal x value (double)

y

normal y value (double)

z

normal z value (double)

Return Value

0

success

other

failure

MTK_Object_DimensionLine_SetStart

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

Description

Set the start location of a dimension line object.

Parameters

obj

pointer to an MTK_Object struct

x

start x value (double)

y

start y value (double)

z

start z value (double)

Return Value

0

success

other

failure

MTK_Object_DimensionLine_SetTextAttributes

int MTK_Object_DimensionLine_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 line object.

Parameters

obj

pointer to an MTK_Object struct

font

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

scale

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

height

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

textLocation

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

Return Value

0

success

other

failure