SE_shape_clip

Returns the intersection (logical AND of space) of a shape and a supplied rectangular envelope.

Usage syntax

LONG SE_shape_clip (SE_SHAPE src_shape, SE_ENVELOPE *window, SE_SHAPE tgt_shape);

Parameters
src_shape A handle to an active shape object to clip to the supplied envelope
window A pointer to an ENVELOPE structure that defines the clipping window
tgt_shape A handle to an active shape object, returned as the new shape
Description

Returns the intersection (logical AND of space) of a shape and a supplied rectangular envelope, returning the resulting intersection as tgt_shape. The resulting clipped shape has the same dimension as the source shape, or it may be a nil shape if the source shape does not intersect the clipping window.

Returns

SE_SUCCESS
SE_COORD_OUT_OF_BOUNDS

SE_FAILURE

SE_INVALID_ENTITY_TYPE

SE_INVALID_ENVELOPE

SE_INVALID_POINTER

SE_INVALID_SHAPE

SE_INVALID_SHAPE_OBJECT

SE_OUT_OF_CLMEM

SE_READ_ONLY_SHAPE

SE_SHAPE_INTEGRITY_ERROR

Notes

•  If you pass a shape returned from SE_stable_search or SE_stable_get_shape to ‘tgt_shape’, the SE_READ_ONLY_SHAPE error is returned. See ‘Shape table functions’ for more information.

•  Ignores any CAD data in the source shape, and removes any CAD data in the target shape.