Collapse All Expand All

LAnnotation::SetRotateOptions

#include "ltwrappr.h"

L_INT LAnnotation::SetRotateOptions(pRotateOptions, uFlags)

pANNROTATEOPTIONS pRotateOptions;	/* pointer to a structure */
L_UINT uFlags;	/* flags that indicate which objects to process */

Sets the rotation options for the annotation object.

Parameter	Description
pRotateOptions	Pointer to an ANNROTATEOPTIONS structure that specifies the rotate options to be set.
uFlags	Flags that indicate which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( | ). Possible values are:
	Value	Meaning
	0	Process only the specified object.
	ANNFLAG_SELECTED	[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnotation::IsSelected and LAnnotation::SetSelected functions.
	ANNFLAG_NOTTHIS	[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.
	ANNFLAG_RECURSE	[0x0008] Process objects within a container, and within any sub containers, down to any level.
	ANNFLAG_NOTCONTAINER	[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.
	ANNFLAG_NOINVALIDATE	[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

Returns

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

Comments

Use this function to set the rotate options of any annotation object, including the automation object. To use this function, declare a variable of type ANNROTATEOPTIONS, and pass the address of this variable for pRotateOptions. For more information, refer to the documentation for the structure ANNROTATEOPTIONS.

With the new rotate options, two rotate handles are displayed on a selected object. One of the handles is the "gripper" handle, which rotates the object when dragged. The other handle is the "center" handle, which determines the center of rotation. The center of rotation can be moved by dragging. The gripper handle can be moved anywhere by dragging.

The following figure illustrates a rotate by dragging the "gripper" handle:

The following figure illustrates moving the "center" handle:

The rotate handles can be reset to a default location by right-clicking the annotation object, and selecting the Reset Rotate Handles option, as shown in the following figure:

The rotate handles can be globally hidden or displayed by right-clicking on the image (not an annotation object), and selecting the Hide Rotate Handles For All Objects option, as shown in the following figure:

This functionality can be enabled using the following code snippet:

L_VOID ExampleEnableOption(LAnnAutomation& annAutomation)
{
   L_UINT nRet, uOptions = 0;
   nRet = annAutomation.GetOptions( &uOptions);
   nRet = annAutomation.SetOptions( uOptions | OPTIONS_NEW_ROTATE);
}

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.

See Also

Functions:	LAnnotation::GetRotateOptions, LAnnotation::SetOptions, LAnnContainer::HitTest, LAnnotation::IsSelected, LAnnotation::SetSelected, LAnnAutomation::SetAutoCursor
Topics:	Annotation Functions: Getting and Setting the Rotation Properties
	Altering Annotation Object Settings
	Key Annotation Features
	Flipping, Reversing and Rotating Annotation Objects

Example

For an example, refer to LAnnotation::GetRotateOptions.