LAnnotation::Flip

#include "ltwrappr.h"

virtual L_INT LAnnotation::Flip(pCenter, uFlags=0)

pANNPOINT pCenter;

/* pointer to a ANNPOINT structure */

L_UINT uFlags;

/* flags that determine which objects to process */

Flips the annotation object, top to bottom.

Parameter

Description

pCenter

Pointer to the ANNPOINT structure that specifies the center of rotation. Pass NULL in this parameter to use the default for each affected object. With the default, if a container is flipped, all objects in it are flipped as a unit, using the container's center as the axis. If an individual object is flipped, it is flipped on its own center.

 

The ANNPOINT structure is like a Windows POINT structure, except that it uses double-precision floating point values.

 

Coordinates of an object's points are relative to its container object. The coordinates are interpreted using the container's scaling factors and offsets, which are described in Low-Level Coordinate System for Annotations.

uFlags

Flags that determine 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 LAnnContainer::GetSelectItems 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 subcontainers, 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

This function applies to multiple and selected objects based on values of the uFlags parameter.

You cannot flip or reverse an object that contains text. If you flip or reverse an object that includes text, the text will move to the new position, but will retain its orientation.

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:

Class Members

Topics:

Annotation Functions: Doing Geometric Transformations

 

Flipping, Reversing and Rotating Annotation Objects

 

Displaying and Manipulating Annotation Objects

Example

For an example, refer to LAnnotation::CutToClipboard.