Arrow Functions

MTK_Object_Arrow_GetAttributes

int MTK_Object_Arrow_GetAttributes(
			MTK_Object* obj,
			int* autoscale, int* filled, int* numfacets,
			MTK_Object_ArrowType* arrowtype
			);
		

Description

Get the attributes of an arrow object.

Parameters

obj

pointer to an MTK_Object struct

autoscale

whether or not the arrow autoscales (int*)

filled

whether or not the arrow is filled  (int*)

numfacets

the number of facets in the arrow   (int*)

arrowtype

the type of the arrow (MTK_Object_ArrowType*) (see below)

Return Value

0

success

other

failure

enum MTK_Object_ArrowType
{
   ARROW_2D,
   ARROW_3D,
   ARROW_FAN
};

MTK_Object_Arrow_GetEnd

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

Description

Get the end location of an arrow 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_Arrow_GetHeadInfo

int MTK_Object_Arrow_GetHeadInfo(
			MTK_Object* obj,
			double* length, double* width
			);
		

Description

Get the length/width of the head of an arrow object.

Parameters

obj

pointer to an MTK_Object struct

length

head length value (double*)

width

head width value  (double*)

Return Value

0

success

other

failure

MTK_Object_Arrow_GetNormal

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

Description

Get the normal of an arrow 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_Arrow_GetRelativeHeadInfo

int MTK_Object_Arrow_GetRelativeHeadInfo(
			MTK_Object* obj,
			double* length, double* width
			);
		

Description

Get the relative length/width of the head of an arrow object.

Parameters

obj

pointer to an MTK_Object struct

length

relative head length value (double*)

width

relative head width value  (double*)

Return Value

0

success

other

failure

MTK_Object_Arrow_GetScaledHeadInfo

int MTK_Object_Arrow_GetScaledHeadInfo(
			MTK_Object* obj,
			double* length, double* width
			);
		

Description

Get the scaled length/width of the head of an arrow object.

Parameters

obj

pointer to an MTK_Object struct

length

scaled head length value (double*)

width

scaled head width value  (double*)

Return Value

0

success

other

failure

MTK_Object_Arrow_GetStart

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

Description

Get the start location of an arrow 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_Arrow_SetAttributes

int MTK_Object_Arrow_SetAttributes(
			MTK_Object* obj, const int& autoscale,
			const int& filled, const int& numfacets,
			const MTK_Object_ArrowType& arrowtype
			);
		

Description

Set the attributes of an arrow object.

Parameters

obj

pointer to an MTK_Object struct

autoscale

whether or not the arrow autoscales (int)

filled

whether or not the arrow is filled (int)

numfacets

the number of facets in the arrow (int)

arrowtype

the type of the arrow (MTK_Object_ArrowType)

Return Value

0

success

other

failure

MTK_Object_Arrow_SetEnd

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

Description

Set the end location of an arrow 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_Arrow_SetHeadInfo

int MTK_Object_Arrow_SetHeadInfo(
			MTK_Object* obj,
			const double& length, const double& width
			);
		

Description

Set the length/width of the head of an arrow object.

Parameters

obj

pointer to an MTK_Object struct

length

head length value (double)

width

head width value  (double)

Return Value

0

success

other

failure

MTK_Object_Arrow_SetNormal

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

Description

Set the normal of an arrow 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_Arrow_SetRelativeHeadInfo

int MTK_Object_Arrow_SetRelativeHeadInfo(
			MTK_Object* obj,
			const double& length,
			const double& width
			);
		

Description

Set the relative length/width of the head of an arrow object.

Parameters

obj

pointer to an MTK_Object struct

length

relative head length value (double)

width

relative head width value  (double)

Return Value

0

success

other

failure

MTK_Object_Arrow_SetStart

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

Description

Set the start location of an arrow 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