LAnnotation::Define

#include "ltwrappr.h"

virtual L_INT LAnnotation::Define(pPoint, uState)

LPPOINT pPoint;	/* pointer to a POINT structure */
L_UINT uState;	/* state of the process */

Specifies the shape when creating or transforming an annotation object. This function specifies one point in the current window each time it is called.

Parameter	Description
pPoint	Pointer to a POINT structure. The points in the array must be in the order in which the vertices are connected. To define the line that closes a polygon, the last point in the array is connected to the first point of the array. To define a rectangle, the last point is the opposite vertex of the first point.
uState	State of the process of modifying the annotation object. Possible values are:
	Value	Meaning
	ANNDEFINE_BEGINSET	[0] This is the first point to define a new object.
	ANNDEFINE_BEGINMOVE	[1] This is the point from which to move the object.
	ANNDEFINE_BEGINROTATE	[2] This is the starting point for calculating the angle of rotation.
	ANNDEFINE_BEGINRESIZE	[3] This is the starting point for calculating the how to resize the object.
	ANNDEFINE_BEGINSELECT	[4] This is the first corner of the rectangle used to select objects.
	ANNDEFINE_APPEND	[5] This is the next point when defining an object that requires more than two points.
	ANNDEFINE_UPDATE	[6] This is the current mouse position during creation of the object. Use this on a mouse move event to reflect the current shape of the object.
	ANNDEFINE_END	[7] This is the last point.
	ANNDEFINE_BEGINMOVESELECTED	[8] This is the point from which to move all selected objects.
	ANNDEFINE_BEGINROTATESELECTED	[9] This is the starting point for calculating the angle of rotation for all selected objects.
	ANNDEFINE_BEGINRESIZESELECTED	[10] This is the starting point for calculating the how to resize all selected objects.
	ANNDEFINE_BEGINMOVENAME	[12] This is the starting point from which to move the object name.
	ANNDEFINE_SETANCHORPOINT	[13] This is an anchor point. Use this value when rotating an annotation object around a point other than its center. When doing this, call LAnnotation::Define with this flag prior to calling LAnnotation::Define with the ANNDEFINE_BEGINROTATE flag.
	ANNDEFINE_BEGINMOVEPOINT	[11] This is a starting point, used when moving one point on an annotation object
	The behavior depends on the annotation object being manipulated.
	This can be used to move a single point on any of the following annotation objects:
	ANNOBJECT_LINE
	ANNOBJECT_POLYLINE
	ANNOBJECT_POLYGON
	ANNOBJECT_POINTER
	ANNOBJECT_FREEHAND
	ANNOBJECT_FREEHANDHOTSPOT
	ANNOBJECT_RULER
	ANNOBJECT_CROSSPRODUCT
	ANNOBJECT_PROTRACTOR
	ANNOBJECT_CURVE
	ANNOBJECT_CURVECLOSED
	You can use ANNDEFINE_BEGINMOVEPOINT to perform a simultaneous rotate and resize for the following objects: When doing this, call LAnnotation::Define with the ANNDEFINE_SETANCHORPOINT flag prior to calling LAnnotation::Define with the ANNDEFINE_BEGINMOVEPOINT flag.
	(Note that you must set an anchor point prior to using ANNDEFINE_BEGINMOVEPOINT)
	ANNOBJECT_RECT
	ANNOBJECT_ELLIPSE
	ANNOBJECT_HILITE
	ANNOBJECT_REDACT
	ANNOBJECT_TEXT
	ANNOBJECT_NOTE
	ANNOBJECT_STAMP
	ANNOBJECT_HOTSPOT

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Before calling this function, you must create the object, and the object must have a window handle (which can be inherited from the container).

To specify the shape of an object that is defined by a polygon, you call this function repeatedly to create an array of points, which must be in the order in which the vertices are connected. To define the line that closes a polygon, the last point in the array is connected to the first point of the array.

You can also call this function on mouse move events during the definition of an object to update the current view of the object being defined. Thus, this function can handle the display of the object during and after its creation.

When rotating or resizing an object, you call this function for the first point and last point, and this function determines the angle of rotation or resize parameters based on the difference in the points.

When rotating an annotation object around a point other than its center, call LAnnotation::Define with the ANNDEFINE_SETANCHORPOINT flag set, prior to calling LAnnotation::Define with the ANNDEFINE_BEGINROTATE flag set. For example, to rotate an object around the point (10,20) in client coordinates, do the following:

(Assume that pMousePos->pt is the current mouse location in client coordinates)

POINT ptLocation;
ptLocation.x = 10;
ptLocation.y = 20;
pLAnnotationObject->Define( &ptLocation, ANNDEFINE_SETANCHORPOINT);
pLAnnotationObject->Define(&pMousePos->pt, ANNDEFINE_BEGINROTATE);

// One or more ANNDEFINE_APPEND
pLAnnotationObject->Define(&pMousePos->pt, ANNDEFINE_APPEND);

pLAnnotationObject->Define(&pMousePos->pt, ANNDEFINE_END);

Required DLLs and Libraries

LTANN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

Functions:	Class Members, LAnnotation::AdjustPoint, LAnnContainer::Convert, LAnnotation::Define2, LAnnotation::GetRestrictToContainer, LAnnEncrypt::GetRotateAngle, LAnnContainer::HitTest, LAnnContainer::RestrictCursor, LAnnotation::SetRestrictToContainer, LAnnContainer::Convert, LAnnContainer::RestrictCursor, LAnnotation::GetRestrictToContainer, LAnnotation::SetRestrictToContainer, LAnnotation::Define2
Topics:	Annotation Functions: Creating and Deleting Annotations
	Implementing Annotations
	Types of Annotations
	Annotation Functions: Implementing Custom Annotations
	Displaying and Manipulating Annotation Objects